Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.iapi.sql.ResultColumnDescriptor

Method Summary

Modifier and Type	Method and Description
public int	Returns: An int containing the position of the Column within the table. getColumnPosition() Get the position of the Column.
public String	Returns: A String containing the name of the column. getName() Returns the name of the Column.
public String	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. getSourceSchemaName() Get the name of the schema for the Column's base table, if any.
public String	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. The name of the Column's base table. If the column is not in a schema (i.e. is a derived column), it returns NULL. getSourceTableName() Get the name of the underlying(base) table this column comes from, if any.
public DataTypeDescriptor	Returns: A DataTypeDescriptor describing the type of the column. getType() Returns a DataTypeDescriptor for the column.
public boolean	Returns: true if this result column represents a generated column hasGenerationClause() Return true if this result column represents a generated column.
public boolean	Returns: TRUE, if the column is a base column of a table and is an autoincrement column. isAutoincrement() Tell us if the column is an autoincrement column or not.
public boolean	Returns: TRUE, if the column is a base column of a table and is writable by a positioned update. updatableByCursor() Return true if the column is wirtable by a positioned update.

Method Detail

getColumnPosition	back to summary
public int getColumnPosition() Get the position of the Column. NOTE - position is 1-based. Returns:int An int containing the position of the Column within the table.

getColumnPosition

back to summary

public int getColumnPosition()

Get the position of the Column. NOTE - position is 1-based.

Returns:int: An int containing the position of the Column within the table.

getName	back to summary
public String getName() Returns the name of the Column. Returns:String A String containing the name of the column.

getName

back to summary

public String getName()

Returns the name of the Column.

Returns:String: A String containing the name of the column.

getSourceSchemaName	back to summary
public 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:String 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.

getSourceSchemaName

back to summary

public 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:String: 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	back to summary
public 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:String 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. The name of the Column's base table. If the column is not in a schema (i.e. is a derived column), it returns NULL.

getSourceTableName

back to summary

public 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:String: 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. The name of the Column's base table. If the column is not in a schema (i.e. is a derived column), it returns NULL.

getType	back to summary
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:DataTypeDescriptor A DataTypeDescriptor describing the type of the column.

getType

back to summary

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:DataTypeDescriptor: A DataTypeDescriptor describing the type of the column.

hasGenerationClause	back to summary
public boolean hasGenerationClause() Return true if this result column represents a generated column. Returns:boolean true if this result column represents a generated column

hasGenerationClause

back to summary

public boolean hasGenerationClause()

Return true if this result column represents a generated column.

Returns:boolean: true if this result column represents a generated column

isAutoincrement	back to summary
public boolean isAutoincrement() Tell us if the column is an autoincrement column or not. Returns:boolean TRUE, if the column is a base column of a table and is an autoincrement column.

isAutoincrement

back to summary

public boolean isAutoincrement()

Tell us if the column is an autoincrement column or not.

Returns:boolean: TRUE, if the column is a base column of a table and is an autoincrement column.

updatableByCursor	back to summary
public boolean updatableByCursor() Return true if the column is wirtable by a positioned update. Returns:boolean TRUE, if the column is a base column of a table and is writable by a positioned update.

updatableByCursor

back to summary

public boolean updatableByCursor()

Return true if the column is wirtable by a positioned update.

Returns:boolean: TRUE, if the column is a base column of a table and is writable by a positioned update.

public Interface ResultColumnDescriptor

Method Summary

Method Detail