org.hibernate.metamodel.relational

Interface TableSpecification

All Superinterfaces:

Loggable, ValueContainer

All Known Implementing Classes:

AbstractTableSpecification, InLineView, Table

public interface TableSpecification
extends ValueContainer, Loggable

Models what ANSI SQL terms a table specification which is a table or a view or an inline view.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCheckConstraint(java.lang.String checkCondition)
void	addComment(java.lang.String comment)
ForeignKey	createForeignKey(TableSpecification targetTable, java.lang.String name)
Tuple	createTuple(java.lang.String name) Factory method for creating a Column associated with this container.
java.lang.Iterable<CheckConstraint>	getCheckConstraints()
java.lang.Iterable<java.lang.String>	getComments()
java.lang.Iterable<ForeignKey>	getForeignKeys()
java.lang.Iterable<Index>	getIndexes()
Index	getOrCreateIndex(java.lang.String name)
UniqueKey	getOrCreateUniqueKey(java.lang.String name)
PrimaryKey	getPrimaryKey() Get the primary key definition for this table spec.
java.lang.String	getQualifiedName(Dialect dialect)
Schema	getSchema() Obtain a reference to the schema to which this table specification belongs.
int	getTableNumber() Get the table number.
java.lang.Iterable<UniqueKey>	getUniqueKeys()
Column	locateOrCreateColumn(java.lang.String name) Factory method for creating a Column associated with this container.
DerivedValue	locateOrCreateDerivedValue(java.lang.String fragment) Factory method for creating a DerivedValue associated with this container.

Methods inherited from interface org.hibernate.metamodel.relational.ValueContainer

getLoggableValueQualifier, values

Methods inherited from interface org.hibernate.metamodel.relational.Loggable

toLoggableString

Method Detail

getSchema

Schema getSchema()

Obtain a reference to the schema to which this table specification belongs.

Returns:

The schema to which this table specification belongs.

getTableNumber

int getTableNumber()

Get the table number.

Returns:

the table number.

getPrimaryKey

PrimaryKey getPrimaryKey()

Get the primary key definition for this table spec.

Returns:

The PK definition.

locateOrCreateColumn

Column locateOrCreateColumn(java.lang.String name)

Factory method for creating a Column associated with this container.

Parameters:

name - The column name

Returns:

The generated column

createTuple

Tuple createTuple(java.lang.String name)

Factory method for creating a Column associated with this container.

Parameters:

name - The column name

Returns:

The generated column

locateOrCreateDerivedValue

DerivedValue locateOrCreateDerivedValue(java.lang.String fragment)

Factory method for creating a DerivedValue associated with this container.

Parameters:

fragment - The value expression

Returns:

The generated value.

getForeignKeys

java.lang.Iterable<ForeignKey> getForeignKeys()

createForeignKey

ForeignKey createForeignKey(TableSpecification targetTable,
                          java.lang.String name)

getIndexes

java.lang.Iterable<Index> getIndexes()

getOrCreateIndex

Index getOrCreateIndex(java.lang.String name)

getUniqueKeys

java.lang.Iterable<UniqueKey> getUniqueKeys()

getOrCreateUniqueKey

UniqueKey getOrCreateUniqueKey(java.lang.String name)

getCheckConstraints

java.lang.Iterable<CheckConstraint> getCheckConstraints()

addCheckConstraint

void addCheckConstraint(java.lang.String checkCondition)

getComments

java.lang.Iterable<java.lang.String> getComments()

addComment

void addComment(java.lang.String comment)

getQualifiedName

java.lang.String getQualifiedName(Dialect dialect)