org.restsql.core

Interface ColumnMetaData

All Superinterfaces:

Comparable<ColumnMetaData>

All Known Implementing Classes:

ColumnMetaDataImpl, MySqlColumnMetaData

public interface ColumnMetaData
extends Comparable<ColumnMetaData>

Encapsulates column (or field) metadata of an SQL Resource.

Author:

Mark Sawers

See Also:

SqlResource, TableMetaData

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ColumnMetaData column) Compares another column based on the column number of the select clause in the SQL Resource definition query.
String	getColumnLabel() Returns column label, a string identified in double quotes after columns in the select clause in the SQL Resource definition query.
String	getColumnName() Returns column name, as it is known by the database.
int	getColumnNumber() Returns column number in the select clause in the SQL Resource definition query.
int	getColumnType() Returns column type from java.sql.Types.
String	getColumnTypeName() Returns column type name as given by the database JDBC driver.
String	getDatabaseName() Returns database name.
String	getQualifiedColumnLabel() Returns fully qualified column label in database-specific form for use in SQL statements.
String	getQualifiedColumnName() Returns fully qualified column name in database-specific form for use in SQL statements.
String	getQualifiedTableName() Returns fully qualified table name in database-specific form for use in SQL statements.
Object	getResultByLabel(ResultSet resultSet) Returns object from result set using the column label.
Object	getResultByNumber(ResultSet resultSet) Returns object from result set using the column number.
String	getSequenceName() Returns sequence name associated with column or null if none.
String	getTableName() Returns table name.
TableMetaData.TableRole	getTableRole() Returns role of table in the SQL Resource.
boolean	isBinaryType() Returns true if type is BINARY, BLOB, JAVA OBJECT or LONGVARBINARY.
boolean	isCharOrDateTimeType() Returns true if column is a character string or date, time or timestamp.
boolean	isNonqueriedForeignKey() Returns true for foreign key columns not declared in the SQL Resource query but added by the framework.
boolean	isPrimaryKey() Returns true if the column is a primary key.
boolean	isReadOnly() Returns true if the column is read-only, for example derived from SQL function or a database view.
boolean	isSequence() Returns true if column is associated with a sequence.
void	normalizeValue(RequestValue requestValue) Converts String value to a numeric Object, Date or UUDecode String into Object if required using the column metadata.
void	setAttributes(int columnNumber, String databaseName, String qualifiedTableName, String tableName, String columnName, String qualifiedColumnName, String columnLabel, String qualifiedColumnLabel, String columnTypeName, int columnType, boolean readOnly) Used for all columns declared in the SqlResource select clause.
void	setAttributes(String databaseName, String sqlQualifiedTableName, String tableName, TableMetaData.TableRole tableRole, String columnName, String qualifiedColumnName, String columnLabel, String qualifiedColumnLabel, String columnTypeString) Used for foreign key columns not declared in the SqlResource select columns.
void	setPrimaryKey(boolean primaryKey) Sets primary key.
void	setSequence(boolean sequence) Sets true if column populated with a sequence function (auto increment).
void	setSequenceName(String sequenceName) Sets sequence name.
void	setTableRole(TableMetaData.TableRole tableRole) Sets table role.

Method Detail

compareTo

int compareTo(ColumnMetaData column)

Compares another column based on the column number of the select clause in the SQL Resource definition query. Implements Comparable interface.

Specified by:

compareTo in interface Comparable<ColumnMetaData>

getColumnLabel

String getColumnLabel()

Returns column label, a string identified in double quotes after columns in the select clause in the SQL Resource definition query.

getColumnName

String getColumnName()

Returns column name, as it is known by the database.

getColumnNumber

int getColumnNumber()

Returns column number in the select clause in the SQL Resource definition query.

getColumnType

int getColumnType()

Returns column type from java.sql.Types.

Returns:

java.sql.Types constant

See Also:

Types

getColumnTypeName

String getColumnTypeName()

Returns column type name as given by the database JDBC driver.

getDatabaseName

String getDatabaseName()

Returns database name.

getQualifiedColumnLabel

String getQualifiedColumnLabel()

Returns fully qualified column label in database-specific form for use in SQL statements. MySQL uses the form database.table.label, for example sakila.film.id. PostgreSQL can only use label and cannot disambiguate by table source.

getQualifiedColumnName

String getQualifiedColumnName()

Returns fully qualified column name in database-specific form for use in SQL statements. MySQL uses the form database.table.column, for example sakila.film.film_id. PostgreSQL uses the form database.schema.table.column, for example sakila.public.film.film_id.

getQualifiedTableName

String getQualifiedTableName()

Returns fully qualified table name in database-specific form for use in SQL statements. MySQL uses the form database.table, for example sakila.film. PostgreSQL uses the form database.schema.table, for example sakila.public.film.

getResultByLabel

Object getResultByLabel(ResultSet resultSet)
                        throws SQLException

Returns object from result set using the column label.

Throws:

SQLException

getResultByNumber

Object getResultByNumber(ResultSet resultSet)
                         throws SQLException

Returns object from result set using the column number.

Throws:

SQLException

getSequenceName

String getSequenceName()

Returns sequence name associated with column or null if none. For MySQL, returns table name.

getTableName

String getTableName()

Returns table name.

getTableRole

TableMetaData.TableRole getTableRole()

Returns role of table in the SQL Resource.

isBinaryType

boolean isBinaryType()

Returns true if type is BINARY, BLOB, JAVA OBJECT or LONGVARBINARY.

isCharOrDateTimeType

boolean isCharOrDateTimeType()

Returns true if column is a character string or date, time or timestamp.

isNonqueriedForeignKey

boolean isNonqueriedForeignKey()

Returns true for foreign key columns not declared in the SQL Resource query but added by the framework. These are required for writes to child extensions, parent extensions and and one-to-many child tables.

isPrimaryKey

boolean isPrimaryKey()

Returns true if the column is a primary key.

isReadOnly

boolean isReadOnly()

Returns true if the column is read-only, for example derived from SQL function or a database view.

isSequence

boolean isSequence()

Returns true if column is associated with a sequence.

See Also:

getSequenceName()

normalizeValue

void normalizeValue(RequestValue requestValue)
                    throws InvalidRequestException

Converts String value to a numeric Object, Date or UUDecode String into Object if required using the column metadata.

Parameters:

requestValue - parameter or resource identifier

Throws:

InvalidRequestException - if conversion failed

setAttributes

void setAttributes(int columnNumber,
                 String databaseName,
                 String qualifiedTableName,
                 String tableName,
                 String columnName,
                 String qualifiedColumnName,
                 String columnLabel,
                 String qualifiedColumnLabel,
                 String columnTypeName,
                 int columnType,
                 boolean readOnly)

Used for all columns declared in the SqlResource select clause.

setAttributes

void setAttributes(String databaseName,
                 String sqlQualifiedTableName,
                 String tableName,
                 TableMetaData.TableRole tableRole,
                 String columnName,
                 String qualifiedColumnName,
                 String columnLabel,
                 String qualifiedColumnLabel,
                 String columnTypeString)

Used for foreign key columns not declared in the SqlResource select columns. These are required for writes to child extensions, parent extensions and child tables.

setPrimaryKey

void setPrimaryKey(boolean primaryKey)

Sets primary key.

setSequence

void setSequence(boolean sequence)

Sets true if column populated with a sequence function (auto increment).

setSequenceName

void setSequenceName(String sequenceName)

Sets sequence name.

setTableRole

void setTableRole(TableMetaData.TableRole tableRole)

Sets table role.