com.ibm.datatools.sqlj.template
Interface ISQLFieldInfo


public interface ISQLFieldInfo

An object that contains metadata for either a column in a result set or a parameter in an SQL statement.


Method Summary

Method Summary
Return Data TypeMethod Name and Description
java.lang.String getAlias()
Deprecated. Use getTableAlias().
java.lang.String getColumnAlias()
Returns the alias associated with the column.
int getIndex()
Returns the index value of the column, as it occurs in the result set.
java.lang.String getName()
Returns the name of either the column in the result set or the parameter in the SQL statement.
java.lang.String getSchema()
Returns the schema name for the column.
java.lang.String getTable()
Returns the table name for the column.
java.lang.String getTableAlias()
Returns the alias of the table that is associated with the column.
int getType()
Returns a code value that represents the SQL type of the column, as defined in java.sql.Types.
boolean isExpression()
Indicates whether the column in the result set is derived from an expression.
boolean isKey()
Indicates whether the column is a key.

Method Detail

getIndex

int getIndex()
Returns the index value of the column, as it occurs in the result set.
Returns:
the column's index value.

getName

java.lang.String getName()
Returns the name of either the column in the result set or the parameter in the SQL statement.

If the column in the result set is derived from an expression, this method returns the expression.

Returns:
the column or parameter name or expression.

getSchema

java.lang.String getSchema()
Returns the schema name for the column.

Return value is undefined if the column is derived from an expression.

Returns:
the schema name.

getTable

java.lang.String getTable()
Returns the table name for the column.

Return value is undefined if the column is derived from an expression.

Returns:
the table name.

getAlias

java.lang.String getAlias()
Deprecated. Use getTableAlias().
Returns the alias of the table that is associated with the column.

Return value is undefined if the column is derived from an expression.

Returns:
the name of the table's alias, if it exists; otherwise, null.

getTableAlias

java.lang.String getTableAlias()
Returns the alias of the table that is associated with the column.

Return value is undefined if the column is derived from an expression.

Returns:
the name of the table's alias, if it exists; otherwise, null.

getColumnAlias

java.lang.String getColumnAlias()
Returns the alias associated with the column.
Returns:
the name of the column's alias, if it exists; otherwise, null.

getType

int getType()
Returns a code value that represents the SQL type of the column, as defined in java.sql.Types. The corresponding Java type of the column can be obtained from the IBeanData.getJavaTypeforSql() method.

Return value is undefined if the column is derived from an expression.

Returns:
the code that represents the SQL type.
See Also:
IBeanData.getJavaTypeForSql(int)

isExpression

boolean isExpression()
Indicates whether the column in the result set is derived from an expression.

If the column is derived from an expression, the following occurs:

Returns:
true if the column is derived from an expression; otherwise, false.

isKey

boolean isKey()
Indicates whether the column is a key.
Returns:
true if the column is a key; otherwise, false.