org.restsql.core.impl

Class TableMetaDataImpl

java.lang.Object

org.restsql.core.impl.TableMetaDataImpl

All Implemented Interfaces:

TableMetaData

public class TableMetaDataImpl
extends Object
implements TableMetaData

Encapsulates table information for an SQL Resource.

Author:

Mark Sawers

See Also:

ColumnMetaData

Nested Class Summary

Nested classes/interfaces inherited from interface org.restsql.core.TableMetaData

TableMetaData.TableRole

Constructor Summary

Constructors

Constructor and Description
TableMetaDataImpl()

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)

Methods inherited from class java.lang.Object

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

Constructor Detail

TableMetaDataImpl

public TableMetaDataImpl()

Method Detail

addColumn

public void addColumn(ColumnMetaData column)

Description copied from interface: TableMetaData

Adds normal column.

Specified by:

addColumn in interface TableMetaData

addPrimaryKey

public void addPrimaryKey(ColumnMetaData column)

Description copied from interface: TableMetaData

Adds primary key column.

Specified by:

addPrimaryKey in interface TableMetaData

getColumns

public Map<String,ColumnMetaData> getColumns()

Description copied from interface: TableMetaData

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

Specified by:

getColumns in interface TableMetaData

getDatabaseName

public String getDatabaseName()

Description copied from interface: TableMetaData

Returns database name.

Specified by:

getDatabaseName in interface TableMetaData

getPrimaryKeys

public List<ColumnMetaData> getPrimaryKeys()

Description copied from interface: TableMetaData

Returns ordered list of columns that are primary keys.

Specified by:

getPrimaryKeys in interface TableMetaData

getQualifiedTableName

public String getQualifiedTableName()

Description copied from interface: TableMetaData

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 TableMetaData

getRowAlias

public String getRowAlias()

Description copied from interface: TableMetaData

Returns row alias.

Specified by:

getRowAlias in interface TableMetaData

getRowSetAlias

public String getRowSetAlias()

Description copied from interface: TableMetaData

Returns row set alias.

Specified by:

getRowSetAlias in interface TableMetaData

getTableAlias

@Deprecated
public String getTableAlias()

Deprecated. As of 0.8.11 use getRowAlias()

Returns row alias.

Specified by:

getTableAlias in interface TableMetaData

getTableName

public String getTableName()

Description copied from interface: TableMetaData

Returns table name.

Specified by:

getTableName in interface TableMetaData

getTableRole

public TableMetaData.TableRole getTableRole()

Description copied from interface: TableMetaData

Returns role of table in the SQL Resource.

Specified by:

getTableRole in interface TableMetaData

isChild

public boolean isChild()

Description copied from interface: TableMetaData

Returns true if the SQL Resource role is child.

Specified by:

isChild in interface TableMetaData

isParent

public boolean isParent()

Description copied from interface: TableMetaData

Returns true if the SQL Resource role is parent.

Specified by:

isParent in interface TableMetaData

setAttributes

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

Description copied from interface: TableMetaData

Sets attributes.

Specified by:

setAttributes in interface TableMetaData

setAliases

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

Description copied from interface: TableMetaData

Sets all the row and row set aliases.

Specified by:

setAliases in interface TableMetaData

setTableAlias

@Deprecated
public void setTableAlias(String tableAlias)

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

Description copied from interface: TableMetaData

Sets table alias.

Specified by:

setTableAlias in interface TableMetaData