Skip navigation links

Oracle© Data Integrator Data Services Java API Reference
11g Release 1 (11.1.1.7.0)

E17062-04


oracle.odi.dataservices.fwk
Class ColumnsMeta

java.lang.Object
  extended by oracle.odi.dataservices.fwk.ColumnsMeta


public class ColumnsMeta
extends java.lang.Object

This class provides metadata about the columns of the managed entity to which it is attached.


Constructor Summary
ColumnsMeta()
          Constructs a new ColumnsMeta object with no columns.
ColumnsMeta(java.lang.String[] pColsName, int[] pJdbcTypes, boolean[] pNullables, java.lang.String[] pDescriptions, java.lang.String[] pPKColumns)
          Constructs a new ColumnsMeta object with a set of columns.

 

Method Summary
 void addColumnMeta(java.lang.String pColumnName, int pJdbcType, boolean pNullable, boolean pPartOfPK, java.lang.String pColumnDescription)
          Appends a description to the column metadata.
 java.util.List getColumnsName()
          Returns the list of column names.
 java.lang.String getDescription(java.lang.String pColumnName)
          Returns the description of a column specified by name Column name must be defined.
 int getJDBCType(java.lang.String pColumnName)
          Returns the JDBC type of a column, specified by name.
 java.util.List getNotNullableColumnsName()
          Returns the list of names of columns that are NOT nullable.
 java.util.List getNotPKColumnsName()
          Returns the list of names of columns that are NOT part of the primary key.
 java.util.List getNullableColumnsName()
          Returns the list of names of columns that are nullable.
 java.util.List getPKColumnsName()
          Returns the list of names of columns that are part of the primary key.
 boolean isNullable(java.lang.String pColumnName)
          Returns true if a column, specified by name, is nullable.
 boolean isPartOfPK(java.lang.String pColumnName)
          Returns true if a column, specified by name, is part of the primary key.

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

ColumnsMeta

public ColumnsMeta()
Constructs a new ColumnsMeta object with no columns.

ColumnsMeta

public ColumnsMeta(java.lang.String[] pColsName,
                   int[] pJdbcTypes,
                   boolean[] pNullables,
                   java.lang.String[] pDescriptions,
                   java.lang.String[] pPKColumns)
Constructs a new ColumnsMeta object with a set of columns. The set of columns is created from several arrays containing the main column properties, in the same order as the columns: The first column's name should be first in the array of column names, and its type first in the array of JDBC types, and so on.
Parameters:
pColsName - array of column names
pJdbcTypes - array of JDBC types
pNullables - array of Booleans indicating if the columns are nullable
pDescriptions - array of column descriptions. These descriptions are used to generate the WDSL
pPKColumns - array of column names that are part of the primary key

Method Detail

addColumnMeta

public void addColumnMeta(java.lang.String pColumnName,
                          int pJdbcType,
                          boolean pNullable,
                          boolean pPartOfPK,
                          java.lang.String pColumnDescription)
Appends a description to the column metadata.
Parameters:
pColumnName - column name
pJdbcType - column JDBC Type.
pNullable - is the column nullable?
pPartOfPK - is the column part of the primary key?
pColumnDescription - column description

getColumnsName

public java.util.List getColumnsName()
Returns the list of column names.
Returns:
List of strings containing the column names

getPKColumnsName

public java.util.List getPKColumnsName()
Returns the list of names of columns that are part of the primary key.
Returns:
List of strings containing the column names

getNotPKColumnsName

public java.util.List getNotPKColumnsName()
Returns the list of names of columns that are NOT part of the primary key.
Returns:
List of strings containing the column names

getNullableColumnsName

public java.util.List getNullableColumnsName()
Returns the list of names of columns that are nullable.
Returns:
List of strings containing the column names

getNotNullableColumnsName

public java.util.List getNotNullableColumnsName()
Returns the list of names of columns that are NOT nullable.
Returns:
List of strings containing the column names

getJDBCType

public int getJDBCType(java.lang.String pColumnName)
Returns the JDBC type of a column, specified by name. Column name must be defined.
Parameters:
pColumnName - column name
Returns:
The column's JDBC type

isNullable

public boolean isNullable(java.lang.String pColumnName)
Returns true if a column, specified by name, is nullable.
Parameters:
pColumnName - column name
Returns:
true if the column is nullable, false otherwise

isPartOfPK

public boolean isPartOfPK(java.lang.String pColumnName)
Returns true if a column, specified by name, is part of the primary key.
Parameters:
pColumnName - column name
Returns:
true if the column is part of primary key, false otherwise

getDescription

public java.lang.String getDescription(java.lang.String pColumnName)
Returns the description of a column specified by name Column name must be defined.
Parameters:
pColumnName - column name
Returns:
String containing the column description

Skip navigation links

Oracle© Data Integrator Data Services Java API Reference
11g Release 1 (11.1.1.7.0)

E17062-04


Copyright © 2010, 2013, Oracle and/or its affiliates. All rights reserved.