Modul org.jooq.meta

Package org.jooq.meta

Klasse AbstractTableDefinition

java.lang.Object

org.jooq.meta.AbstractDefinition

org.jooq.meta.AbstractElementContainerDefinition<ColumnDefinition>

org.jooq.meta.AbstractTableDefinition

Alle implementierten Schnittstellen:

Definition, TableDefinition

Bekannte direkte Unterklassen:

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.

Autor:

Lukas Eder

Feldübersicht

Von Klasse geerbte Felder org.jooq.meta.AbstractElementContainerDefinition

PRECISION_SCALE

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
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)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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.
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 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)

Von Klasse geerbte Methoden org.jooq.meta.AbstractElementContainerDefinition

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

Von Klasse geerbte Methoden 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

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden org.jooq.meta.Definition

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

Konstruktordetails

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)

Methodendetails

isSynthetic

public boolean isSynthetic()

Beschreibung aus Schnittstelle kopiert: TableDefinition

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

Angegeben von:

isSynthetic in Schnittstelle Definition

Angegeben von:

isSynthetic in Schnittstelle TableDefinition

getEmbeddables

public final List<EmbeddableDefinition> getEmbeddables()

Beschreibung aus Schnittstelle kopiert: TableDefinition

All embeddable types in this defining table.

Angegeben von:

getEmbeddables in Schnittstelle TableDefinition

getReferencedEmbeddables

public final List<EmbeddableDefinition> getReferencedEmbeddables()

Beschreibung aus Schnittstelle kopiert: TableDefinition

All embeddable types in this referencing table.

Angegeben von:

getReferencedEmbeddables in Schnittstelle TableDefinition

getPrimaryKey

public final UniqueKeyDefinition getPrimaryKey()

Beschreibung aus Schnittstelle kopiert: TableDefinition

Get the primary key for this table.

Angegeben von:

getPrimaryKey in Schnittstelle TableDefinition

getIndexes

public final List<IndexDefinition> getIndexes()

Beschreibung aus Schnittstelle kopiert: TableDefinition

Get the indexes for this table.

Angegeben von:

getIndexes in Schnittstelle TableDefinition

getUniqueKeys

public final List<UniqueKeyDefinition> getUniqueKeys()

Beschreibung aus Schnittstelle kopiert: TableDefinition

Get the unique keys for this table.

Angegeben von:

getUniqueKeys in Schnittstelle TableDefinition

getUniqueKey

public final UniqueKeyDefinition getUniqueKey(String name)

Beschreibung aus Schnittstelle kopiert: TableDefinition

Get the unique key for this table by name.

Angegeben von:

getUniqueKey in Schnittstelle TableDefinition

getKeys

public final List<UniqueKeyDefinition> getKeys()

Beschreibung aus Schnittstelle kopiert: TableDefinition

Get the unique keys and primary keys for this table.

Angegeben von:

getKeys in Schnittstelle TableDefinition

getKey

public final UniqueKeyDefinition getKey(String name)

Beschreibung aus Schnittstelle kopiert: TableDefinition

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

Angegeben von:

getKey in Schnittstelle TableDefinition

getForeignKeys

public final List<ForeignKeyDefinition> getForeignKeys()

Beschreibung aus Schnittstelle kopiert: TableDefinition

Get the foreign keys for this table.

Angegeben von:

getForeignKeys in Schnittstelle TableDefinition

getForeignKeys

public final List<ForeignKeyDefinition> getForeignKeys(TableDefinition referenced)

Beschreibung aus Schnittstelle kopiert: TableDefinition

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

Angegeben von:

getForeignKeys in Schnittstelle TableDefinition

getInverseForeignKeys

public final List<InverseForeignKeyDefinition> getInverseForeignKeys()

Beschreibung aus Schnittstelle kopiert: TableDefinition

Get the inverse foreign keys for this table.

Angegeben von:

getInverseForeignKeys in Schnittstelle TableDefinition

getInverseForeignKeys

public final List<InverseForeignKeyDefinition> getInverseForeignKeys(TableDefinition referencing)

Beschreibung aus Schnittstelle kopiert: TableDefinition

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

Angegeben von:

getInverseForeignKeys in Schnittstelle TableDefinition

getManyToManyKeys

public final List<ManyToManyKeyDefinition> getManyToManyKeys()

Beschreibung aus Schnittstelle kopiert: TableDefinition

Get the many to many keys for this table.

Angegeben von:

getManyToManyKeys in Schnittstelle TableDefinition

getManyToManyKeys

public final List<ManyToManyKeyDefinition> getManyToManyKeys(TableDefinition referencing)

Beschreibung aus Schnittstelle kopiert: TableDefinition

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

Angegeben von:

getManyToManyKeys in Schnittstelle TableDefinition

getCheckConstraints

public final List<CheckConstraintDefinition> getCheckConstraints()

Beschreibung aus Schnittstelle kopiert: TableDefinition

Get the CHECK constraints for this table.

Angegeben von:

getCheckConstraints in Schnittstelle TableDefinition

getIdentity

public final IdentityDefinition getIdentity()

Beschreibung aus Schnittstelle kopiert: TableDefinition

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

Angegeben von:

getIdentity in Schnittstelle TableDefinition

setParentTable

public final void setParentTable(TableDefinition parentTable)

getParentTable

public final TableDefinition getParentTable()

Beschreibung aus Schnittstelle kopiert: TableDefinition

Get the parent table if table inheritance is applicable.

Angegeben von:

getParentTable in Schnittstelle TableDefinition

getChildTables

public final List<TableDefinition> getChildTables()

Beschreibung aus Schnittstelle kopiert: TableDefinition

Get the child tables if table inheritance is applicable.

Angegeben von:

getChildTables in Schnittstelle TableDefinition

getTable

public final Table<Record> getTable()

Beschreibung aus Schnittstelle kopiert: TableDefinition

This TableDefinition as a Table.

Angegeben von:

getTable in Schnittstelle TableDefinition

getTableOptions

public final TableOptions getTableOptions()

Beschreibung aus Schnittstelle kopiert: TableDefinition

The TableOptions providing additional information about the table.

Angegeben von:

getTableOptions in Schnittstelle TableDefinition

getColumns

public final List<ColumnDefinition> getColumns()

Beschreibung aus Schnittstelle kopiert: TableDefinition

All columns in the type, table or view.

Angegeben von:

getColumns in Schnittstelle TableDefinition

getColumn

public final ColumnDefinition getColumn(String columnName)

Beschreibung aus Schnittstelle kopiert: TableDefinition

Get a column in this type by its name.

Angegeben von:

getColumn in Schnittstelle TableDefinition

getColumn

public final ColumnDefinition getColumn(String columnName,
 boolean ignoreCase)

Beschreibung aus Schnittstelle kopiert: TableDefinition

Get a column in this type by its name.

Angegeben von:

getColumn in Schnittstelle TableDefinition

getColumn

public final ColumnDefinition getColumn(int columnIndex)

Beschreibung aus Schnittstelle kopiert: TableDefinition

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

Angegeben von:

getColumn in Schnittstelle TableDefinition

getParameters

public final List<ParameterDefinition> getParameters()

Beschreibung aus Schnittstelle kopiert: TableDefinition

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

Angegeben von:

getParameters in Schnittstelle TableDefinition

isTemporary

public final boolean isTemporary()

Beschreibung aus Schnittstelle kopiert: TableDefinition

Whether this table is a temporary table.

Angegeben von:

isTemporary in Schnittstelle TableDefinition

isView

public final boolean isView()

Beschreibung aus Schnittstelle kopiert: TableDefinition

Whether this table is a view.

Angegeben von:

isView in Schnittstelle TableDefinition

isMaterializedView

public final boolean isMaterializedView()

Beschreibung aus Schnittstelle kopiert: TableDefinition

Whether this table is a materialized view.

Angegeben von:

isMaterializedView in Schnittstelle TableDefinition

isTableValuedFunction

public final boolean isTableValuedFunction()

Beschreibung aus Schnittstelle kopiert: TableDefinition

Whether this table is a table-valued function.

Angegeben von:

isTableValuedFunction in Schnittstelle TableDefinition

getReferencedTable

public final TableDefinition getReferencedTable()

Beschreibung aus Schnittstelle kopiert: 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

Angegeben von:

getReferencedTable in Schnittstelle TableDefinition

getElements0

protected List<ColumnDefinition> getElements0()
                                       throws SQLException

Angegeben von:

getElements0 in Klasse AbstractElementContainerDefinition<ColumnDefinition>

Löst aus:

SQLException

getParameters0

protected List<ParameterDefinition> getParameters0()