|
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.NicknameInfo
The NicknameInfo class encapsulates the catalog information for a nickname object including column definitions from the CREATE NICKNAME and ALTER NICKNAME statements.
The NicknameInfo class is one of the catalog classes for the Java API.
Usage:
This 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 | |
NicknameInfo()
Construct a default (empty) nickname information object. |
Method Summary | |
void |
addOption(java.lang.String optionName,
java.lang.String optionValue,
int action)
Add an option to the options chain. |
long |
getCard()
Retrieve the cardinality value. |
ColumnInfo |
getColumn(java.lang.String name)
Retrieve the column with the specified name. |
ColumnInfo |
getColumnWithRemoteColumnName(java.lang.String remoteColumnName)
Retrieve the column with the specified remote column name. |
ColumnInfo |
getFirstColumn()
Retrieve the first column information object. |
long |
getFPages()
Retrieve the fpages statistics for the nickname. |
ColumnInfo |
getNextColumn(ColumnInfo currentColumn)
Retrieve the next column information object. |
java.lang.String |
getNickname()
Retrieve the name of the nickname. |
long |
getNPages()
Retrieve the npages statistics for the nickname. |
int |
getNumColumns()
Retrieve the number of columns. |
long |
getOverflow()
Retrieve the overflow statistics for the nickname. |
java.lang.String |
getSchema()
Retrieve the local schema name of the nickname. |
java.lang.String |
getServerName()
Retrieve the server name of the nickname. |
void |
insertColumn(ColumnInfo newColumn)
Insert a column information object at the position given by its column ID field. |
boolean |
isCachingAllowed()
Returns true if it is allowed to use the Nickname in local caches like MQTs |
boolean |
isCachingAllowedValid()
Verify whether isCachingAllowed is specified. |
boolean |
isCardValid()
Verify whether a cardinality value is specified. |
boolean |
isFPagesValid()
Verify whether the fpages statistics is specified. |
boolean |
isNicknameValid()
Verify whether the name of the nickname is specified. |
boolean |
isNPagesValid()
Verify whether the npages statistics is specified. |
boolean |
isOverflowValid()
Verify whether an overflow statistics is specified. |
boolean |
isSchemaValid()
Verify whether a schema name is specified. |
boolean |
isServerNameValid()
Verify whether a server name is specified. |
void |
setCachingAllowed(boolean isCachingAllowed)
Set the isCachingAllowed flag for the nickname determining if it is allowed to use the Nickname in local caches like MQTs |
void |
setCard(long card)
Set the cardinality value. |
void |
setFPages(long fPages)
Set the fpages statistics for the nickname. |
void |
setNickname(java.lang.String nickname)
Set the name of the nickname. |
void |
setNPages(long nPages)
Set the npages statistics for the nickname. |
void |
setOverflow(long overflow)
Set the overflow statistics for the nickname. |
void |
setSchema(java.lang.String schema)
Set the local schema name of the nickname. |
void |
setServerName(java.lang.String serverName)
Set the server name of the nickname. |
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 NicknameInfo()
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 long getCard()
public ColumnInfo getColumn(java.lang.String name)
name
- The name of the column to be retrieved.
ColumnInfo
public ColumnInfo getColumnWithRemoteColumnName(java.lang.String remoteColumnName) throws WrapperException
remoteColumnName
- The remote name of the column to be retrieved.
WrapperException
- if the method failsColumnInfo
public ColumnInfo getFirstColumn()
ColumnInfo
public long getFPages()
public ColumnInfo getNextColumn(ColumnInfo currentColumn)
currentColumn
- The current column information object.
ColumnInfo
public java.lang.String getNickname()
public long getNPages()
public int getNumColumns()
public long getOverflow()
public java.lang.String getSchema()
public java.lang.String getServerName()
public void insertColumn(ColumnInfo newColumn) throws WrapperException
newColumn
- The column information object to be inserted.
WrapperException
- if the ColumnInfo object is null.ColumnInfo
public boolean isCachingAllowed()
public boolean isCachingAllowedValid()
public boolean isCardValid()
public boolean isFPagesValid()
public boolean isNicknameValid()
public boolean isNPagesValid()
public boolean isOverflowValid()
public boolean isSchemaValid()
public boolean isServerNameValid()
public void setCachingAllowed(boolean isCachingAllowed)
isCachingAllowed
- true or falsepublic void setCard(long card)
card
- The cardinality value.public void setFPages(long fPages)
fPages
- The fpages statistics value.public void setNickname(java.lang.String nickname)
nickname
- The nickname name.public void setNPages(long nPages)
nPages
- The npages statistics value.public void setOverflow(long overflow)
overflow
- The overflow statistics value.public void setSchema(java.lang.String schema)
schema
- The local schema name.public void setServerName(java.lang.String serverName)
serverName
- The server name.
|
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.