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 getSchemaName()
          Get the name of the schema the Column is in, if any.
 java.lang.String getSourceTableName()
          Get the name of the table the Column is in, if any.
 DataTypeDescriptor getType()
          Returns a DataTypeDescriptor for the column.
 boolean isAutoincrement()
          Tell us if the column is an autoincrement column or not.
 

Method Detail

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.

getSchemaName

public java.lang.String getSchemaName()
Get the name of the schema the Column is in, if any.

Returns:
A String containing the name of the schema the Column is in. 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 table the Column is in, if any.

Returns:
A String containing the name of the table the Column is in. If the column is not in a table (i.e. is a derived column), it returns NULL.

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.0 Engine Documentation - Copyright © 1997,2004 The Apache Software Foundation or its licensors, as applicable.