Class Table

java.lang.Object

org.hibernate.mapping.Table

All Implemented Interfaces:

Serializable, ContributableDatabaseObject, Exportable, Contributable

Direct Known Subclasses:

DenormalizedTable

public class Table
extends Object
implements Serializable, ContributableDatabaseObject

A mapping model object representing a relational database table.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Table()	Deprecated, for removal: This API element is subject to removal in a future version.
Table(String contributor)
Table(String contributor, String name)
Table(String contributor, Namespace namespace, String subselect, boolean isAbstract)
Table(String contributor, Namespace namespace, Identifier physicalTableName, boolean isAbstract)
Table(String contributor, Namespace namespace, Identifier physicalTableName, String subselect, boolean isAbstract)

Method Summary

Modifier and Type	Method	Description
void	addCheck(CheckConstraint check)
void	addColumn(Column column)
Index	addIndex(Index index)
void	addInitCommand(Function<SqlStringGenerationContext, InitCommand> commandProducer)
void	addInitCommand(InitCommand command)	Deprecated. Use addInitCommand(Function) instead.
void	addResetCommand(Function<SqlStringGenerationContext, InitCommand> commandProducer)
void	addResyncCommand(BiFunction<SqlStringGenerationContext, DdlTransactionIsolator, InitCommand> commandProducer)
UniqueKey	addUniqueKey(UniqueKey uniqueKey)
void	columnRenamed(Column column)
boolean	containsColumn(Column column)
ForeignKey	createForeignKey(String keyName, List<Column> keyColumns, String referencedEntityName, String keyDefinition, String options)
ForeignKey	createForeignKey(String keyName, List<Column> keyColumns, String referencedEntityName, String keyDefinition, String options, List<Column> referencedColumns)
void	createForeignKeys(MetadataBuildingContext context)
void	createUniqueKey(List<Column> keyColumns, MetadataBuildingContext context)	If there is one given column, mark it unique, otherwise create a UniqueKey comprising the given columns.
void	createUniqueKey(Column column, MetadataBuildingContext context)	Mark the given column unique and assign a name to the unique key.
boolean	equals(Object object)
boolean	equals(Table table)
String	getCatalog()
Identifier	getCatalogIdentifier()
List<CheckConstraint>	getChecks()
Column	getColumn(int n)
Column	getColumn(Identifier name)
Column	getColumn(InFlightMetadataCollector collector, String logicalName)
Column	getColumn(Column column)	Return the column which is identified by column provided as argument.
Collection<Column>	getColumns()
int	getColumnSpan()
String	getComment()
String	getContributor()	The name of the contributor which contributed this
String	getExportIdentifier()	Get a unique identifier to make sure we are not exporting the same database structure multiple times.
String	getExtraDeclarations()
Collection<ForeignKey>	getForeignKeyCollection()
Collection<ForeignKey>	getForeignKeys()
Index	getIndex(String indexName)
Map<String,Index>	getIndexes()
List<InitCommand>	getInitCommands(SqlStringGenerationContext context)
String	getName()
Identifier	getNameIdentifier()
String	getOptions()
Index	getOrCreateIndex(String indexName)
UniqueKey	getOrCreateUniqueKey(String keyName)
PrimaryKey	getPrimaryKey()
String	getQualifiedName(SqlStringGenerationContext context)
QualifiedTableName	getQualifiedTableName()
String	getQuotedCatalog()
String	getQuotedCatalog(Dialect dialect)
String	getQuotedName()
String	getQuotedName(Dialect dialect)
String	getQuotedSchema()
String	getQuotedSchema(Dialect dialect)
List<InitCommand>	getResetCommands(SqlStringGenerationContext context)
List<InitCommand>	getResyncCommands(SqlStringGenerationContext context, DdlTransactionIsolator isolator)
String	getRowId()
String	getSchema()
Identifier	getSchemaIdentifier()
String	getSubselect()
String	getType()
int	getUniqueInteger()
UniqueKey	getUniqueKey(String keyName)
Map<String, UniqueKey>	getUniqueKeys()
String	getViewQuery()
boolean	hasDenormalizedTables()
int	hashCode()
boolean	hasPrimaryKey()
boolean	isAbstract()
boolean	isAbstractUnionTable()
boolean	isCatalogQuoted()
boolean	isPhysicalTable()
boolean	isPrimaryKey(Column column)
boolean	isQuoted()
boolean	isRedundantUniqueKey(UniqueKey uniqueKey)
boolean	isSchemaQuoted()
boolean	isSubselect()
boolean	isView()
static String	qualify(String catalog, String schema, String table)	Deprecated. Should build a QualifiedTableName then use SqlStringGenerationContext.format(QualifiedTableName).
void	reorderColumns(List<Column> columns)
void	setAbstract(boolean isAbstract)
void	setCatalog(String catalog)
void	setComment(String comment)
void	setExtraDeclarations(String extraDeclarations)
void	setName(String name)
void	setOptions(String options)
void	setPrimaryKey(PrimaryKey primaryKey)
void	setQuoted(boolean quoted)
void	setRowId(String rowId)
void	setSchema(String schema)
void	setSubselect(String subselect)
void	setType(String type)
void	setUniqueInteger(int uniqueInteger)
void	setViewQuery(String viewQuery)
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Table

@Deprecated(since="6.2",
            forRemoval=true)
public Table()

Deprecated, for removal: This API element is subject to removal in a future version.

Table

public Table(String contributor)

Table

public Table(String contributor,
 String name)

Table

public Table(String contributor,
 Namespace namespace,
 Identifier physicalTableName,
 boolean isAbstract)

Table

public Table(String contributor,
 Namespace namespace,
 Identifier physicalTableName,
 String subselect,
 boolean isAbstract)

Table

public Table(String contributor,
 Namespace namespace,
 String subselect,
 boolean isAbstract)

Method Details

getContributor

public String getContributor()

Description copied from interface: Contributable

The name of the contributor which contributed this

Specified by:

getContributor in interface Contributable

getQualifiedName

public String getQualifiedName(SqlStringGenerationContext context)

qualify

@Deprecated
public static String qualify(String catalog,
 String schema,
 String table)

Deprecated.

Should build a QualifiedTableName then use SqlStringGenerationContext.format(QualifiedTableName).

setName

public void setName(String name)

getName

public String getName()

getNameIdentifier

public Identifier getNameIdentifier()

getSchemaIdentifier

public Identifier getSchemaIdentifier()

getCatalogIdentifier

public Identifier getCatalogIdentifier()

getQuotedName

public String getQuotedName()

getQuotedName

public String getQuotedName(Dialect dialect)

getQualifiedTableName

public QualifiedTableName getQualifiedTableName()

isQuoted

public boolean isQuoted()

setQuoted

public void setQuoted(boolean quoted)

setSchema

public void setSchema(String schema)

getSchema

public String getSchema()

getQuotedSchema

public String getQuotedSchema()

getQuotedSchema

public String getQuotedSchema(Dialect dialect)

isSchemaQuoted

public boolean isSchemaQuoted()

setCatalog

public void setCatalog(String catalog)

getCatalog

public String getCatalog()

getQuotedCatalog

public String getQuotedCatalog()

getQuotedCatalog

public String getQuotedCatalog(Dialect dialect)

isCatalogQuoted

public boolean isCatalogQuoted()

getColumn

public Column getColumn(Column column)

Return the column which is identified by column provided as argument.

Parameters:

column - column with at least a name.

Returns:

the underlying column or null if not inside this table. Note: the instance *can* be different than the input parameter, but the name will be the same.

getColumn

public Column getColumn(Identifier name)

getColumn

@Internal
public Column getColumn(InFlightMetadataCollector collector,
 String logicalName)

getColumn

public Column getColumn(int n)

addColumn

public void addColumn(Column column)

columnRenamed

@Internal
public void columnRenamed(Column column)

getColumnSpan

public int getColumnSpan()

getColumns

public Collection<Column> getColumns()

getIndexes

public Map<String,Index> getIndexes()

getForeignKeyCollection

@Incubating
public Collection<ForeignKey> getForeignKeyCollection()

getForeignKeys

public Collection<ForeignKey> getForeignKeys()

getUniqueKeys

public Map<String, UniqueKey> getUniqueKeys()

isRedundantUniqueKey

public boolean isRedundantUniqueKey(UniqueKey uniqueKey)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

equals

public boolean equals(Table table)

isPrimaryKey

public boolean isPrimaryKey(Column column)

hasPrimaryKey

public boolean hasPrimaryKey()

getPrimaryKey

public PrimaryKey getPrimaryKey()

setPrimaryKey

public void setPrimaryKey(PrimaryKey primaryKey)

getOrCreateIndex

public Index getOrCreateIndex(String indexName)

getIndex

public Index getIndex(String indexName)

addIndex

public Index addIndex(Index index)

addUniqueKey

public UniqueKey addUniqueKey(UniqueKey uniqueKey)

createUniqueKey

public void createUniqueKey(Column column,
 MetadataBuildingContext context)

Mark the given column unique and assign a name to the unique key.

This method does not add a UniqueKey to the table itself!

createUniqueKey

public void createUniqueKey(List<Column> keyColumns,
 MetadataBuildingContext context)

If there is one given column, mark it unique, otherwise create a UniqueKey comprising the given columns.

getUniqueKey

public UniqueKey getUniqueKey(String keyName)

getOrCreateUniqueKey

public UniqueKey getOrCreateUniqueKey(String keyName)

createForeignKeys

public void createForeignKeys(MetadataBuildingContext context)

createForeignKey

public ForeignKey createForeignKey(String keyName,
 List<Column> keyColumns,
 String referencedEntityName,
 String keyDefinition,
 String options)

createForeignKey

public ForeignKey createForeignKey(String keyName,
 List<Column> keyColumns,
 String referencedEntityName,
 String keyDefinition,
 String options,
 List<Column> referencedColumns)

setUniqueInteger

public void setUniqueInteger(int uniqueInteger)

getUniqueInteger

public int getUniqueInteger()

addCheck

public void addCheck(CheckConstraint check)

containsColumn

public boolean containsColumn(Column column)

getRowId

public String getRowId()

setRowId

public void setRowId(String rowId)

toString

public String toString()

Overrides:

toString in class Object

getSubselect

public String getSubselect()

setSubselect

public void setSubselect(String subselect)

isSubselect

public boolean isSubselect()

isAbstractUnionTable

public boolean isAbstractUnionTable()

hasDenormalizedTables

public boolean hasDenormalizedTables()

setAbstract

public void setAbstract(boolean isAbstract)

isAbstract

public boolean isAbstract()

isPhysicalTable

public boolean isPhysicalTable()

isView

public boolean isView()

getComment

public String getComment()

setComment

public void setComment(String comment)

getChecks

public List<CheckConstraint> getChecks()

getExportIdentifier

public String getExportIdentifier()

Description copied from interface: Exportable

Get a unique identifier to make sure we are not exporting the same database structure multiple times.

Specified by:

getExportIdentifier in interface Exportable

Returns:

The exporting identifier.

reorderColumns

@Internal
public void reorderColumns(List<Column> columns)

getViewQuery

public String getViewQuery()

setViewQuery

public void setViewQuery(String viewQuery)

addInitCommand

@Deprecated
public void addInitCommand(InitCommand command)

Deprecated.

Use addInitCommand(Function) instead.

addInitCommand

public void addInitCommand(Function<SqlStringGenerationContext, InitCommand> commandProducer)

getInitCommands

public List<InitCommand> getInitCommands(SqlStringGenerationContext context)

addResyncCommand

public void addResyncCommand(BiFunction<SqlStringGenerationContext, DdlTransactionIsolator, InitCommand> commandProducer)

getResyncCommands

public List<InitCommand> getResyncCommands(SqlStringGenerationContext context,
 DdlTransactionIsolator isolator)

addResetCommand

public void addResetCommand(Function<SqlStringGenerationContext, InitCommand> commandProducer)

getResetCommands

public List<InitCommand> getResetCommands(SqlStringGenerationContext context)

getOptions

public String getOptions()

setOptions

public void setOptions(String options)

getType

public String getType()

setType

public void setType(String type)

getExtraDeclarations

public String getExtraDeclarations()

setExtraDeclarations

public void setExtraDeclarations(String extraDeclarations)