|
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.RuntimeDataDesc
The RuntimeDataDesc class is created by the federated server to describe each column
value that is transferred between the federated server and a wrapper.
A column value can be part of a result row that is transferred from the wrapper to the
federated server, or a value to be bound to a run-time parameter in a query that is
submitted to the wrapper by the federated server.
Usage:
For both RemoteQuery
and RemotePassthru
objects, the federated server
creates a RuntimeDataDesc instance for each RuntimeData
object in the input data list that
represents the parameter values. The federated server supplies the column descriptions.
For RemoteQuery
objects, the federated server also creates a RuntimeDataDesc instance
for each RuntimeData
object in the output data list that represents values in result rows.
The federated server supplies these column descriptions as well.
The wrapper writer creates instances of the RuntimeDataDesc class to describe the result set of
a pass-through session in the RemotePassthru.describe
method.
Constructor Summary | |
RuntimeDataDesc(short type,
int maxLength,
short codepage,
short nullIndicator)
Construct a new RuntimeDataDesc object with the specified attributes to describe a column of a result set. |
|
RuntimeDataDesc(short type,
int maxLength,
short codepage,
short nullIndicator,
byte precision)
Construct a new RuntimeDataDesc object with the specified attributes to describe a column of a result set. |
|
RuntimeDataDesc(short type,
int maxLength,
short codepage,
short nullIndicator,
byte precision,
byte scale)
Construct a new RuntimeDataDesc object with the specified attributes to describe a column of a result set. |
|
RuntimeDataDesc(short type,
int maxLength,
short codepage,
short nullIndicator,
byte precision,
byte scale,
java.lang.String name)
Construct a new RuntimeDataDesc object with the specified attributes to describe a column of a result set. |
|
RuntimeDataDesc(short type,
int maxLength,
short codepage,
short nullIndicator,
byte precision,
byte scale,
java.lang.String name,
short remoteType)
Construct a new RuntimeDataDesc object with the specified attributes to describe a column of a result set. |
Method Summary | |
short |
getCodepage()
Retrieve the code page for character data type values. |
short |
getDataType()
Retrieve the type of data. |
boolean |
getForBitData()
Retrieve the FOR BIT DATA flag which indicates binary data. |
int |
getMaximumLength()
Retrieve the maximum length of the data. |
java.lang.String |
getName()
Retrieve the name for the data. |
short |
getNullIndicator()
Retrieve the null indicator for the data value. |
byte |
getPrecision()
Retrieve the precision for numeric data type values. |
short |
getRemoteType()
Retrieve the remote type of the data. |
byte |
getScale()
Retrieve the scale for numeric data type values. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public RuntimeDataDesc(short type, int maxLength, short codepage, short nullIndicator) throws WrapperException
type
- The type ID of the data.maxLength
- The maximum length of the data.codepage
- The code page in which data is represented.
This parameter is valid for character data types only.nullIndicator
- The indicator of a null value.
WrapperException
- if the method fails.public RuntimeDataDesc(short type, int maxLength, short codepage, short nullIndicator, byte precision) throws WrapperException
type
- The type ID of the data.maxLength
- The maximum length of the data.codepage
- The code page in which data is represented.
This parameter is valid for character data types only.nullIndicator
- The indicator of a null value.precision
- The precision of the data.
This parameter is valid for numeric and decimal data types only.
WrapperException
- if the method fails.public RuntimeDataDesc(short type, int maxLength, short codepage, short nullIndicator, byte precision, byte scale) throws WrapperException
type
- The type ID of the data.maxLength
- The maximum length of the data.codepage
- The code page in which data is represented.
This parameter is valid for character data types only.nullIndicator
- The indicator of a null value.precision
- The precision of the data.
This parameter is valid for numeric and decimal data types only.scale
- The scale of the data.
This parameter is valid for numeric and decimal data types only.
WrapperException
- if the method fails.public RuntimeDataDesc(short type, int maxLength, short codepage, short nullIndicator, byte precision, byte scale, java.lang.String name) throws WrapperException
type
- The type ID of the data.maxLength
- The maximum length of the data.codepage
- The codepage in which data is represented.
This parameter is valid for character data types only.nullIndicator
- The indicator of a null value.precision
- The precision of the data.
This parameter is valid for numeric and decimal data types only.scale
- The scale of the data.
This parameter is valid for numeric and decimal data types only.name
- The name of the data column.
WrapperException
- if the method fails.public RuntimeDataDesc(short type, int maxLength, short codepage, short nullIndicator, byte precision, byte scale, java.lang.String name, short remoteType) throws WrapperException
type
- The type ID of the data.maxLength
- The maximum length of the data.codepage
- The code page in which data is represented.
This parameter is valid for character data types only.nullIndicator
- The indicator of a null value.precision
- The precision of the data.
This parameter is valid for numeric and decimal data types only.scale
- The scale of the data.
This parameter is valid for numeric and decimal data types only.name
- The name of the data column.remoteType
- The type of the data at the remote data source.
WrapperException
- if the method fails.Method Detail |
public short getCodepage()
public short getDataType()
public boolean getForBitData()
public int getMaximumLength()
public java.lang.String getName() throws WrapperException
WrapperException
public short getNullIndicator()
Data.SQL_NULLABLE
or Data.SQL_NO_NULLS
public byte getPrecision()
public short getRemoteType()
public byte getScale()
|
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.