Table (Red Hat JBoss Enterprise Application Platform 7.2.0.GA public API)

java.lang.Object
- org.hibernate.mapping.Table

All Implemented Interfaces:

Serializable, Exportable, RelationalModel

Direct Known Subclasses:

DenormalizedTable
```
public class Table
extends Object
implements RelationalModel, Serializable, Exportable
```
A relational table

Author:

Gavin King

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Table.ForeignKeyKey

Nested Classes
Modifier and Type	Class and Description
`static class`	`Table.ForeignKeyKey`

Constructor Summary

Constructors
Constructor and Description
`Table()`
`Table(Identifier catalog, Identifier schema, Identifier physicalTableName, boolean isAbstract)`
`Table(Namespace namespace, Identifier physicalTableName, boolean isAbstract)`
`Table(Namespace namespace, Identifier physicalTableName, String subselect, boolean isAbstract)`
`Table(Namespace namespace, String subselect, boolean isAbstract)`
`Table(String name)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCheckConstraint(String constraint)`
`void`	`addColumn(Column column)`
`Index`	`addIndex(Index index)`
`void`	`addInitCommand(InitCommand command)`
`UniqueKey`	`addUniqueKey(UniqueKey uniqueKey)`
`boolean`	`containsColumn(Column column)`
`ForeignKey`	`createForeignKey(String keyName, List keyColumns, String referencedEntityName, String keyDefinition)`
`ForeignKey`	`createForeignKey(String keyName, List keyColumns, String referencedEntityName, String keyDefinition, List referencedColumns)`
`void`	`createForeignKeys()`
`UniqueKey`	`createUniqueKey(List keyColumns)`
`boolean`	`equals(Object object)`
`boolean`	`equals(Table table)`
`String`	`getCatalog()`
`Iterator<String>`	`getCheckConstraintsIterator()`
`Column`	`getColumn(Column column)` Return the column which is identified by column provided as argument.
`Column`	`getColumn(Identifier name)`
`Column`	`getColumn(int n)`
`Iterator`	`getColumnIterator()`
`int`	`getColumnSpan()`
`String`	`getComment()`
`String`	`getExportIdentifier()` Get a unique identifier to make sure we are not exporting the same database structure multiple times.
`Iterator`	`getForeignKeyIterator()`
`Map<Table.ForeignKeyKey,ForeignKey>`	`getForeignKeys()`
`KeyValue`	`getIdentifierValue()`
`Index`	`getIndex(String indexName)`
`Iterator<Index>`	`getIndexIterator()`
`List<InitCommand>`	`getInitCommands()`
`String`	`getName()`
`Identifier`	`getNameIdentifier()`
`Index`	`getOrCreateIndex(String indexName)`
`UniqueKey`	`getOrCreateUniqueKey(String keyName)`
`PrimaryKey`	`getPrimaryKey()`
`String`	`getQualifiedName(Dialect dialect, String defaultCatalog, String defaultSchema)` Deprecated. Should use `QualifiedObjectNameFormatter.format(org.hibernate.boot.model.relational.QualifiedTableName, org.hibernate.dialect.Dialect)` on QualifiedObjectNameFormatter obtained from `JdbcEnvironment`
`QualifiedTableName`	`getQualifiedTableName()`
`String`	`getQuotedCatalog()`
`String`	`getQuotedCatalog(Dialect dialect)`
`String`	`getQuotedName()`
`String`	`getQuotedName(Dialect dialect)`
`String`	`getQuotedSchema()`
`String`	`getQuotedSchema(Dialect dialect)`
`String`	`getRowId()`
`String`	`getSchema()`
`String`	`getSubselect()`
`int`	`getUniqueInteger()`
`UniqueKey`	`getUniqueKey(String keyName)`
`Iterator<UniqueKey>`	`getUniqueKeyIterator()`
`boolean`	`hasDenormalizedTables()`
`int`	`hashCode()`
`boolean`	`hasPrimaryKey()`
`boolean`	`isAbstract()`
`boolean`	`isAbstractUnionTable()`
`boolean`	`isCatalogQuoted()`
`boolean`	`isPhysicalTable()`
`boolean`	`isQuoted()`
`boolean`	`isSchemaQuoted()`
`boolean`	`isSubselect()`
`static String`	`qualify(String catalog, String schema, String table)` Deprecated. Should use `QualifiedObjectNameFormatter.format(org.hibernate.boot.model.relational.QualifiedTableName, org.hibernate.dialect.Dialect)` on QualifiedObjectNameFormatter obtained from `JdbcEnvironment`
`void`	`setAbstract(boolean isAbstract)`
`void`	`setCatalog(String catalog)`
`void`	`setComment(String comment)`
`void`	`setIdentifierValue(KeyValue idValue)`
`void`	`setName(String name)`
`void`	`setPrimaryKey(PrimaryKey primaryKey)`
`void`	`setQuoted(boolean quoted)`
`void`	`setRowId(String rowId)`
`void`	`setSchema(String schema)`
`void`	`setSubselect(String subselect)`
`void`	`setUniqueInteger(int uniqueInteger)`
`Iterator`	`sqlAlterStrings(Dialect dialect, Metadata metadata, TableInformation tableInfo, String defaultCatalog, String defaultSchema)`
`Iterator`	`sqlCommentStrings(Dialect dialect, String defaultCatalog, String defaultSchema)`
`String`	`sqlCreateString(Dialect dialect, Mapping p, String defaultCatalog, String defaultSchema)`
`String`	`sqlDropString(Dialect dialect, String defaultCatalog, String defaultSchema)`
`String`	`toString()`
`void`	`validateColumns(Dialect dialect, Mapping mapping, TableMetadata tableInfo)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Table
```
public Table()
```

Table
```
public Table(String name)
```

Table

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

Table

public Table(Identifier catalog,
             Identifier schema,
             Identifier physicalTableName,
             boolean isAbstract)

Table

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

Table

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

Method Detail

getQualifiedName

@Deprecated
public String getQualifiedName(Dialect dialect,
                                           String defaultCatalog,
                                           String defaultSchema)

Deprecated. Should use

QualifiedObjectNameFormatter.format(org.hibernate.boot.model.relational.QualifiedTableName, org.hibernate.dialect.Dialect)

on QualifiedObjectNameFormatter obtained from JdbcEnvironment

qualify

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

Deprecated. Should use

QualifiedObjectNameFormatter.format(org.hibernate.boot.model.relational.QualifiedTableName, org.hibernate.dialect.Dialect)

on QualifiedObjectNameFormatter obtained from JdbcEnvironment

setName
```
public void setName(String name)
```

getName
```
public String getName()
```

getNameIdentifier
```
public Identifier getNameIdentifier()
```

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 atleast 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
```
public Column getColumn(int n)
```

addColumn
```
public void addColumn(Column column)
```

getColumnSpan
```
public int getColumnSpan()
```

getColumnIterator
```
public Iterator getColumnIterator()
```

getIndexIterator

public Iterator<Index> getIndexIterator()

getForeignKeyIterator

public Iterator getForeignKeyIterator()

getForeignKeys

public Map<Table.ForeignKeyKey,ForeignKey> getForeignKeys()

getUniqueKeyIterator

public Iterator<UniqueKey> getUniqueKeyIterator()

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)
```

validateColumns

public void validateColumns(Dialect dialect,
                            Mapping mapping,
                            TableMetadata tableInfo)

sqlAlterStrings

public Iterator sqlAlterStrings(Dialect dialect,
                                Metadata metadata,
                                TableInformation tableInfo,
                                String defaultCatalog,
                                String defaultSchema)
                         throws HibernateException

Throws:: HibernateException

hasPrimaryKey
```
public boolean hasPrimaryKey()
```

sqlCreateString

public String sqlCreateString(Dialect dialect,
                              Mapping p,
                              String defaultCatalog,
                              String defaultSchema)

Specified by:: sqlCreateString in interface RelationalModel

sqlDropString

public String sqlDropString(Dialect dialect,
                            String defaultCatalog,
                            String defaultSchema)

Specified by:: sqlDropString in interface RelationalModel

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 UniqueKey createUniqueKey(List keyColumns)

getUniqueKey

public UniqueKey getUniqueKey(String keyName)

getOrCreateUniqueKey

public UniqueKey getOrCreateUniqueKey(String keyName)

createForeignKeys
```
public void createForeignKeys()
```

createForeignKey

public ForeignKey createForeignKey(String keyName,
                                   List keyColumns,
                                   String referencedEntityName,
                                   String keyDefinition)

createForeignKey

public ForeignKey createForeignKey(String keyName,
                                   List keyColumns,
                                   String referencedEntityName,
                                   String keyDefinition,
                                   List referencedColumns)

setUniqueInteger

public void setUniqueInteger(int uniqueInteger)

getUniqueInteger
```
public int getUniqueInteger()
```

setIdentifierValue

public void setIdentifierValue(KeyValue idValue)

getIdentifierValue
```
public KeyValue getIdentifierValue()
```

addCheckConstraint

public void addCheckConstraint(String constraint)

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()
```

getComment
```
public String getComment()
```

setComment

public void setComment(String comment)

getCheckConstraintsIterator

public Iterator<String> getCheckConstraintsIterator()

sqlCommentStrings

public Iterator sqlCommentStrings(Dialect dialect,
                                  String defaultCatalog,
                                  String defaultSchema)

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.

addInitCommand

public void addInitCommand(InitCommand command)

getInitCommands

public List<InitCommand> getInitCommands()

Class Table

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Table

Table

Table

Table

Table

Table

Method Detail

getQualifiedName

qualify

setName

getName

getNameIdentifier

getQuotedName

getQuotedName

getQualifiedTableName

isQuoted

setQuoted

setSchema

getSchema

getQuotedSchema

getQuotedSchema

isSchemaQuoted

setCatalog

getCatalog

getQuotedCatalog

getQuotedCatalog

isCatalogQuoted

getColumn

getColumn

getColumn

addColumn

getColumnSpan

getColumnIterator

getIndexIterator

getForeignKeyIterator

getForeignKeys

getUniqueKeyIterator

hashCode

equals

equals

validateColumns

sqlAlterStrings

hasPrimaryKey

sqlCreateString

sqlDropString

getPrimaryKey

setPrimaryKey

getOrCreateIndex

getIndex

addIndex

addUniqueKey

createUniqueKey

getUniqueKey

getOrCreateUniqueKey

createForeignKeys

createForeignKey

createForeignKey

setUniqueInteger

getUniqueInteger

setIdentifierValue

getIdentifierValue

addCheckConstraint

containsColumn

getRowId

setRowId

toString

getSubselect

setSubselect

isSubselect

isAbstractUnionTable

hasDenormalizedTables

setAbstract

isAbstract

isPhysicalTable