Module org.jooq.meta

Package org.jooq.meta

Class AbstractTableDefinition

java.lang.Object

org.jooq.meta.AbstractDefinition

org.jooq.meta.AbstractElementContainerDefinition<ColumnDefinition>

org.jooq.meta.AbstractTableDefinition

All Implemented Interfaces:

Definition, TableDefinition

Direct Known Subclasses:

CUBRIDTableDefinition, DefaultMetaTableDefinition, DerbyTableDefinition, FirebirdTableDefinition, FirebirdTableValuedFunction, H2TableDefinition, HSQLDBTableDefinition, HSQLDBTableValuedFunction, MySQLTableDefinition, PostgresMaterializedViewDefinition, PostgresTableDefinition, PostgresTableValuedFunction, SQLiteTableDefinition, XMLTableDefinition

public abstract class AbstractTableDefinition
extends AbstractElementContainerDefinition<ColumnDefinition>
implements TableDefinition

A base implementation for table definitions.

Author:

Lukas Eder

Field Summary

Fields inherited from class org.jooq.meta.AbstractElementContainerDefinition

PRECISION_SCALE

Constructor Summary

Constructors

Constructor	Description
AbstractTableDefinition(SchemaDefinition schema, String name, String comment)
AbstractTableDefinition(SchemaDefinition schema, String name, String comment, TableOptions.TableType tableType, String source)
AbstractTableDefinition(SchemaDefinition schema, String name, String comment, TableOptions.TableType tableType, String source, SchemaDefinition referencedSchema, String referencedName)

Method Summary

Modifier and Type	Method	Description
final List<CheckConstraintDefinition>	getCheckConstraints()	Get the CHECK constraints for this table.
final List<TableDefinition>	getChildTables()	Get the child tables if table inheritance is applicable.
final ColumnDefinition	getColumn(int columnIndex)	Get a column in this type by its index (starting at 0).
final ColumnDefinition	getColumn(String columnName)	Get a column in this type by its name.
final ColumnDefinition	getColumn(String columnName, boolean ignoreCase)	Get a column in this type by its name.
final List<ColumnDefinition>	getColumns()	All columns in the type, table or view.
final List<ColumnDefinition>	getColumnsIncludingHidden()	All columns in the type, table or view, including hidden columns.
protected List<ColumnDefinition>	getElements0()
final List<EmbeddableDefinition>	getEmbeddables()	All embeddable types in this defining table.
final List<ForeignKeyDefinition>	getForeignKeys()	Get the foreign keys for this table.
final List<ForeignKeyDefinition>	getForeignKeys(TableDefinition referenced)	Get the foreign keys for this table referencing a specific table.
final IdentityDefinition	getIdentity()	Get the IDENTITY column of this table, or null, if no such column exists.
final List<IndexDefinition>	getIndexes()	Get the indexes for this table.
final List<InverseForeignKeyDefinition>	getInverseForeignKeys()	Get the inverse foreign keys for this table.
final List<InverseForeignKeyDefinition>	getInverseForeignKeys(TableDefinition referencing)	Get the inverse foreign keys for this table referenced from a specific table.
final UniqueKeyDefinition	getKey(String name)	Get the unique key or primary key for this table by name.
final List<UniqueKeyDefinition>	getKeys()	Get the unique keys and primary keys for this table.
final List<ManyToManyKeyDefinition>	getManyToManyKeys()	Get the many to many keys for this table.
final List<ManyToManyKeyDefinition>	getManyToManyKeys(TableDefinition referencing)	Get the many to many keys for this table referencing another, specific table.
final List<ParameterDefinition>	getParameters()	The parameters of this table if this is a table-valued function.
protected List<ParameterDefinition>	getParameters0()
final TableDefinition	getParentTable()	Get the parent table if table inheritance is applicable.
final UniqueKeyDefinition	getPrimaryKey()	Get the primary key for this table.
final List<EmbeddableDefinition>	getReferencedEmbeddables()	All embeddable types in this referencing table.
final TableDefinition	getReferencedTable()	The referenced table type, if this TableDefinition.isTableValuedFunction().
final Definition	getReferencedTableOrUDT()	The referenced table or UDT type, if this TableDefinition.isTableValuedFunction().
final Table<Record>	getTable()	This TableDefinition as a Table.
final TableOptions	getTableOptions()	The TableOptions providing additional information about the table.
final UniqueKeyDefinition	getUniqueKey(String name)	Get the unique key for this table by name.
final List<UniqueKeyDefinition>	getUniqueKeys()	Get the unique keys for this table.
final boolean	isMaterializedView()	Whether this table is a materialized view.
boolean	isSynthetic()	Whether this table is a synthetic table (e.g.
final boolean	isTableValuedFunction()	Whether this table is a table-valued function.
final boolean	isTemporary()	Whether this table is a temporary table.
final boolean	isView()	Whether this table is a view.
final void	setParentTable(TableDefinition parentTable)

Methods inherited from class org.jooq.meta.AbstractElementContainerDefinition

getElement, getElement, getElement, getElements, getElementsIncludingHidden, parseNotNull, parsePrecision, parseScale, parseTypeName

Methods inherited from class org.jooq.meta.AbstractDefinition

create, create, equals, getCatalog, getComment, getConnection, getDatabase, getDefinitionPath, getDialect, getInputName, getName, getOutputName, getOverload, getPackage, getPartiallyQualifiedNames, getQualifiedInputName, getQualifiedInputNamePart, getQualifiedName, getQualifiedNamePart, getQualifiedOutputName, getQualifiedOutputNamePart, getSchema, getSource, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jooq.meta.Definition

getCatalog, getComment, getDatabase, getDefinitionPath, getInputName, getName, getOutputName, getOverload, getPackage, getPartiallyQualifiedNames, getQualifiedInputName, getQualifiedInputNamePart, getQualifiedName, getQualifiedNamePart, getQualifiedOutputName, getQualifiedOutputNamePart, getSchema, getSource

Constructor Details

AbstractTableDefinition

public AbstractTableDefinition(SchemaDefinition schema,
 String name,
 String comment)

AbstractTableDefinition

public AbstractTableDefinition(SchemaDefinition schema,
 String name,
 String comment,
 TableOptions.TableType tableType,
 String source)

AbstractTableDefinition

public AbstractTableDefinition(SchemaDefinition schema,
 String name,
 String comment,
 TableOptions.TableType tableType,
 String source,
 SchemaDefinition referencedSchema,
 String referencedName)

Method Details

isSynthetic

public boolean isSynthetic()

Description copied from interface: TableDefinition

Whether this table is a synthetic table (e.g. a synthetic view).

Specified by:

isSynthetic in interface Definition

Specified by:

isSynthetic in interface TableDefinition

getEmbeddables

public final List<EmbeddableDefinition> getEmbeddables()

Description copied from interface: TableDefinition

All embeddable types in this defining table.

Specified by:

getEmbeddables in interface TableDefinition

getReferencedEmbeddables

public final List<EmbeddableDefinition> getReferencedEmbeddables()

Description copied from interface: TableDefinition

All embeddable types in this referencing table.

Specified by:

getReferencedEmbeddables in interface TableDefinition

getPrimaryKey

public final UniqueKeyDefinition getPrimaryKey()

Description copied from interface: TableDefinition

Get the primary key for this table.

Specified by:

getPrimaryKey in interface TableDefinition

getIndexes

public final List<IndexDefinition> getIndexes()

Description copied from interface: TableDefinition

Get the indexes for this table.

Specified by:

getIndexes in interface TableDefinition

getUniqueKeys

public final List<UniqueKeyDefinition> getUniqueKeys()

Description copied from interface: TableDefinition

Get the unique keys for this table.

Specified by:

getUniqueKeys in interface TableDefinition

getUniqueKey

public final UniqueKeyDefinition getUniqueKey(String name)

Description copied from interface: TableDefinition

Get the unique key for this table by name.

Specified by:

getUniqueKey in interface TableDefinition

getKeys

public final List<UniqueKeyDefinition> getKeys()

Description copied from interface: TableDefinition

Get the unique keys and primary keys for this table.

Specified by:

getKeys in interface TableDefinition

getKey

public final UniqueKeyDefinition getKey(String name)

Description copied from interface: TableDefinition

Get the unique key or primary key for this table by name.

Specified by:

getKey in interface TableDefinition

getForeignKeys

public final List<ForeignKeyDefinition> getForeignKeys()

Description copied from interface: TableDefinition

Get the foreign keys for this table.

Specified by:

getForeignKeys in interface TableDefinition

getForeignKeys

public final List<ForeignKeyDefinition> getForeignKeys(TableDefinition referenced)

Description copied from interface: TableDefinition

Get the foreign keys for this table referencing a specific table.

Specified by:

getForeignKeys in interface TableDefinition

getInverseForeignKeys

public final List<InverseForeignKeyDefinition> getInverseForeignKeys()

Description copied from interface: TableDefinition

Get the inverse foreign keys for this table.

Specified by:

getInverseForeignKeys in interface TableDefinition

getInverseForeignKeys

public final List<InverseForeignKeyDefinition> getInverseForeignKeys(TableDefinition referencing)

Description copied from interface: TableDefinition

Get the inverse foreign keys for this table referenced from a specific table.

Specified by:

getInverseForeignKeys in interface TableDefinition

getManyToManyKeys

public final List<ManyToManyKeyDefinition> getManyToManyKeys()

Description copied from interface: TableDefinition

Get the many to many keys for this table.

Specified by:

getManyToManyKeys in interface TableDefinition

getManyToManyKeys

public final List<ManyToManyKeyDefinition> getManyToManyKeys(TableDefinition referencing)

Description copied from interface: TableDefinition

Get the many to many keys for this table referencing another, specific table.

Specified by:

getManyToManyKeys in interface TableDefinition

getCheckConstraints

public final List<CheckConstraintDefinition> getCheckConstraints()

Description copied from interface: TableDefinition

Get the CHECK constraints for this table.

Specified by:

getCheckConstraints in interface TableDefinition

getIdentity

public final IdentityDefinition getIdentity()

Description copied from interface: TableDefinition

Get the IDENTITY column of this table, or null, if no such column exists.

Specified by:

getIdentity in interface TableDefinition

setParentTable

public final void setParentTable(TableDefinition parentTable)

getParentTable

public final TableDefinition getParentTable()

Description copied from interface: TableDefinition

Get the parent table if table inheritance is applicable.

Specified by:

getParentTable in interface TableDefinition

getChildTables

public final List<TableDefinition> getChildTables()

Description copied from interface: TableDefinition

Get the child tables if table inheritance is applicable.

Specified by:

getChildTables in interface TableDefinition

getTable

public final Table<Record> getTable()

Description copied from interface: TableDefinition

This TableDefinition as a Table.

Specified by:

getTable in interface TableDefinition

getTableOptions

public final TableOptions getTableOptions()

Description copied from interface: TableDefinition

The TableOptions providing additional information about the table.

Specified by:

getTableOptions in interface TableDefinition

getColumns

public final List<ColumnDefinition> getColumns()

Description copied from interface: TableDefinition

All columns in the type, table or view.

Specified by:

getColumns in interface TableDefinition

getColumnsIncludingHidden

public final List<ColumnDefinition> getColumnsIncludingHidden()

Description copied from interface: TableDefinition

All columns in the type, table or view, including hidden columns.

Specified by:

getColumnsIncludingHidden in interface TableDefinition

getColumn

public final ColumnDefinition getColumn(String columnName)

Description copied from interface: TableDefinition

Get a column in this type by its name.

Specified by:

getColumn in interface TableDefinition

getColumn

public final ColumnDefinition getColumn(String columnName,
 boolean ignoreCase)

Description copied from interface: TableDefinition

Get a column in this type by its name.

Specified by:

getColumn in interface TableDefinition

getColumn

public final ColumnDefinition getColumn(int columnIndex)

Description copied from interface: TableDefinition

Get a column in this type by its index (starting at 0).

Specified by:

getColumn in interface TableDefinition

getParameters

public final List<ParameterDefinition> getParameters()

Description copied from interface: TableDefinition

The parameters of this table if this is a table-valued function.

Specified by:

getParameters in interface TableDefinition

isTemporary

public final boolean isTemporary()

Description copied from interface: TableDefinition

Whether this table is a temporary table.

Specified by:

isTemporary in interface TableDefinition

isView

public final boolean isView()

Description copied from interface: TableDefinition

Whether this table is a view.

Specified by:

isView in interface TableDefinition

isMaterializedView

public final boolean isMaterializedView()

Description copied from interface: TableDefinition

Whether this table is a materialized view.

Specified by:

isMaterializedView in interface TableDefinition

isTableValuedFunction

public final boolean isTableValuedFunction()

Description copied from interface: TableDefinition

Whether this table is a table-valued function.

Specified by:

isTableValuedFunction in interface TableDefinition

getReferencedTable

public final TableDefinition getReferencedTable()

Description copied from interface: TableDefinition

The referenced table type, if this TableDefinition.isTableValuedFunction().

This returns:

• this, if TableDefinition.isTableValuedFunction() == false
• this, if TableDefinition.isTableValuedFunction() == true but the table valued function doesn't reference a table type
• Another table, if TableDefinition.isTableValuedFunction() == true and the table valued function references a table type

Specified by:

getReferencedTable in interface TableDefinition

getReferencedTableOrUDT

public final Definition getReferencedTableOrUDT()

Description copied from interface: TableDefinition

The referenced table or UDT type, if this TableDefinition.isTableValuedFunction().

This returns:

• this, if TableDefinition.isTableValuedFunction() == false
• this, if TableDefinition.isTableValuedFunction() == true but the table valued function doesn't reference a table type
• Another TableDefinition or UDTDefinition, if TableDefinition.isTableValuedFunction() == true and the table valued function references a table type

Specified by:

getReferencedTableOrUDT in interface TableDefinition

getElements0

protected List<ColumnDefinition> getElements0()
                                       throws SQLException

Specified by:

getElements0 in class AbstractElementContainerDefinition<ColumnDefinition>

Throws:

SQLException

getParameters0

protected List<ParameterDefinition> getParameters0()