org.restsql.core.impl

Class ColumnMetaDataImpl

java.lang.Object

org.restsql.core.impl.ColumnMetaDataImpl

All Implemented Interfaces:

Comparable<ColumnMetaData>, ColumnMetaData

Direct Known Subclasses:

MySqlColumnMetaData

public class ColumnMetaDataImpl
extends Object
implements ColumnMetaData

Represents column (field) metadata.

Author:

Mark Sawers

Constructor Summary

Constructors

Constructor and Description
ColumnMetaDataImpl()

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.
protected int	getColumnType(int columnType, String columnTypeName) Method for subclasses to customize column type if desired.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ColumnMetaDataImpl

public ColumnMetaDataImpl()

Method Detail

compareTo

public int compareTo(ColumnMetaData column)

Description copied from interface: ColumnMetaData

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>

Specified by:

compareTo in interface ColumnMetaData

getColumnLabel

public String getColumnLabel()

Description copied from interface: ColumnMetaData

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

Specified by:

getColumnLabel in interface ColumnMetaData

getColumnName

public String getColumnName()

Description copied from interface: ColumnMetaData

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

Specified by:

getColumnName in interface ColumnMetaData

getColumnNumber

public int getColumnNumber()

Description copied from interface: ColumnMetaData

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

Specified by:

getColumnNumber in interface ColumnMetaData

getColumnType

public int getColumnType()

Description copied from interface: ColumnMetaData

Returns column type from java.sql.Types.

Specified by:

getColumnType in interface ColumnMetaData

Returns:

java.sql.Types constant

See Also:

Types

getColumnTypeName

public String getColumnTypeName()

Description copied from interface: ColumnMetaData

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

Specified by:

getColumnTypeName in interface ColumnMetaData

getDatabaseName

public String getDatabaseName()

Description copied from interface: ColumnMetaData

Returns database name.

Specified by:

getDatabaseName in interface ColumnMetaData

getQualifiedColumnLabel

public String getQualifiedColumnLabel()

Description copied from interface: ColumnMetaData

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.

Specified by:

getQualifiedColumnLabel in interface ColumnMetaData

getQualifiedColumnName

public String getQualifiedColumnName()

Description copied from interface: ColumnMetaData

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.

Specified by:

getQualifiedColumnName in interface ColumnMetaData

getQualifiedTableName

public String getQualifiedTableName()

Description copied from interface: ColumnMetaData

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.

Specified by:

getQualifiedTableName in interface ColumnMetaData

getResultByLabel

public Object getResultByLabel(ResultSet resultSet)
                        throws SQLException

Description copied from interface: ColumnMetaData

Returns object from result set using the column label.

Specified by:

getResultByLabel in interface ColumnMetaData

Throws:

SQLException

getResultByNumber

public Object getResultByNumber(ResultSet resultSet)
                         throws SQLException

Description copied from interface: ColumnMetaData

Returns object from result set using the column number.

Specified by:

getResultByNumber in interface ColumnMetaData

Throws:

SQLException

getSequenceName

public String getSequenceName()

Description copied from interface: ColumnMetaData

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

Specified by:

getSequenceName in interface ColumnMetaData

getTableName

public String getTableName()

Description copied from interface: ColumnMetaData

Returns table name.

Specified by:

getTableName in interface ColumnMetaData

getTableRole

public TableMetaData.TableRole getTableRole()

Description copied from interface: ColumnMetaData

Returns role of table in the SQL Resource.

Specified by:

getTableRole in interface ColumnMetaData

isBinaryType

public boolean isBinaryType()

Description copied from interface: ColumnMetaData

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

Specified by:

isBinaryType in interface ColumnMetaData

isCharOrDateTimeType

public boolean isCharOrDateTimeType()

Description copied from interface: ColumnMetaData

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

Specified by:

isCharOrDateTimeType in interface ColumnMetaData

isNonqueriedForeignKey

public boolean isNonqueriedForeignKey()

Description copied from interface: ColumnMetaData

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.

Specified by:

isNonqueriedForeignKey in interface ColumnMetaData

isPrimaryKey

public boolean isPrimaryKey()

Description copied from interface: ColumnMetaData

Returns true if the column is a primary key.

Specified by:

isPrimaryKey in interface ColumnMetaData

isReadOnly

public boolean isReadOnly()

Description copied from interface: ColumnMetaData

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

Specified by:

isReadOnly in interface ColumnMetaData

isSequence

public boolean isSequence()

Description copied from interface: ColumnMetaData

Returns true if column is associated with a sequence.

Specified by:

isSequence in interface ColumnMetaData

See Also:

ColumnMetaData.getSequenceName()

normalizeValue

public void normalizeValue(RequestValue requestValue)
                    throws InvalidRequestException

Description copied from interface: ColumnMetaData

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

Specified by:

normalizeValue in interface ColumnMetaData

Parameters:

requestValue - parameter or resource identifier

Throws:

InvalidRequestException - if conversion failed

setAttributes

public 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.

Specified by:

setAttributes in interface ColumnMetaData

setAttributes

public 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.

Specified by:

setAttributes in interface ColumnMetaData

setPrimaryKey

public void setPrimaryKey(boolean primaryKey)

Description copied from interface: ColumnMetaData

Sets primary key.

Specified by:

setPrimaryKey in interface ColumnMetaData

setSequence

public void setSequence(boolean sequence)

Description copied from interface: ColumnMetaData

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

Specified by:

setSequence in interface ColumnMetaData

setSequenceName

public void setSequenceName(String sequenceName)

Description copied from interface: ColumnMetaData

Sets sequence name.

Specified by:

setSequenceName in interface ColumnMetaData

setTableRole

public void setTableRole(TableMetaData.TableRole tableRole)

Description copied from interface: ColumnMetaData

Sets table role.

Specified by:

setTableRole in interface ColumnMetaData

getColumnType

protected int getColumnType(int columnType,
                String columnTypeName)

Method for subclasses to customize column type if desired.

Returns:

one of the constants in {java.sql.Types}

See Also:

Types