Module is.codion.framework.domain

Package is.codion.framework.domain.entity.attribute

Interface ForeignKey

All Superinterfaces:

Attribute<Entity>, ForeignKeyCondition.Factory

public interface ForeignKey
extends Attribute<Entity>, ForeignKeyCondition.Factory

An Attribute representing a foreign key relation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ForeignKey.ForeignKeyDefiner	Provides ForeignKeyDefinition.Builder instances.
static interface	ForeignKey.Reference<T>	Represents a foreign key reference between columns.

Nested classes/interfaces inherited from interface is.codion.framework.domain.entity.attribute.Attribute

Attribute.AttributeDefiner<T>, Attribute.Type<T>

Method Summary

Modifier and Type	Method	Description
ForeignKey.ForeignKeyDefiner	define()
static ForeignKey	foreignKey(EntityType entityType, String name, List<ForeignKey.Reference<?>> references)	Creates a new ForeignKey based on the given entityType and references.
<T> ForeignKey.Reference<T>	reference(Column<T> column)
static <T> ForeignKey.Reference<T>	reference(Column<T> column, Column<T> foreign)	Returns a new ForeignKey.Reference based on the given columns.
EntityType	referencedType()
List<ForeignKey.Reference<?>>	references()

Methods inherited from interface is.codion.framework.domain.entity.attribute.Attribute

entityType, name, type

Methods inherited from interface is.codion.framework.domain.entity.condition.ForeignKeyCondition.Factory

equalTo, in, in, isNotNull, isNull, notEqualTo, notIn, notIn

Method Details

define

ForeignKey.ForeignKeyDefiner define()

Specified by:

define in interface Attribute<Entity>

Returns:

a ForeignKey.ForeignKeyDefiner for this foreign key

referencedType

EntityType referencedType()

Returns:

the entity type referenced by this foreign key

references

List<ForeignKey.Reference<?>> references()

Returns:

the ForeignKey.References that comprise this key

reference

<T> ForeignKey.Reference<T> reference(Column<T> column)

Type Parameters:

T - the column type

Parameters:

column - the column

Returns:

the reference that is based on the given column

reference

static <T> ForeignKey.Reference<T> reference(Column<T> column,
 Column<T> foreign)

Returns a new ForeignKey.Reference based on the given columns.

Type Parameters:

T - the column type

Parameters:

column - the local column

foreign - the referenced foreign column

Returns:

a new ForeignKey.Reference based on the given columns

foreignKey

static ForeignKey foreignKey(EntityType entityType,
 String name,
 List<ForeignKey.Reference<?>> references)

Creates a new ForeignKey based on the given entityType and references.

Parameters:

entityType - the entityType owning this foreign key

name - the attribute name

references - the references

Returns:

a new ForeignKey

See Also:

• reference(Column, Column)