org.apache.metamodel.schema

Interface Table

All Superinterfaces:

Comparable<Table>, HasName, NamedStructure, Serializable

All Known Subinterfaces:

WrappingTable

All Known Implementing Classes:

AbstractTable, AliasTable, MutableTable

@InterfaceStability.Stable
public interface Table
extends Comparable<Table>, Serializable, NamedStructure

Represents a table and it's metadata description. Tables reside within a schema and contains columns and relationships to other tables.

See Also:

Schema, Column

Method Summary

Modifier and Type	Method and Description
List<Column>	getBooleanColumns() Gets all of this table's columns that are of boolean type.
Column	getColumn(int index) Gets a column by index.
Column	getColumnByName(String columnName) Convenience method for retrieving a column by it's name.
int	getColumnCount() Gets the number of columns in this table.
List<String>	getColumnNames() Gets the names of this table's columns.
List<Column>	getColumns() Gets the columns of this table.
List<Column>	getColumnsOfSuperType(SuperColumnType superColumnType) Gets the columns of this table that conforms to a specified SuperColumnType.
List<Column>	getColumnsOfType(ColumnType columnType) Gets the columns of this table that conforms to a specified ColumnType.
Collection<Relationship>	getForeignKeyRelationships()
List<Column>	getForeignKeys() Gets the columns of this table that are known to be foreign keys (ie.
List<Column>	getIndexedColumns() Gets all of this table's columns that are indexed.
List<Column>	getLiteralColumns() Gets all of this table's columns that are of literal (String/text) type.
String	getName() Gets the name of this Table
List<Column>	getNumberColumns() Gets all of this table's columns that are of number type.
Collection<Relationship>	getPrimaryKeyRelationships()
List<Column>	getPrimaryKeys() Gets the columns of this table that are known to be primary keys.
int	getRelationshipCount() Gets a count of relationships to and from this table.
Collection<Relationship>	getRelationships() Gets all relationships for this table.
Collection<Relationship>	getRelationships(Table otherTable) Gets relationships between this table and another table.
String	getRemarks() Gets remarks/comments to this table.
Schema	getSchema() Gets the schema that this table resides in.
List<Column>	getTimeBasedColumns() Gets all of this table's columns that are time and/or date based.
TableType	getType() Gets the table type of this table.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.apache.metamodel.schema.NamedStructure

getQualifiedLabel, getQuote, getQuotedName

Method Detail

getName

String getName()

Gets the name of this Table

Specified by:

getName in interface HasName

Specified by:

getName in interface NamedStructure

Returns:

the name of this Table

getColumnCount

int getColumnCount()

Gets the number of columns in this table.

Returns:

the number of columns in this table.

getColumns

List<Column> getColumns()

Gets the columns of this table.

Returns:

the columns of this table.

getColumnByName

Column getColumnByName(String columnName)

Convenience method for retrieving a column by it's name.

Parameters:

columnName - the name of the column to retrieve

Returns:

the column with the given name. Returns null if no such column is found.

getColumn

Column getColumn(int index)
          throws IndexOutOfBoundsException

Gets a column by index. Use getColumnCount() to get the (0-based) index range.

Parameters:

index - the index of the column

Returns:

the column with the specified index

Throws:

IndexOutOfBoundsException - if the index is out of bounds (index >= column count)

getSchema

Schema getSchema()

Gets the schema that this table resides in.

Returns:

the schema that the table resides in.

getType

TableType getType()

Gets the table type of this table.

Returns:

the type of table

getRelationships

Collection<Relationship> getRelationships()

Gets all relationships for this table.

Returns:

all relationsips for this table. To add relations use TableRelation.createRelation();

getRelationships

Collection<Relationship> getRelationships(Table otherTable)

Gets relationships between this table and another table.

Parameters:

otherTable - another table for which to find relationships to and from.

Returns:

an array of relationsips between this and the other table.

getRelationshipCount

int getRelationshipCount()

Gets a count of relationships to and from this table.

Returns:

a count of relationships to and from this table.

getRemarks

String getRemarks()

Gets remarks/comments to this table.

Returns:

remarks/comments to this table or null if none exist.

getNumberColumns

List<Column> getNumberColumns()

Gets all of this table's columns that are of number type.

Returns:

an array of columns.

See Also:

ColumnType

getLiteralColumns

List<Column> getLiteralColumns()

Gets all of this table's columns that are of literal (String/text) type.

Returns:

an array of columns.

See Also:

ColumnType

getTimeBasedColumns

List<Column> getTimeBasedColumns()

Gets all of this table's columns that are time and/or date based.

Returns:

an array of columns.

See Also:

ColumnType

getBooleanColumns

List<Column> getBooleanColumns()

Gets all of this table's columns that are of boolean type.

Returns:

an array of columns.

See Also:

ColumnType

getIndexedColumns

List<Column> getIndexedColumns()

Gets all of this table's columns that are indexed.

Returns:

an array of columns.

getForeignKeyRelationships

Collection<Relationship> getForeignKeyRelationships()

Returns:

the relationships where this table is the foreign table

getPrimaryKeyRelationships

Collection<Relationship> getPrimaryKeyRelationships()

Returns:

the relationships where this table is the primary table

getForeignKeys

List<Column> getForeignKeys()

Gets the columns of this table that are known to be foreign keys (ie. references primary keys in other tables).

Returns:

an array of columns that are known to be foreign keys.

getPrimaryKeys

List<Column> getPrimaryKeys()

Gets the columns of this table that are known to be primary keys. See Column.isPrimaryKey().

Returns:

an array of columns that are known to be primary keys.

getColumnNames

List<String> getColumnNames()

Gets the names of this table's columns.

Returns:

an array of column names.

getColumnsOfType

List<Column> getColumnsOfType(ColumnType columnType)

Gets the columns of this table that conforms to a specified ColumnType.

Parameters:

columnType - the column type to search for.

Returns:

an array of columns that match the specified ColumnType.

getColumnsOfSuperType

List<Column> getColumnsOfSuperType(SuperColumnType superColumnType)

Gets the columns of this table that conforms to a specified SuperColumnType.

Parameters:

superColumnType - the super type of the column

Returns:

an array of columns that match the specified SuperColumnType.