|
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.WrapperInfo
The WrapperInfo class encapsulates the catalog information for a wrapper object from the CREATE WRAPPER and ALTER WRAPPER statements.
The WrapperInfo class is one of the catalog classes for the Java API.
Usage:
The WrapperInfo class is instantiated by the DB2 federated server to contain
information from a CREATE WRAPPER or an ALTER WRAPPER 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 WRAPPER or ALTER WRAPPER statement operations.
Constructor Summary | |
WrapperInfo()
Construct a new default (empty) wrapper information object. |
Method Summary | |
void |
addOption(java.lang.String optionName,
java.lang.String optionValue,
int action)
Add an option to the options chain. |
java.lang.String |
getCorelib()
Retrieve the core library name. |
char |
getType()
Retrieve the wrapper type. |
int |
getVersion()
Retrieve the wrapper version. |
java.lang.String |
getWrapperName()
Retrieve the wrapper name. |
boolean |
isCorelibValid()
Verify whether a core library is specified. |
boolean |
isNameValid()
Verify whether a name is specified. |
boolean |
isTypeValid()
Verify whether a type is specified. |
boolean |
isVersionValid()
Verify whether a version is specified. |
void |
setType(char type)
Set the wrapper type. |
void |
setVersion(int version)
Set the wrapper version. |
void |
setWrapperName(java.lang.String name)
Set the wrapper name. |
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 WrapperInfo()
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 java.lang.String getCorelib()
public char getType()
public int getVersion()
public java.lang.String getWrapperName()
public boolean isCorelibValid()
public boolean isNameValid()
public boolean isTypeValid()
public boolean isVersionValid()
public void setType(char type)
type
- The type.public void setVersion(int version)
version
- The version.public void setWrapperName(java.lang.String name)
name
- The wrapper 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.