org.restsql.core

Interface TableMetaData

public interface TableMetaData

Encapsulates table information for an SQL Resource.

Author:

Mark Sawers

See Also:

SqlResource, ColumnMetaData

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TableMetaData.TableRole Represents all of the roles a table may plan in a SQL Resource.

Method Summary

Methods

Modifier and Type	Method and Description
void	addColumn(ColumnMetaData column) Adds normal column.
void	addPrimaryKey(ColumnMetaData column) Adds primary key column.
Map<String,ColumnMetaData>	getColumns() Returns map of column meta data, keyed by the column label (the alias if provided in the query, otherwise the name).
String	getDatabaseName() Returns database name.
List<ColumnMetaData>	getPrimaryKeys() Returns ordered list of columns that are primary keys.
String	getQualifiedTableName() Returns fully qualified table name in database-specific form for use in SQL statements.
String	getRowAlias() Returns row alias.
String	getRowSetAlias() Returns row set alias.
String	getTableAlias() Deprecated. As of 0.8.11 use getRowAlias()
String	getTableName() Returns table name.
TableMetaData.TableRole	getTableRole() Returns role of table in the SQL Resource.
boolean	isChild() Returns true if the SQL Resource role is child.
boolean	isParent() Returns true if the SQL Resource role is parent.
void	setAliases(String alias, String rowAlias, String rowSetAlias) Sets all the row and row set aliases.
void	setAttributes(String tableName, String qualifedTableName, String databaseName, TableMetaData.TableRole tableRole) Sets attributes.
void	setTableAlias(String tableAlias) Deprecated. As of 0.8.11 use setAliases(String, String, String)

Method Detail

addColumn

void addColumn(ColumnMetaData column)

Adds normal column.

addPrimaryKey

void addPrimaryKey(ColumnMetaData column)

Adds primary key column.

getColumns

Map<String,ColumnMetaData> getColumns()

Returns map of column meta data, keyed by the column label (the alias if provided in the query, otherwise the name).

getDatabaseName

String getDatabaseName()

Returns database name.

getPrimaryKeys

List<ColumnMetaData> getPrimaryKeys()

Returns ordered list of columns that are primary keys.

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.

getRowAlias

String getRowAlias()

Returns row alias.

getRowSetAlias

String getRowSetAlias()

Returns row set alias.

getTableAlias

@Deprecated
String getTableAlias()

Deprecated. As of 0.8.11 use getRowAlias()

Returns row alias.

getTableName

String getTableName()

Returns table name.

getTableRole

TableMetaData.TableRole getTableRole()

Returns role of table in the SQL Resource.

isChild

boolean isChild()

Returns true if the SQL Resource role is child.

isParent

boolean isParent()

Returns true if the SQL Resource role is parent.

setAliases

void setAliases(String alias,
              String rowAlias,
              String rowSetAlias)

Sets all the row and row set aliases.

setAttributes

void setAttributes(String tableName,
                 String qualifedTableName,
                 String databaseName,
                 TableMetaData.TableRole tableRole)

Sets attributes.

setTableAlias

@Deprecated
void setTableAlias(String tableAlias)

Deprecated. As of 0.8.11 use setAliases(String, String, String)

Sets table alias.