org.hibernate.tool.schema.extract.internal

Class TableInformationImpl

java.lang.Object

org.hibernate.tool.schema.extract.internal.TableInformationImpl

All Implemented Interfaces:

TableInformation

public class TableInformationImpl
extends java.lang.Object
implements TableInformation

Provides access to information about existing schema objects (tables, sequences etc) of existing database.

Constructor Summary

Constructors

Constructor and Description
TableInformationImpl(InformationExtractor extractor, IdentifierHelper identifierHelper, QualifiedTableName tableName, boolean physicalTable, java.lang.String comment)

Method Summary

Modifier and Type	Method and Description
void	addColumn(ColumnInformation columnIdentifier)
protected java.util.Map<Identifier,ForeignKeyInformation>	foreignKeys()
ColumnInformation	getColumn(Identifier columnIdentifier) Retrieve the named ColumnInformation
java.lang.String	getComment() Get the comments/remarks defined for the table.
ForeignKeyInformation	getForeignKey(Identifier fkIdentifier) Retrieve the named ForeignKeyInformation
java.lang.Iterable<ForeignKeyInformation>	getForeignKeys() Obtain an iterable over all the table's defined foreign keys.
IndexInformation	getIndex(Identifier indexName) Retrieve the named IndexInformation
java.lang.Iterable<IndexInformation>	getIndexes() Obtain an iterable over all the table's defined indexes.
QualifiedTableName	getName() Get the qualified name of the table.
PrimaryKeyInformation	getPrimaryKey() Retrieve information about the table's primary key, if one is defined (aka, may return null).
protected java.util.Map<Identifier,IndexInformation>	indexes()
boolean	isPhysicalTable() Does this information describe a physical table as opposed to a view, etc?
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TableInformationImpl

public TableInformationImpl(InformationExtractor extractor,
                            IdentifierHelper identifierHelper,
                            QualifiedTableName tableName,
                            boolean physicalTable,
                            java.lang.String comment)

Method Detail

getName

public QualifiedTableName getName()

Description copied from interface: TableInformation

Get the qualified name of the table.

Specified by:

getName in interface TableInformation

Returns:

The qualified table name

isPhysicalTable

public boolean isPhysicalTable()

Description copied from interface: TableInformation

Does this information describe a physical table as opposed to a view, etc?

Specified by:

isPhysicalTable in interface TableInformation

Returns:

true if this is a physical table; false otherwise.

getComment

public java.lang.String getComment()

Description copied from interface: TableInformation

Get the comments/remarks defined for the table.

Specified by:

getComment in interface TableInformation

Returns:

The table comments

getColumn

public ColumnInformation getColumn(Identifier columnIdentifier)

Description copied from interface: TableInformation

Retrieve the named ColumnInformation

Specified by:

getColumn in interface TableInformation

Parameters:

columnIdentifier - The column identifier (simple name)

Returns:

The matching column information. May return null

getPrimaryKey

public PrimaryKeyInformation getPrimaryKey()

Description copied from interface: TableInformation

Retrieve information about the table's primary key, if one is defined (aka, may return null).

Specified by:

getPrimaryKey in interface TableInformation

Returns:

The primary key information, or null if the table did not define a primary key.

getForeignKeys

public java.lang.Iterable<ForeignKeyInformation> getForeignKeys()

Description copied from interface: TableInformation

Obtain an iterable over all the table's defined foreign keys.

Specified by:

getForeignKeys in interface TableInformation

Returns:

The iterable.

foreignKeys

protected java.util.Map<Identifier,ForeignKeyInformation> foreignKeys()

getForeignKey

public ForeignKeyInformation getForeignKey(Identifier fkIdentifier)

Description copied from interface: TableInformation

Retrieve the named ForeignKeyInformation

Specified by:

getForeignKey in interface TableInformation

Parameters:

fkIdentifier - The foreign key identifier (simple name)

Returns:

The matching foreign key information. May return null

getIndexes

public java.lang.Iterable<IndexInformation> getIndexes()

Description copied from interface: TableInformation

Obtain an iterable over all the table's defined indexes.

Specified by:

getIndexes in interface TableInformation

Returns:

The iterable.

indexes

protected java.util.Map<Identifier,IndexInformation> indexes()

addColumn

public void addColumn(ColumnInformation columnIdentifier)

Specified by:

addColumn in interface TableInformation

getIndex

public IndexInformation getIndex(Identifier indexName)

Description copied from interface: TableInformation

Retrieve the named IndexInformation

Specified by:

getIndex in interface TableInformation

Parameters:

indexName - The index identifier (simple name)

Returns:

The matching index information. May return null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object