org.apache.derby.iapi.sql
Interface ResultColumnDescriptor
- All Known Implementing Classes:
- GenericColumnDescriptor, ResultColumn
- public interface ResultColumnDescriptor
A ResultColumnDescriptor describes a result column in a ResultSet.
- Author:
- Jeff Lichtman
Method Summary |
int |
getColumnPosition()
Get the position of the Column.
|
java.lang.String |
getName()
Returns the name of the Column. |
java.lang.String |
getSourceSchemaName()
Get the name of the schema for the Column's base table, if any.
|
java.lang.String |
getSourceTableName()
Get the name of the underlying(base) table this column comes from, if any.
|
DataTypeDescriptor |
getType()
Returns a DataTypeDescriptor for the column. |
boolean |
isAutoincrement()
Tell us if the column is an autoincrement column or not. |
boolean |
updatableByCursor()
Return true if the column is wirtable by a positioned update. |
getType
public DataTypeDescriptor getType()
- Returns a DataTypeDescriptor for the column. This DataTypeDescriptor
will not represent an actual value, it will only represent the type
that all values in the column will have.
- Returns:
- A DataTypeDescriptor describing the type of the column.
getName
public java.lang.String getName()
- Returns the name of the Column.
- Returns:
- A String containing the name of the column.
getSourceSchemaName
public java.lang.String getSourceSchemaName()
- Get the name of the schema for the Column's base table, if any.
Following example queries will all return APP (assuming user is in schema APP)
select t.a from t
select b.a from t as b
select app.t.a from t
- Returns:
- The name of the schema of the Column's base table. If the column
is not in a schema (i.e. is a derived column), it returns NULL.
getSourceTableName
public java.lang.String getSourceTableName()
- Get the name of the underlying(base) table this column comes from, if any.
Following example queries will all return T
select a from t
select b.a from t as b
select t.a from t
- Returns:
- A String containing the name of the base table of the Column
is in. If the column is not in a table (i.e. is a
derived column), it returns NULL.
updatableByCursor
public boolean updatableByCursor()
- Return true if the column is wirtable by a positioned update.
- Returns:
- TRUE, if the column is a base column of a table and is
writable by a positioned update.
getColumnPosition
public int getColumnPosition()
- Get the position of the Column.
NOTE - position is 1-based.
- Returns:
- An int containing the position of the Column
within the table.
isAutoincrement
public boolean isAutoincrement()
- Tell us if the column is an autoincrement column or not.
- Returns:
- TRUE, if the column is a base column of a table and is an
autoincrement column.
Apache Derby V10.1 Engine Documentation - Copyright © 1997,2005 The Apache Software Foundation or its licensors, as applicable.