Top Description Methods
org.hibernate.tool.schema.extract.spi

public Interface TableInformation

Known Direct Implementers
org.hibernate.tool.schema.extract.internal.TableInformationImpl
Imports
org.hibernate.boot.model.naming.Identifier, org.hibernate.boot.model.relational.QualifiedTableName
Provides access to information about existing tables in the database
Authors
Christoph Sturm, Max Rydahl Andersen, Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public void
addColumn(ColumnInformation columnIdentifier)

public ColumnInformation

Returns:

The matching column information. May return null
getColumn(Identifier
The column identifier (simple name)
columnIdentifier)

Retrieve the named ColumnInformation

public String

Returns:

The table comments
getComment()

Get the comments/remarks defined for the table.

public ForeignKeyInformation

Returns:

The matching foreign key information. May return null
getForeignKey(Identifier
The foreign key identifier (simple name)
keyName)

Retrieve the named ForeignKeyInformation

public Iterable<ForeignKeyInformation>

Returns:

The iterable.
getForeignKeys()

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

public IndexInformation

Returns:

The matching index information. May return null
getIndex(Identifier
The index identifier (simple name)
indexName)

Retrieve the named IndexInformation

public Iterable<IndexInformation>

Returns:

The iterable.
getIndexes()

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

public QualifiedTableName

Returns:

The qualified table name
getName()

Get the qualified name of the table.

public PrimaryKeyInformation

Returns:

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

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

public boolean

Returns:

true if this is a physical table; false otherwise.
isPhysicalTable()

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

Method Detail

addColumnback to summary
public void addColumn(ColumnInformation columnIdentifier)
getColumnback to summary
public ColumnInformation getColumn(Identifier columnIdentifier)

Retrieve the named ColumnInformation

Parameters
columnIdentifier:Identifier

The column identifier (simple name)

Returns:ColumnInformation

The matching column information. May return null

getCommentback to summary
public String getComment()

Get the comments/remarks defined for the table.

Returns:String

The table comments

getForeignKeyback to summary
public ForeignKeyInformation getForeignKey(Identifier keyName)

Retrieve the named ForeignKeyInformation

Parameters
keyName:Identifier

The foreign key identifier (simple name)

Returns:ForeignKeyInformation

The matching foreign key information. May return null

getForeignKeysback to summary
public Iterable<ForeignKeyInformation> getForeignKeys()

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

Returns:Iterable<ForeignKeyInformation>

The iterable.

getIndexback to summary
public IndexInformation getIndex(Identifier indexName)

Retrieve the named IndexInformation

Parameters
indexName:Identifier

The index identifier (simple name)

Returns:IndexInformation

The matching index information. May return null

getIndexesback to summary
public Iterable<IndexInformation> getIndexes()

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

Returns:Iterable<IndexInformation>

The iterable.

getNameback to summary
public QualifiedTableName getName()

Get the qualified name of the table.

Returns:QualifiedTableName

The qualified table name

getPrimaryKeyback to summary
public PrimaryKeyInformation getPrimaryKey()

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

Returns:PrimaryKeyInformation

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

isPhysicalTableback to summary
public boolean isPhysicalTable()

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

Returns:boolean

true if this is a physical table; false otherwise.