|
IBM DB2 Information Integrator Java API Reference for Developing Wrappers |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.db2.wrapper.CatalogInfo
com.ibm.db2.wrapper.ColumnInfo
The ColumnInfo class encapsulates catalog information for a column of a nickname. This class includes column-statistical information.
The ColumnInfo class is one of the catalog classes for the Java API.
Usage:
The ColumnInfo class is instantiated by the DB2 federated server to contain
information from a CREATE NICKNAME or an ALTER NICKNAME statement
or to contain information from the federated server's system catalog.
This class is instantiated by the wrapper when information is added
during CREATE NICKNAME or ALTER NICKNAME statement operations.
Constructor Summary | |
ColumnInfo()
Construct a default (empty) column information object. |
Method Summary | |
void |
addOption(java.lang.String optionName,
java.lang.String optionValue,
int action)
Add an option to the options chain. |
int |
getAvgLength()
Retrieve the average length of the column. |
short |
getCodepage1()
Retrieve the single-byte character set (SBCS) code page for the column. |
short |
getCodepage2()
Retrieve the double-byte character set (DBCS) code page for the column. |
long |
getColCard()
Retrieve the cardinality of the column. |
short |
getColumnID()
Retrieve the column ID. |
java.lang.String |
getColumnName()
Retrieve the name of the column. |
java.lang.String |
getColumnType()
Retrieve the type of the column. |
java.lang.String |
getDefault()
Retrieve the default value for the column. |
boolean |
getForBitData()
Retrieve the FOR BIT DATA flag for the column. |
java.lang.String |
getHigh2Key()
Retrieve the second-highest value for the column. |
java.lang.String |
getLow2Key()
Retrieve the second-lowest value for the column. |
java.lang.String |
getNewColumnName()
Retrieve the new column name that is specified in an ALTER COLUMN statement that includes an ALTER (or SET) COLUMN clause to rename the column. |
ColumnInfo |
getNextColumn()
Retrieve the next column in the columns chain. |
boolean |
getNulls()
Retrieve the nulls-allowed flag. |
int |
getOrgLength()
Retrieve the maximum length (in bytes) for the column. |
short |
getOrgScale()
Retrieve the numeric scale of the column. |
java.lang.String |
getTypeName()
Retrieve the name of the local column type. |
java.lang.String |
getTypeSchema()
Retrieve the schema of the local column type. |
boolean |
isAvgLengthValid()
Verify whether an average length is specified for the column. |
boolean |
isCodepage1Valid()
Verify whether a single-byte character set (SBCS) code page is specified for the column. |
boolean |
isCodepage2Valid()
Verify whether a double-byte character set (DBCS) code page is specified for the column. |
boolean |
isColCardValid()
Verify whether a cardinality value is specified for the column. |
boolean |
isColumnIDValid()
Verify whether a column ID (position) is specified for the column. |
boolean |
isColumnNameValid()
Verify whether a name is specified for the column. |
boolean |
isColumnTypeValid()
Verify whether a local type is specified for the column. |
boolean |
isDefaultValid()
Verify whether a default value is specified for the column. |
boolean |
isForBitDataValid()
Verify whether a FOR BIT DATA flag is specified for the column. |
boolean |
isHigh2KeyValid()
Verify whether a second-highest value is specified for the column. |
boolean |
isLow2KeyValid()
Verify whether a second-lowest value is specified for the column. |
boolean |
isNewColumnNameValid()
Verify whether a new name is specified for the column. |
boolean |
isNullsValid()
Verify whether a nulls-allowed flag is specified for the column. |
boolean |
isOrgLengthValid()
Verify whether an original length is specified for the column. |
boolean |
isOrgScaleValid()
Verify whether an original scale is specified for the column. |
boolean |
isTypeNameValid()
Verify whether a local type name is specified for the column. |
boolean |
isTypeSchemaValid()
Verify whether a local type schema is specified for the column. |
void |
setAvgLength(int avgLength)
Set the average length of the column. |
void |
setCodepage1(short codepage1)
Set the single-byte character set (SBCS) code page for the column. |
void |
setCodepage2(short codepage2)
Set the double-byte character set (DBCS) code page for the column. |
void |
setColCard(long colCard)
Set the cardinality of the column. |
void |
setColumnID(short columnID)
Set the column ID, which represents the position of he column. |
void |
setColumnName(java.lang.String columnName)
Set the name of the column. |
void |
setColumnType(java.lang.String columnType)
Set the type of the column. |
void |
setDefault(java.lang.String defaultValue)
Set the default value for the column. |
void |
setForBitData(boolean forBitData)
Set the FOR BIT DATA flag for the column. |
void |
setHigh2Key(java.lang.String high2Key)
Set the second-highest value for the column. |
void |
setLow2Key(java.lang.String low2Key)
Set the second-lowest value for the column. |
void |
setNewColumnName(java.lang.String newColumnName)
Set the new name for the column. |
void |
setNulls(boolean nulls)
Set the nulls-allowed flag. |
void |
setOrgLength(int orgLength)
Set the maximum length (in bytes) for the column. |
void |
setOrgScale(short orgScale)
Set the numeric scale of the column. |
void |
setTypeName(java.lang.String typeName)
Set the name of the local column type. |
void |
setTypeSchema(java.lang.String typeSchema)
Set the schema of the local column type. |
Methods inherited from class com.ibm.db2.wrapper.CatalogInfo |
addOption, dropOption, getFirstOption, getNextOption, getOption |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ColumnInfo()
Method Detail |
public void addOption(java.lang.String optionName, java.lang.String optionValue, int action) throws WrapperException
optionName
- The name of the option.optionValue
- The value of the option.action
- The action flag for the option.
Valid actions for the options are specified in CatalogOption
class.
WrapperException
- if the option already exists in the chain or if the action is invalid.public int getAvgLength()
public short getCodepage1()
public short getCodepage2()
public long getColCard()
public short getColumnID()
public java.lang.String getColumnName()
public java.lang.String getColumnType()
public java.lang.String getDefault()
public boolean getForBitData()
public java.lang.String getHigh2Key()
public java.lang.String getLow2Key()
public java.lang.String getNewColumnName()
public ColumnInfo getNextColumn()
public boolean getNulls()
public int getOrgLength()
public short getOrgScale()
public java.lang.String getTypeName()
public java.lang.String getTypeSchema()
public boolean isAvgLengthValid()
public boolean isCodepage1Valid()
public boolean isCodepage2Valid()
public boolean isColCardValid()
public boolean isColumnIDValid()
public boolean isColumnNameValid()
public boolean isColumnTypeValid()
public boolean isDefaultValid()
public boolean isForBitDataValid()
public boolean isHigh2KeyValid()
public boolean isLow2KeyValid()
public boolean isNewColumnNameValid()
public boolean isNullsValid()
public boolean isOrgLengthValid()
public boolean isOrgScaleValid()
public boolean isTypeNameValid()
public boolean isTypeSchemaValid()
public void setAvgLength(int avgLength)
avgLength
- The length to be set.public void setCodepage1(short codepage1)
codepage1
- The single-byte character set (SBCS) code page.public void setCodepage2(short codepage2)
codepage2
- The double-byte character set (DBCS) code page.public void setColCard(long colCard)
colCard
- The column cardinality.public void setColumnID(short columnID)
columnID
- The ID (position) of the column.public void setColumnName(java.lang.String columnName)
columnName
- The name to be set.public void setColumnType(java.lang.String columnType)
columnType
- The column type.public void setDefault(java.lang.String defaultValue)
defaultValue
- The default value.public void setForBitData(boolean forBitData)
forBitData
- The FOR BIT DATA flag.public void setHigh2Key(java.lang.String high2Key)
high2Key
- The high2Key value.public void setLow2Key(java.lang.String low2Key)
low2Key
- The low2Key value.public void setNewColumnName(java.lang.String newColumnName)
newColumnName
- The new column name to be set.public void setNulls(boolean nulls)
nulls
- True to allow null values. False to disallow null values.public void setOrgLength(int orgLength)
orgLength
- The length to be set.public void setOrgScale(short orgScale)
orgScale
- The scale to be set.public void setTypeName(java.lang.String typeName)
typeName
- The local type name of the column.public void setTypeSchema(java.lang.String typeSchema)
typeSchema
- The local type schema name of the column.
|
IBM DB2 Information Integrator Java API Reference for Developing Wrappers |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
(C)Copyright IBM Corp. 2002. All rights reserved.
Links on this page are made available for your convenience and may take you to non-IBM sites. IBM does not warrant any sample code provided on these sites.