Module org.jooq.meta

Package org.jooq.meta

Class DefaultForeignKeyDefinition

java.lang.Object

org.jooq.meta.AbstractDefinition

org.jooq.meta.AbstractConstraintDefinition

org.jooq.meta.DefaultForeignKeyDefinition

All Implemented Interfaces:

ConstraintDefinition, Definition, ForeignKeyDefinition

public class DefaultForeignKeyDefinition
extends AbstractConstraintDefinition
implements ForeignKeyDefinition

Constructor Summary

Constructors

Constructor	Description
DefaultForeignKeyDefinition(SchemaDefinition schema, String name, TableDefinition table, UniqueKeyDefinition uniqueKey)
DefaultForeignKeyDefinition(SchemaDefinition schema, String name, TableDefinition table, UniqueKeyDefinition uk, boolean enforced)

Method Summary

Modifier and Type	Method	Description
int	countSimilarReferences()	Count the number of references between referencing and referenced tables.
List<ColumnDefinition>	getKeyColumns()	The list of columns making up the foreign key.
TableDefinition	getKeyTable()	The definition of the referencing table
List<ColumnDefinition>	getReferencedColumns()	The list of columns referenced by this foreign key
UniqueKeyDefinition	getReferencedKey()	The referenced key.
TableDefinition	getReferencedTable()	The definition of the referenced table.
UniqueKeyDefinition	resolveReferencedKey()	Resolve a referenced key.

Methods inherited from class org.jooq.meta.AbstractConstraintDefinition

enforced, getDefinitionPath, getTable

Methods inherited from class org.jooq.meta.AbstractDefinition

create, create, equals, getCatalog, getComment, getConnection, getDatabase, getDialect, getInputName, getName, getOutputName, getOverload, getPackage, 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.ConstraintDefinition

enforced, getTable

Methods inherited from interface org.jooq.meta.Definition

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

Constructor Detail

DefaultForeignKeyDefinition

public DefaultForeignKeyDefinition(SchemaDefinition schema,
                                   String name,
                                   TableDefinition table,
                                   UniqueKeyDefinition uniqueKey)

DefaultForeignKeyDefinition

public DefaultForeignKeyDefinition(SchemaDefinition schema,
                                   String name,
                                   TableDefinition table,
                                   UniqueKeyDefinition uk,
                                   boolean enforced)

Method Detail

getKeyTable

public TableDefinition getKeyTable()

Description copied from interface: ForeignKeyDefinition

The definition of the referencing table

Specified by:

getKeyTable in interface ForeignKeyDefinition

getKeyColumns

public List<ColumnDefinition> getKeyColumns()

Description copied from interface: ForeignKeyDefinition

The list of columns making up the foreign key.

Specified by:

getKeyColumns in interface ForeignKeyDefinition

getReferencedKey

public UniqueKeyDefinition getReferencedKey()

Description copied from interface: ForeignKeyDefinition

The referenced key.

Specified by:

getReferencedKey in interface ForeignKeyDefinition

resolveReferencedKey

public UniqueKeyDefinition resolveReferencedKey()

Description copied from interface: ForeignKeyDefinition

Resolve a referenced key.

If ForeignKeyDefinition.getReferencedKey() coincides itself with a foreign key, resolve that foreign key recursively. In case of ambiguity (two foreign keys coinciding with a single unique key), this returns null.

Specified by:

resolveReferencedKey in interface ForeignKeyDefinition

getReferencedTable

public TableDefinition getReferencedTable()

Description copied from interface: ForeignKeyDefinition

The definition of the referenced table.

Specified by:

getReferencedTable in interface ForeignKeyDefinition

getReferencedColumns

public List<ColumnDefinition> getReferencedColumns()

Description copied from interface: ForeignKeyDefinition

The list of columns referenced by this foreign key

Specified by:

getReferencedColumns in interface ForeignKeyDefinition

countSimilarReferences

public int countSimilarReferences()

Description copied from interface: ForeignKeyDefinition

Count the number of references between referencing and referenced tables.

Specified by:

countSimilarReferences in interface ForeignKeyDefinition