Package org.hibernate.metamodel.mapping

Interface ForeignKeyDescriptor

All Superinterfaces:

Bindable, JavaTypedExpressible, JdbcMappingContainer, MappingModelExpressible, ModelPart, SelectableMappings, ValuedModelPart, ValueMapping, VirtualModelPart

public interface ForeignKeyDescriptor
extends VirtualModelPart, ValuedModelPart

Descriptor for foreign-keys

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ForeignKeyDescriptor.Nature
static interface	ForeignKeyDescriptor.Side

Nested classes/interfaces inherited from interface org.hibernate.metamodel.mapping.Bindable

Bindable.JdbcValuesBiConsumer<X,Y>, Bindable.JdbcValuesConsumer

Nested classes/interfaces inherited from interface org.hibernate.metamodel.mapping.ModelPart

ModelPart.JdbcValueBiConsumer<X,Y>, ModelPart.JdbcValueConsumer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PART_NAME
static final String	TARGET_PART_NAME

Method Summary

Modifier and Type	Method	Description
int	compare(Object key1, Object key2)	Compare the 2 values
<T> DomainResult<T>	createDomainResult(NavigablePath navigablePath, TableGroup targetTableGroup, String resultVariable, DomainResultCreationState creationState)	Create a DomainResult for the referring-side of the fk The table group must be the one containing the target.
DomainResult<?>	createKeyDomainResult(NavigablePath navigablePath, TableGroup targetTableGroup, ForeignKeyDescriptor.Nature fromSide, FetchParent fetchParent, DomainResultCreationState creationState)	Create a DomainResult for the referring-side of the fk The table group must be the one containing the target.
DomainResult<?>	createKeyDomainResult(NavigablePath navigablePath, TableGroup targetTableGroup, FetchParent fetchParent, DomainResultCreationState creationState)	Create a DomainResult for the referring-side of the fk The table group must be the one containing the target.
DomainResult<?>	createTargetDomainResult(NavigablePath navigablePath, TableGroup targetTableGroup, FetchParent fetchParent, DomainResultCreationState creationState)	Create a DomainResult for the target-side of the fk The table group must be the one containing the target
default int	forEachSelectable(int offset, SelectableConsumer consumer)	Visits the FK "referring" columns
Predicate	generateJoinPredicate(TableGroup targetSideTableGroup, TableGroup keySideTableGroup, SqlAstCreationState creationState)
Predicate	generateJoinPredicate(TableReference targetSideReference, TableReference keySideReference, SqlAstCreationState creationState)
AssociationKey	getAssociationKey()
default Object	getAssociationKeyFromSide(Object targetObject, ForeignKeyDescriptor.Nature nature, SharedSessionContractImplementor session)
Object	getAssociationKeyFromSide(Object targetObject, ForeignKeyDescriptor.Side side, SharedSessionContractImplementor session)
default String	getContainingTableExpression()	The table which contains the columns mapped by this value
ValuedModelPart	getKeyPart()
ForeignKeyDescriptor.Side	getKeySide()
String	getKeyTable()
default ValuedModelPart	getPart(ForeignKeyDescriptor.Nature nature)
default String	getPartName()	The local part name, which is generally the unqualified role name
SelectableMapping	getSelectable(int columnIndex)	Get the selectable at the given position
default ForeignKeyDescriptor.Side	getSide(ForeignKeyDescriptor.Nature nature)
ValuedModelPart	getTargetPart()
ForeignKeyDescriptor.Side	getTargetSide()
String	getTargetTable()
boolean	hasConstraint()
boolean	isEmbedded()
boolean	isKeyPart(ValuedModelPart modelPart)
boolean	isSimpleJoinPredicate(Predicate predicate)
int	visitKeySelectables(int offset, SelectableConsumer consumer)
default int	visitKeySelectables(SelectableConsumer consumer)
int	visitTargetSelectables(int offset, SelectableConsumer consumer)
default int	visitTargetSelectables(SelectableConsumer consumer)
ForeignKeyDescriptor	withKeySelectionMapping(ManagedMappingType declaringType, TableGroupProducer declaringTableGroupProducer, IntFunction<SelectableMapping> selectableMappingAccess, org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)	Return a copy of this foreign key descriptor with the selectable mappings as provided by the given accessor.
ForeignKeyDescriptor	withTargetPart(ValuedModelPart targetPart)	Return a copy of this foreign key descriptor with the target part as given by the argument.

Methods inherited from interface org.hibernate.metamodel.mapping.Bindable

addToCacheKey, disassemble, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue

Methods inherited from interface org.hibernate.type.descriptor.java.JavaTypedExpressible

addToCacheKey

Methods inherited from interface org.hibernate.metamodel.mapping.JdbcMappingContainer

forEachJdbcType, getJdbcMapping

Methods inherited from interface org.hibernate.metamodel.mapping.ModelPart

applySqlSelections, applySqlSelections, areEqual, asAttributeMapping, asBasicValuedModelPart, asEntityMappingType, breakDownJdbcValues, breakDownJdbcValues, decompose, decompose, findContainingEntityMapping, getJavaType, getNavigableRole, getPartMappingType, hasPartitionedSelectionMapping, isEntityIdentifierMapping

Methods inherited from interface org.hibernate.metamodel.mapping.ValuedModelPart

forEachInsertable, forEachNonFormula, forEachSelectable, forEachUpdatable, getJdbcTypeCount, getSingleJdbcMapping

Methods inherited from interface org.hibernate.metamodel.mapping.ValueMapping

getExpressibleJavaType, getMappedType, treatAs

Methods inherited from interface org.hibernate.metamodel.mapping.VirtualModelPart

isVirtual

Field Details

PART_NAME

static final String PART_NAME

See Also:

• Constant Field Values

TARGET_PART_NAME

static final String TARGET_PART_NAME

See Also:

• Constant Field Values

Method Details

getPartName

default String getPartName()

Description copied from interface: ModelPart

The local part name, which is generally the unqualified role name

Specified by:

getPartName in interface ModelPart

getKeyTable

String getKeyTable()

getTargetTable

String getTargetTable()

getKeyPart

ValuedModelPart getKeyPart()

getTargetPart

ValuedModelPart getTargetPart()

isKeyPart

boolean isKeyPart(ValuedModelPart modelPart)

getPart

default ValuedModelPart getPart(ForeignKeyDescriptor.Nature nature)

getKeySide

ForeignKeyDescriptor.Side getKeySide()

getTargetSide

ForeignKeyDescriptor.Side getTargetSide()

getSide

default ForeignKeyDescriptor.Side getSide(ForeignKeyDescriptor.Nature nature)

getContainingTableExpression

default String getContainingTableExpression()

Description copied from interface: ValuedModelPart

The table which contains the columns mapped by this value

Specified by:

getContainingTableExpression in interface ValuedModelPart

compare

int compare(Object key1,
 Object key2)

Compare the 2 values

createKeyDomainResult

DomainResult<?> createKeyDomainResult(NavigablePath navigablePath,
 TableGroup targetTableGroup,
 FetchParent fetchParent,
 DomainResultCreationState creationState)

Create a DomainResult for the referring-side of the fk The table group must be the one containing the target.

createKeyDomainResult

DomainResult<?> createKeyDomainResult(NavigablePath navigablePath,
 TableGroup targetTableGroup,
 ForeignKeyDescriptor.Nature fromSide,
 FetchParent fetchParent,
 DomainResultCreationState creationState)

Create a DomainResult for the referring-side of the fk The table group must be the one containing the target. The ForeignKeyDescriptor.Nature is the association side of the foreign key i.e. Association.getSideNature().

createTargetDomainResult

DomainResult<?> createTargetDomainResult(NavigablePath navigablePath,
 TableGroup targetTableGroup,
 FetchParent fetchParent,
 DomainResultCreationState creationState)

Create a DomainResult for the target-side of the fk The table group must be the one containing the target

createDomainResult

<T> DomainResult<T> createDomainResult(NavigablePath navigablePath,
 TableGroup targetTableGroup,
 String resultVariable,
 DomainResultCreationState creationState)

Create a DomainResult for the referring-side of the fk The table group must be the one containing the target.

Specified by:

createDomainResult in interface ModelPart

generateJoinPredicate

Predicate generateJoinPredicate(TableGroup targetSideTableGroup,
 TableGroup keySideTableGroup,
 SqlAstCreationState creationState)

generateJoinPredicate

Predicate generateJoinPredicate(TableReference targetSideReference,
 TableReference keySideReference,
 SqlAstCreationState creationState)

isSimpleJoinPredicate

boolean isSimpleJoinPredicate(Predicate predicate)

getSelectable

SelectableMapping getSelectable(int columnIndex)

Description copied from interface: SelectableMappings

Get the selectable at the given position

Specified by:

getSelectable in interface SelectableMappings

forEachSelectable

default int forEachSelectable(int offset,
 SelectableConsumer consumer)

Visits the FK "referring" columns

Specified by:

forEachSelectable in interface ModelPart

Specified by:

forEachSelectable in interface SelectableMappings

Specified by:

forEachSelectable in interface ValuedModelPart

See Also:

• SelectableConsumer.accept(int, SelectableMapping)

getAssociationKeyFromSide

default Object getAssociationKeyFromSide(Object targetObject,
 ForeignKeyDescriptor.Nature nature,
 SharedSessionContractImplementor session)

getAssociationKeyFromSide

Object getAssociationKeyFromSide(Object targetObject,
 ForeignKeyDescriptor.Side side,
 SharedSessionContractImplementor session)

visitKeySelectables

int visitKeySelectables(int offset,
 SelectableConsumer consumer)

visitKeySelectables

default int visitKeySelectables(SelectableConsumer consumer)

visitTargetSelectables

int visitTargetSelectables(int offset,
 SelectableConsumer consumer)

visitTargetSelectables

default int visitTargetSelectables(SelectableConsumer consumer)

withKeySelectionMapping

ForeignKeyDescriptor withKeySelectionMapping(ManagedMappingType declaringType,
 TableGroupProducer declaringTableGroupProducer,
 IntFunction<SelectableMapping> selectableMappingAccess,
 org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)

Return a copy of this foreign key descriptor with the selectable mappings as provided by the given accessor.

withTargetPart

ForeignKeyDescriptor withTargetPart(ValuedModelPart targetPart)

Return a copy of this foreign key descriptor with the target part as given by the argument.

getAssociationKey

AssociationKey getAssociationKey()

hasConstraint

boolean hasConstraint()

isEmbedded

boolean isEmbedded()