IBM DB2 Information Integrator
Java API Reference
for Developing Wrappers

com.ibm.db2.wrapper
Class WrapperInfo

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

public final class WrapperInfo
extends CatalogInfo

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.

Since:
IBM DB2 Information Integrator Version 8.2

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

WrapperInfo

public WrapperInfo()
Construct a new default (empty) wrapper 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

getCorelib

public java.lang.String getCorelib()
Retrieve the core library name.

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

getType

public char getType()
Retrieve the wrapper type.

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

getVersion

public int getVersion()
Retrieve the wrapper version.

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

getWrapperName

public java.lang.String getWrapperName()
Retrieve the wrapper name.

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

isCorelibValid

public boolean isCorelibValid()
Verify whether a core library is specified.

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

isNameValid

public boolean isNameValid()
Verify whether a name is specified.

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

isTypeValid

public boolean isTypeValid()
Verify whether a type is specified.

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

isVersionValid

public boolean isVersionValid()
Verify whether a version is specified.

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

setType

public void setType(char type)
Set the wrapper type.

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

setVersion

public void setVersion(int version)
Set the wrapper version.

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

setWrapperName

public void setWrapperName(java.lang.String name)
Set the wrapper name.

Parameters:
name - The wrapper 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.