IBM DB2 Information Integrator
Java API Reference
for Developing Wrappers

com.ibm.db2.wrapper
Class CatalogInfo

java.lang.Object
  extended bycom.ibm.db2.wrapper.CatalogInfo
Direct Known Subclasses:
ColumnInfo, NicknameInfo, RemoteFunctionInfo, RFuncParmInfo, ServerInfo, UserInfo, WrapperInfo

public class CatalogInfo
extends java.lang.Object

CatalogInfo represents the base class for all the catalog classes and provides the infrastructure to manage a list of options.

This class is a collection style class that stores a sequential list of options that can be accessed either by their sequences or by their option names. This class uses the current option and the methods that relate to the option.

The CatalogInfo class is one of the catalog classes for the Java API.

Since:
IBM DB2 Information Integrator Version 8.2

Method Summary
 void addOption(java.lang.String optionName, java.lang.String optionValue, int action, java.lang.String optionType, java.lang.String objectName)
          Add an option to the options chain.
 void dropOption(CatalogOption option)
          Delete an option from the options chain.
 CatalogOption getFirstOption()
          Retrieve the first option from the chain.
 CatalogOption getNextOption(CatalogOption currentOption)
          Retrieve the next option from the chain.
 CatalogOption getOption(java.lang.String optionName)
          Retrieve the option object for the specified option name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

addOption

public void addOption(java.lang.String optionName,
                      java.lang.String optionValue,
                      int action,
                      java.lang.String optionType,
                      java.lang.String objectName)
               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.
optionType - The type of the object that owns the option. This parameter value is a token that is used in the SQL1884 error message to identify the option type if this is a duplicate option.
objectName - The name of the object that owns the option. This parameter value is a token that is used in the SQL1884 error message to identify the owner object name if this is a duplicate option.
Throws:
WrapperException - if the option already exists in the chain or if the action is invalid.
Since:
IBM DB2 Information Integrator Version 8.2

dropOption

public void dropOption(CatalogOption option)
                throws WrapperException
Delete an option from the options chain.

Parameters:
option - The option to be deleted.
Throws:
WrapperException - if the option object is null.
Since:
IBM DB2 Information Integrator Version 8.2
See Also:
CatalogOption

getFirstOption

public final CatalogOption getFirstOption()
Retrieve the first option from the chain.

Returns:
A CatalogOption instance that represents the first option or null if no options are specified.
Since:
IBM DB2 Information Integrator Version 8.2
See Also:
CatalogOption

getNextOption

public final CatalogOption getNextOption(CatalogOption currentOption)
Retrieve the next option from the chain.

Parameters:
currentOption - The current option in the chain.
Returns:
A CatalogOption instance that represents the next option or null if there are no more options.
Since:
IBM DB2 Information Integrator Version 8.2
See Also:
CatalogOption

getOption

public final CatalogOption getOption(java.lang.String optionName)
                              throws WrapperException
Retrieve the option object for the specified option name.

Parameters:
optionName - The name of the option.
Returns:
A CatalogOption instance that represents the searched option or null if no option is found.
Throws:
WrapperException - if the option name is null.
Since:
IBM DB2 Information Integrator Version 8.2
See Also:
CatalogOption

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.