com.ibm.bpe.api

Class QueryColumnInfo

  1. java.lang.Object
  2. extended bycom.ibm.bpe.api.QueryColumnInfo
All implemented interfaces:
java.io.Serializable

  1. public class QueryColumnInfo
  2. extends java.lang.Object
  3. implements java.io.Serializable
Provides information on the columns of a query result set. In the API, this class is solely used to provide symbolic values for the column type specifications.
Since:
5.0
See Also:
Serialized Form

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT
  1. static
  2. short
TYPE_BINARY
States that the values in the column are binares.
  1. static
  2. short
TYPE_BOOLEAN
States that the values in the column are booleans.
  1. static
  2. short
TYPE_DECIMAL
States that the values in the column are floating point numbers.
  1. static
  2. short
TYPE_ID
States that the values in the column are object IDs.
  1. static
  2. short
TYPE_NUMBER
States that the values in the column are numbers.
  1. static
  2. short
TYPE_STRING
States that the values in the column are strings.
  1. static
  2. short
TYPE_TIMESTAMP
States that the values in the column are timestamps.

Constructor Summary

Constructor and Description
QueryColumnInfo(QueryColumnInfo obj)
Copy constructor
QueryColumnInfo(java.lang.String columnName,short type,boolean isNullable)
Constructor.

Method Summary

Modifier and Type Method and Description
  1. void
addConstant(java.lang.String strConstantName,int value)
Adds an enumeration constant to the column information.
  1. java.lang.String
getColumnName()
Returns the name of the column.
  1. java.lang.Integer
getConstant(java.lang.String strConstantName)
Returns the enumeration value of the specified constant.
  1. java.lang.String
getConstantName(int constantValue)
Returns the name of the specified enumeration constant.
  1. java.lang.String
getTableName()
Returns the table name.
  1. short
getType()
Returns the type of the column.
  1. boolean
isNullable()
States whether the column allows for null values.
  1. void
setColmnName(java.lang.String columnName)
Sets the column name This information is overwritten if column names are overwritten, e.g. if alias names are used.
  1. void
setTableName(java.lang.String tableName)
Sets the name of the table.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

  1. public static final java.lang.String COPYRIGHT
See Also:

TYPE_STRING

  1. public static final short TYPE_STRING
States that the values in the column are strings.
See Also:

TYPE_NUMBER

  1. public static final short TYPE_NUMBER
States that the values in the column are numbers.
See Also:

TYPE_TIMESTAMP

  1. public static final short TYPE_TIMESTAMP
States that the values in the column are timestamps.
See Also:

TYPE_BINARY

  1. public static final short TYPE_BINARY
States that the values in the column are binares.
See Also:

TYPE_BOOLEAN

  1. public static final short TYPE_BOOLEAN
States that the values in the column are booleans.
See Also:

TYPE_ID

  1. public static final short TYPE_ID
States that the values in the column are object IDs.
See Also:

TYPE_DECIMAL

  1. public static final short TYPE_DECIMAL
States that the values in the column are floating point numbers.
See Also:

Constructor Detail

QueryColumnInfo

  1. public QueryColumnInfo(java.lang.String columnName,
  2. short type,
  3. boolean isNullable)
Constructor.

Parameters:
columnName - The name of the column in the database.

type - The type of the values in the column.

isNullable - True if a value in the column can be null. False if a value in the column cannot be null.

QueryColumnInfo

  1. public QueryColumnInfo(QueryColumnInfo obj)
Copy constructor
Parameters:
obj - the object to copy

Method Detail

addConstant

  1. public void addConstant(java.lang.String strConstantName,
  2. int value)
Adds an enumeration constant to the column information.

Parameters:
strConstantName - The name of the enumeration constant, for example, REASON_OWNER.

value - The value of the enumeration constant.

getConstant

  1. public java.lang.Integer getConstant( java.lang.String strConstantName)
Returns the enumeration value of the specified constant.

Parameters:
strConstantName - The name of the enumeration constant, for example, REASON_OWNER.

Returns:
Returns the value of the enumeration constant. If the specified constant is not found, a null object is returned.

getConstantName

  1. public java.lang.String getConstantName( int constantValue)
Returns the name of the specified enumeration constant.

Parameters:
constantValue - The integer value of the enumeration constant.

Returns:
Returns the name of the enumeration constant, e.g. REASON_OWNER. If the value is not found, a null object is returned.

getColumnName

  1. public final java.lang.String getColumnName( )
Returns the name of the column.

Returns:
The name of the column in the database.

getType

  1. public final short getType()
Returns the type of the column.

Returns:
The type of the values in the column.

isNullable

  1. public final boolean isNullable( )
States whether the column allows for null values.

Returns:
True if a value in the column can be null. False if a value in the column cannot be null.

setTableName

  1. public final void setTableName( java.lang.String tableName)
Sets the name of the table.

This information is set, when a column is added to a QueryTableInfo object. A reference to the QueryTableInfo object is consciously not stored here to avoid loops and to keep the serializable object in the QueryResultSet small.

Parameters:
tableName - The name of the table.

getTableName

  1. public final java.lang.String getTableName( )
Returns the table name.

Returns:
The name of the table.

setColmnName

  1. public final void setColmnName( java.lang.String columnName)
Sets the column name

This information is overwritten if column names are overwritten, e.g. if alias names are used.

Parameters:
columnName - The name of the column