org.restsql.core

Interface ColumnMetaData

All Known Implementing Classes:

ColumnMetaDataImpl

public interface 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
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 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	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.
String	getTableName() Returns table name.
TableMetaData.TableRole	getTableRole() Returns role of table in the SQL Resource.
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.

Method Detail

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

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.

getTableName

String getTableName()

Returns table name.

getTableRole

TableMetaData.TableRole getTableRole()

Returns role of table in the SQL Resource.

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.