IBM DB2 Information Integrator
Java API Reference
for Developing Wrappers

com.ibm.db2.wrapper
Class NicknameInfo

java.lang.Object
  extended bycom.ibm.db2.wrapper.CatalogInfo
      extended bycom.ibm.db2.wrapper.NicknameInfo

public final class NicknameInfo
extends CatalogInfo

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.

Since:
IBM DB2 Information Integrator Version 8.2

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

NicknameInfo

public NicknameInfo()
Construct a default (empty) nickname information object.

Since:
IBM DB2 Information Integrator Version 8.2
Method Detail

addOption

public void addOption(java.lang.String optionName,
                      java.lang.String optionValue,
                      int action)
               throws WrapperException
Add an option to the options chain.

Parameters:
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.
Throws:
WrapperException - if the option already exists in the chain or if the action is invalid.
Since:
IBM DB2 Information Integrator Version 8.2

getCard

public long getCard()
Retrieve the cardinality value.

Returns:
The cardinality value.
Since:
IBM DB2 Information Integrator Version 8.2

getColumn

public ColumnInfo getColumn(java.lang.String name)
Retrieve the column with the specified name.

Parameters:
name - The name of the column to be retrieved.
Returns:
The column descriptor.
Since:
IBM DB2 Information Integrator Version 8.2
See Also:
ColumnInfo

getColumnWithRemoteColumnName

public ColumnInfo getColumnWithRemoteColumnName(java.lang.String remoteColumnName)
                                         throws WrapperException
Retrieve the column with the specified remote column name.

Parameters:
remoteColumnName - The remote name of the column to be retrieved.
Returns:
The column descriptor.
Throws:
WrapperException - if the method fails
Since:
IBM DB2 Information Integrator Version 8.2
See Also:
ColumnInfo

getFirstColumn

public ColumnInfo getFirstColumn()
Retrieve the first column information object.

Returns:
The first column information object.
Since:
IBM DB2 Information Integrator Version 8.2
See Also:
ColumnInfo

getFPages

public long getFPages()
Retrieve the fpages statistics for the nickname.

Returns:
The fpages statistics value.
Since:
IBM DB2 Information Integrator Version 8.2

getNextColumn

public ColumnInfo getNextColumn(ColumnInfo currentColumn)
Retrieve the next column information object.

Parameters:
currentColumn - The current column information object.
Returns:
The next column information object.
Since:
IBM DB2 Information Integrator Version 8.2
See Also:
ColumnInfo

getNickname

public java.lang.String getNickname()
Retrieve the name of the nickname.

Returns:
The name.
Since:
IBM DB2 Information Integrator Version 8.2

getNPages

public long getNPages()
Retrieve the npages statistics for the nickname.

Returns:
The npages statistics value.
Since:
IBM DB2 Information Integrator Version 8.2

getNumColumns

public int getNumColumns()
Retrieve the number of columns.

Returns:
The number of columns.
Since:
IBM DB2 Information Integrator Version 8.2

getOverflow

public long getOverflow()
Retrieve the overflow statistics for the nickname.

Returns:
The overflow statistics value.
Since:
IBM DB2 Information Integrator Version 8.2

getSchema

public java.lang.String getSchema()
Retrieve the local schema name of the nickname.

Returns:
The local schema name.
Since:
IBM DB2 Information Integrator Version 8.2

getServerName

public java.lang.String getServerName()
Retrieve the server name of the nickname.

Returns:
The server name.
Since:
IBM DB2 Information Integrator Version 8.2

insertColumn

public void insertColumn(ColumnInfo newColumn)
                  throws WrapperException
Insert a column information object at the position given by its column ID field.

Parameters:
newColumn - The column information object to be inserted.
Throws:
WrapperException - if the ColumnInfo object is null.
Since:
IBM DB2 Information Integrator Version 8.2
See Also:
ColumnInfo

isCachingAllowed

public boolean isCachingAllowed()
Returns true if it is allowed to use the Nickname in local caches like MQTs

Returns:
true or false
Since:
IBM DB2 Information Integrator Version 9.1

isCachingAllowedValid

public boolean isCachingAllowedValid()
Verify whether isCachingAllowed is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 9.1

isCardValid

public boolean isCardValid()
Verify whether a cardinality value is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

isFPagesValid

public boolean isFPagesValid()
Verify whether the fpages statistics is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

isNicknameValid

public boolean isNicknameValid()
Verify whether the name of the nickname is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

isNPagesValid

public boolean isNPagesValid()
Verify whether the npages statistics is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

isOverflowValid

public boolean isOverflowValid()
Verify whether an overflow statistics is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

isSchemaValid

public boolean isSchemaValid()
Verify whether a schema name is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

isServerNameValid

public boolean isServerNameValid()
Verify whether a server name is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

setCachingAllowed

public 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

Parameters:
isCachingAllowed - true or false
Since:
IBM DB2 Information Integrator Version 9.1

setCard

public void setCard(long card)
Set the cardinality value.

Parameters:
card - The cardinality value.
Since:
IBM DB2 Information Integrator Version 8.2

setFPages

public void setFPages(long fPages)
Set the fpages statistics for the nickname.

Parameters:
fPages - The fpages statistics value.
Since:
IBM DB2 Information Integrator Version 8.2

setNickname

public void setNickname(java.lang.String nickname)
Set the name of the nickname.

Parameters:
nickname - The nickname name.
Since:
IBM DB2 Information Integrator Version 8.2

setNPages

public void setNPages(long nPages)
Set the npages statistics for the nickname.

Parameters:
nPages - The npages statistics value.
Since:
IBM DB2 Information Integrator Version 8.2

setOverflow

public void setOverflow(long overflow)
Set the overflow statistics for the nickname.

Parameters:
overflow - The overflow statistics value.
Since:
IBM DB2 Information Integrator Version 8.2

setSchema

public void setSchema(java.lang.String schema)
Set the local schema name of the nickname.

Parameters:
schema - The local schema name.
Since:
IBM DB2 Information Integrator Version 8.2

setServerName

public void setServerName(java.lang.String serverName)
Set the server name of the nickname.

Parameters:
serverName - The server name.
Since:
IBM DB2 Information Integrator Version 8.2

IBM DB2 Information Integrator
Java API Reference
for Developing Wrappers

(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.