|
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.RemoteOperation
com.ibm.db2.wrapper.RemotePassthru
The RemotePassthru class represents a pass-through session on a remote data source.
An instance of your RemotePassthru subclass is created when the federated server
invokes the createRemotePassthru
method
on an instance of the appropriate RemoteConnection
subclass.
If your data source does not support pass-through operations,
do not implement a RemotePassthru subclass and do not override the default
implementation of this method.
Constructor Summary | |
protected |
RemotePassthru(RemoteConnection activeConnection,
long id)
Construct a new pass-through object for the specified connection. |
Method Summary | |
protected void |
close()
Close a pass-through cursor and allows the data source to clean up after pass-through statement processing. |
protected void |
describe(RuntimeDataDescList dataDescriptionList)
Describe the result set of a statement that is processed by a pass-through operation. |
protected void |
execute()
Execute a statement that returns a code and does not return a result set by a pass-through operation. |
protected void |
fetch()
Fetch a row from a pass-through cursor by copying a single-result row into the output data buffer. |
java.lang.String |
getSQLStatement()
Retrieve the SQL statement for the remote pass-through operation. |
protected void |
open()
Open a cursor for a pass-through operation and enable the data source to return the first result row for the query. |
protected void |
prepare(RuntimeDataDescList dataDescriptionList)
Prepare a pass-through operation. |
protected void |
reportEof()
Report an end-of-file condition during a fetch operation. |
Methods inherited from class com.ibm.db2.wrapper.RemoteOperation |
getConnection, getExecDesc, getInputData, getOutputData, getServer, getWrapper |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected RemotePassthru(RemoteConnection activeConnection, long id)
activeConnection
- The connection through which the pass-through operation is executed.id
- An integer value that represents the RemotePassthru object.RemoteConnection
Method Detail |
protected void close() throws java.lang.Exception
java.lang.Exception
- if the close operation fails.protected void describe(RuntimeDataDescList dataDescriptionList) throws java.lang.Exception
RuntimeDataDescList
instance that describes the number and type of
columns for each row of the result.
dataDescriptionList
- The list of data descriptors for the operation.
java.lang.Exception
- if the method fails.RuntimeDataDescList
protected void execute() throws java.lang.Exception
java.lang.Exception
- if the execution process fails.protected void fetch() throws java.lang.Exception
java.lang.Exception
- if the fetch operation fails.public final java.lang.String getSQLStatement() throws WrapperException
WrapperException
- if the method fails.protected void open() throws java.lang.Exception
java.lang.Exception
- if the open operation fails.protected void prepare(RuntimeDataDescList dataDescriptionList) throws java.lang.Exception
dataDescriptionList
- The list of data descriptors for the operation.
java.lang.Exception
- if the prepare operation fails.RuntimeDataDescList
protected final void reportEof() throws WrapperException
fetch
method when there are no more rows to retrieve.
reportEof
in class RemoteOperation
WrapperException
- if the method fails.
|
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.