|
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.SqlqgBaseClass
com.ibm.db2.wrapper.Nickname
The Nickname class models collections of data that a data source server manages. Each instance of this class or its subclasses represents a collection of data that is managed by the data source server that the wrapper works with. The Nickname base class implementation maintains the following information:
NicknameInfo
object that contains information pertaining to
this nickname that was stored in the federated server's system catalog
after executing the CREATE NICKNAME or ALTER NICKNAME statement.
The NicknameInfo object references ColumnInfo
objects that contain
the local name of each column and additional information that was stored in
the federated server's system catalog as a result of running DDL statements.
FencedGenericNickname
class
and the UnfencedGenericNickname
class.
Method Summary | |
protected void |
destroy()
Destroys this nickname object and frees any resources associated with it. |
NicknameInfo |
getInfo()
Retrieve the nickname information stored in the federated server's system catalog as a result of running DDL statements. |
java.lang.String |
getLocalName()
Retrieve the local name for this nickname. |
java.lang.String |
getLocalSchema()
Retrieve the local schema for this nickname. |
Server |
getServer()
Retrieve the data source server that contains this nickname. |
Wrapper |
getWrapper()
Retrieve the wrapper instance that this nickname belongs to. |
protected void |
initializeMyNickname(NicknameInfo nicknameInfo)
Perform the necessary nickname initialization. |
protected NicknameInfo |
verifyMyRegisterNicknameInfo(NicknameInfo nicknameInfo)
Validate the nickname information that is specified in CREATE NICKNAME statements. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
protected void destroy() throws java.lang.Exception
UnfencedGenericNickname
and FencedGenericNickname
.
java.lang.Exception
- if the processing fails.public final NicknameInfo getInfo()
NicknameInfo
public final java.lang.String getLocalName()
public final java.lang.String getLocalSchema()
public final Server getServer()
public final Wrapper getWrapper()
protected void initializeMyNickname(NicknameInfo nicknameInfo) throws java.lang.Exception
nicknameInfo
- The nickname catalog information.
java.lang.Exception
- if the initialization process fails.NicknameInfo
protected NicknameInfo verifyMyRegisterNicknameInfo(NicknameInfo nicknameInfo) throws java.lang.Exception
UnfencedGenericNickname
class is
part of the trusted process space, the method cannot interact with the remote
data source. If interaction with the remote data source is necessary to verify
the nickname information, the verifyMyRegisterNicknameInfo method of the
FencedGenericNickname
class must be implemented.
nicknameInfo
- The information from the CREATE NICKNAME statement.
java.lang.Exception
- if the verification process fails.NicknameInfo
|
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.