|
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.Data
com.ibm.db2.wrapper.RuntimeData
The RuntimeData class represents each column value that is transferred between the federated server and a wrapper. A column value can be part of a result row being transferred from the wrapper to the federated server, or it can be a value to be bound to a runtime parameter in a query that is submitted to the wrapper by the federated server.
Field Summary |
Fields inherited from class com.ibm.db2.wrapper.Data |
BLOB, CHAR, CLOB, DATE, DECIMAL, DOUBLE, FLOAT, INT, LONG, NONE, SHORT, SQL_NO_NULLS, SQL_NULLABLE, SQL_NULLABLE_UNKNOWN, TIME, TIMESTAMP, VARCHAR |
Method Summary | |
boolean |
checkFriendlyDivBy0()
Determine if the reason for a null indication is a divide by zero error. |
boolean |
checkFriendlyException()
Determine if the reason for a null indication is a numeric exception. |
void |
clearNullIndicator()
Clear the null indicator for the data value. |
int |
getActualLength()
Retrieve the actual length for the data value. |
short |
getCodepage()
Retrieve the code page for character data type values. |
protected byte[] |
getData()
Retrieve the data value in an internal format. |
int |
getDataIndex()
Retrieve the column number for the data value. |
short |
getDataType()
Retrieve the data type. |
boolean |
getForBitData()
Retrieve the FOR BIT DATA flag which indicates binary data. |
byte |
getInvariant()
Retrieve the invariant value. |
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. |
int |
getRemoteLength()
Retrieve the remote length of the data value. |
byte |
getRemotePrecision()
Retrieve the remote precision for the numeric data type values. |
byte |
getRemoteScale()
Retrieve the remote scale of the numeric data type values. |
short |
getRemoteType()
Retrieve the remote type of the data value. |
byte |
getScale()
Retrieve the scale for numeric data type values. |
boolean |
isDataNull()
Indicate whether the data value is null. |
boolean |
isDataNullable()
Indicate whether the data value is nullable. |
boolean |
isSemanticNull()
Indicate whether the data value is semantic null. |
void |
setActualLength(int length)
Set the actual length for the data value. |
void |
setBigDecimal(java.math.BigDecimal value)
Set the data value as a BigDecimal instance. |
void |
setBinary(byte[] value)
Set the data value as a binary value. |
void |
setByte(byte value)
Set the data value as a byte. |
void |
setDataNull()
Mark the data value as null. |
void |
setDate(java.sql.Date value)
Set the data value as a Date instance. |
void |
setDouble(double value)
Set the data value as a double. |
void |
setFloat(float value)
Set the data value as a float. |
void |
setFriendlyDivBy0()
Indicate that a value is null because a divide by zero error occurred. |
void |
setFriendlyException()
Indicate that a value is null because of a numeric exception. |
void |
setInt(int value)
Set the data value as an int. |
void |
setLong(long value)
Set the data value as a long. |
void |
setNullIndicator(short indicator)
Set the null indicator for the data value. |
void |
setObject(java.lang.Object value)
Set the data value as an Object instance. |
void |
setPrecision(byte precision)
Set the precision for numeric data type values. |
void |
setScale(byte scale)
Set the scale for numeric data type values. |
void |
setShort(short value)
Set the data value as a short. |
void |
setString(java.lang.String value)
Set the data value as a string. |
void |
setTime(java.sql.Time value)
Set the data value as a Time instance. |
void |
setTimestamp(java.sql.Timestamp value)
Set the data value as a Timestamp instance. |
Methods inherited from class com.ibm.db2.wrapper.Data |
getBigDecimal, getByte, getDate, getDouble, getFloat, getInt, getLong, getObject, getShort, getString, getTime, getTimestamp |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public boolean checkFriendlyDivBy0()
public boolean checkFriendlyException()
public void clearNullIndicator() throws WrapperException
WrapperException
- if the operation fails.public int getActualLength()
public short getCodepage()
protected byte[] getData() throws WrapperException
getData
in class Data
WrapperException
- - if the processing fails.public int getDataIndex()
public short getDataType()
getDataType
in class Data
public boolean getForBitData()
getForBitData
in class Data
public byte getInvariant()
RemoteQuery.reopen(short)
method.
public int getMaximumLength()
public java.lang.String getName()
public short getNullIndicator()
Data.SQL_NULLABLE
or Data.SQL_NO_NULLS
public byte getPrecision()
public int getRemoteLength()
public byte getRemotePrecision()
public byte getRemoteScale()
public short getRemoteType()
public byte getScale()
public boolean isDataNull()
public boolean isDataNullable()
public boolean isSemanticNull()
public void setActualLength(int length)
length
- The actual length.public void setBigDecimal(java.math.BigDecimal value) throws WrapperException
value
- The data value.
WrapperException
- if the data type is not compatible.public void setBinary(byte[] value) throws WrapperException
value
- The data value.
WrapperException
- if the data type is not compatible.public void setByte(byte value) throws WrapperException
value
- The data value.
WrapperException
- if the data type is not compatible.public void setDataNull() throws WrapperException
WrapperException
- if data cannot be null.public void setDate(java.sql.Date value) throws WrapperException
value
- The data value.
WrapperException
- if the data type is not compatible.public void setDouble(double value) throws WrapperException
value
- The data value.
WrapperException
- if the data type is not compatible.public void setFloat(float value) throws WrapperException
value
- The data value.
WrapperException
- if the data type is not compatible.public void setFriendlyDivBy0() throws WrapperException
setDataNull()
before.
WrapperException
- if the operation fails.public void setFriendlyException() throws WrapperException
setDataNull()
before.
WrapperException
- if the operation fails.public void setInt(int value) throws WrapperException
value
- The data value.
WrapperException
- if the data type is not compatible.public void setLong(long value) throws WrapperException
value
- The data value.
WrapperException
- if the data type is not compatible.public void setNullIndicator(short indicator)
indicator
- The null indicator.public void setObject(java.lang.Object value) throws WrapperException
value
- The data value.
WrapperException
- if the data type is not compatible.public void setPrecision(byte precision)
precision
- The precision.public void setScale(byte scale)
scale
- The scale.public void setShort(short value) throws WrapperException
value
- The data value.
WrapperException
- if the data type is not compatible.public void setString(java.lang.String value) throws WrapperException
value
- The data value.
WrapperException
- if the data type is not compatible.public void setTime(java.sql.Time value) throws WrapperException
value
- The data value.
WrapperException
- if the data type is not compatible.public void setTimestamp(java.sql.Timestamp value) throws WrapperException
value
- The data value.
WrapperException
- if the data type is not compatible.
|
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.