Package org.hibernate.metamodel.mapping.internal

Class EmbeddedForeignKeyDescriptor

java.lang.Object

org.hibernate.metamodel.mapping.internal.EmbeddedForeignKeyDescriptor

All Implemented Interfaces:

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

public class EmbeddedForeignKeyDescriptor
extends Object
implements ForeignKeyDescriptor

Nested Class Summary

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.ForeignKeyDescriptor

ForeignKeyDescriptor.Nature, ForeignKeyDescriptor.Side

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

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

Field Summary

Fields inherited from interface org.hibernate.metamodel.mapping.ForeignKeyDescriptor

PART_NAME, TARGET_PART_NAME

Constructor Summary

Constructors

Constructor	Description
EmbeddedForeignKeyDescriptor(String keyTable, SelectableMappings keySelectableMappings, EmbeddableValuedModelPart keyMappingType, String targetTable, SelectableMappings targetSelectableMappings, EmbeddableValuedModelPart targetMappingType, boolean hasConstraint, MappingModelCreationProcess creationProcess)
EmbeddedForeignKeyDescriptor(EmbeddableValuedModelPart keyMappingType, EmbeddableValuedModelPart targetMappingType, String keyTable, SelectableMappings keySelectableMappings, String targetTable, SelectableMappings targetSelectableMappings, boolean hasConstraint, MappingModelCreationProcess creationProcess)

Method Summary

Modifier and Type	Method	Description
void	addToCacheKey(MutableCacheKeyBuilder cacheKey, Object value, SharedSessionContractImplementor session)	Add to the MutableCacheKey the values obtained disassembling the value and the hasCode generated from the disassembled value.
void	applySqlSelections(NavigablePath navigablePath, TableGroup tableGroup, DomainResultCreationState creationState)	Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.
void	applySqlSelections(NavigablePath navigablePath, TableGroup tableGroup, DomainResultCreationState creationState, BiConsumer<SqlSelection,JdbcMapping> selectionConsumer)	Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.
<X, Y> int	breakDownJdbcValues(Object domainValue, int offset, X x, Y y, ModelPart.JdbcValueBiConsumer<X,Y> valueConsumer, SharedSessionContractImplementor session)	Breaks down the domain value to its constituent JDBC values.
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
Object	disassemble(Object value, SharedSessionContractImplementor session)	Breaks down a value of J into its simple pieces.
EntityMappingType	findContainingEntityMapping()
<X, Y> int	forEachDisassembledJdbcValue(Object value, int offset, X x, Y y, Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer, SharedSessionContractImplementor session)	Like Bindable.forEachDisassembledJdbcValue(Object, Object, Object, JdbcValuesBiConsumer, SharedSessionContractImplementor), but additionally receives an offset by which the selectionIndex is incremented when calling Bindable.JdbcValuesBiConsumer.consume(int, Object, Object, Object, JdbcMapping).
int	forEachJdbcType(int offset, IndexedConsumer<JdbcMapping> action)	Visit each JdbcMapping starting from the given offset
Predicate	generateJoinPredicate(TableGroup targetSideTableGroup, TableGroup keySideTableGroup, SqlAstCreationState creationState)
Predicate	generateJoinPredicate(TableReference targetSideReference, TableReference keySideReference, SqlAstCreationState creationState)
AssociationKey	getAssociationKey()
Object	getAssociationKeyFromSide(Object targetObject, ForeignKeyDescriptor.Side side, SharedSessionContractImplementor session)
JavaType<?>	getJavaType()	The Java type for this part.
JdbcMapping	getJdbcMapping(int index)
EmbeddableValuedModelPart	getKeyPart()
ForeignKeyDescriptor.Side	getKeySide()
String	getKeyTable()
MappingType	getMappedType()	Descriptor for the type of this mapping
NavigableRole	getNavigableRole()
MappingType	getPartMappingType()	The type for this part.
SelectableMapping	getSelectable(int columnIndex)	Get the selectable at the given position
EmbeddableValuedModelPart	getTargetPart()
ForeignKeyDescriptor.Side	getTargetSide()
String	getTargetTable()
boolean	hasConstraint()
boolean	hasPartitionedSelectionMapping()
boolean	isEmbedded()
boolean	isKeyPart(ValuedModelPart modelPart)
boolean	isSimpleJoinPredicate(Predicate predicate)
int	visitKeySelectables(int offset, SelectableConsumer consumer)
int	visitTargetSelectables(int offset, SelectableConsumer consumer)
ForeignKeyDescriptor	withKeySelectionMapping(ManagedMappingType declaringType, TableGroupProducer declaringTableGroupProducer, IntFunction<SelectableMapping> selectableMappingAccess, 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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue

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

forEachSelectable, getAssociationKeyFromSide, getContainingTableExpression, getPart, getPartName, getSide, visitKeySelectables, visitTargetSelectables

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

areEqual, asAttributeMapping, asBasicValuedModelPart, asEntityMappingType, breakDownJdbcValues, decompose, decompose, 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, treatAs

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

isVirtual

Constructor Details

EmbeddedForeignKeyDescriptor

public EmbeddedForeignKeyDescriptor(String keyTable,
 SelectableMappings keySelectableMappings,
 EmbeddableValuedModelPart keyMappingType,
 String targetTable,
 SelectableMappings targetSelectableMappings,
 EmbeddableValuedModelPart targetMappingType,
 boolean hasConstraint,
 MappingModelCreationProcess creationProcess)

EmbeddedForeignKeyDescriptor

public EmbeddedForeignKeyDescriptor(EmbeddableValuedModelPart keyMappingType,
 EmbeddableValuedModelPart targetMappingType,
 String keyTable,
 SelectableMappings keySelectableMappings,
 String targetTable,
 SelectableMappings targetSelectableMappings,
 boolean hasConstraint,
 MappingModelCreationProcess creationProcess)

Method Details

getKeyTable

public String getKeyTable()

Specified by:

getKeyTable in interface ForeignKeyDescriptor

getTargetTable

public String getTargetTable()

Specified by:

getTargetTable in interface ForeignKeyDescriptor

getKeyPart

public EmbeddableValuedModelPart getKeyPart()

Specified by:

getKeyPart in interface ForeignKeyDescriptor

getTargetPart

public EmbeddableValuedModelPart getTargetPart()

Specified by:

getTargetPart in interface ForeignKeyDescriptor

isKeyPart

public boolean isKeyPart(ValuedModelPart modelPart)

Specified by:

isKeyPart in interface ForeignKeyDescriptor

getKeySide

public ForeignKeyDescriptor.Side getKeySide()

Specified by:

getKeySide in interface ForeignKeyDescriptor

getTargetSide

public ForeignKeyDescriptor.Side getTargetSide()

Specified by:

getTargetSide in interface ForeignKeyDescriptor

compare

public int compare(Object key1,
 Object key2)

Description copied from interface: ForeignKeyDescriptor

Compare the 2 values

Specified by:

compare in interface ForeignKeyDescriptor

withKeySelectionMapping

public ForeignKeyDescriptor withKeySelectionMapping(ManagedMappingType declaringType,
 TableGroupProducer declaringTableGroupProducer,
 IntFunction<SelectableMapping> selectableMappingAccess,
 MappingModelCreationProcess creationProcess)

Description copied from interface: ForeignKeyDescriptor

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

Specified by:

withKeySelectionMapping in interface ForeignKeyDescriptor

withTargetPart

public ForeignKeyDescriptor withTargetPart(ValuedModelPart targetPart)

Description copied from interface: ForeignKeyDescriptor

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

Specified by:

withTargetPart in interface ForeignKeyDescriptor

createKeyDomainResult

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

Description copied from interface: ForeignKeyDescriptor

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

Specified by:

createKeyDomainResult in interface ForeignKeyDescriptor

createKeyDomainResult

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

Description copied from interface: ForeignKeyDescriptor

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().

Specified by:

createKeyDomainResult in interface ForeignKeyDescriptor

createTargetDomainResult

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

Description copied from interface: ForeignKeyDescriptor

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

Specified by:

createTargetDomainResult in interface ForeignKeyDescriptor

createDomainResult

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

Description copied from interface: ForeignKeyDescriptor

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 ForeignKeyDescriptor

Specified by:

createDomainResult in interface ModelPart

applySqlSelections

public void applySqlSelections(NavigablePath navigablePath,
 TableGroup tableGroup,
 DomainResultCreationState creationState)

Description copied from interface: ModelPart

Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.

Specified by:

applySqlSelections in interface ModelPart

applySqlSelections

public void applySqlSelections(NavigablePath navigablePath,
 TableGroup tableGroup,
 DomainResultCreationState creationState,
 BiConsumer<SqlSelection,JdbcMapping> selectionConsumer)

Description copied from interface: ModelPart

Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.

Specified by:

applySqlSelections in interface ModelPart

generateJoinPredicate

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

Specified by:

generateJoinPredicate in interface ForeignKeyDescriptor

generateJoinPredicate

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

Specified by:

generateJoinPredicate in interface ForeignKeyDescriptor

isSimpleJoinPredicate

public boolean isSimpleJoinPredicate(Predicate predicate)

Specified by:

isSimpleJoinPredicate in interface ForeignKeyDescriptor

getSelectable

public SelectableMapping getSelectable(int columnIndex)

Description copied from interface: SelectableMappings

Get the selectable at the given position

Specified by:

getSelectable in interface ForeignKeyDescriptor

Specified by:

getSelectable in interface SelectableMappings

visitKeySelectables

public int visitKeySelectables(int offset,
 SelectableConsumer consumer)

Specified by:

visitKeySelectables in interface ForeignKeyDescriptor

visitTargetSelectables

public int visitTargetSelectables(int offset,
 SelectableConsumer consumer)

Specified by:

visitTargetSelectables in interface ForeignKeyDescriptor

hasConstraint

public boolean hasConstraint()

Specified by:

hasConstraint in interface ForeignKeyDescriptor

getAssociationKey

public AssociationKey getAssociationKey()

Specified by:

getAssociationKey in interface ForeignKeyDescriptor

getMappedType

public MappingType getMappedType()

Description copied from interface: ValueMapping

Descriptor for the type of this mapping

Specified by:

getMappedType in interface ValueMapping

getPartMappingType

public MappingType getPartMappingType()

Description copied from interface: ModelPart

The type for this part.

Specified by:

getPartMappingType in interface ModelPart

getJavaType

public JavaType<?> getJavaType()

Description copied from interface: ModelPart

The Java type for this part. Generally equivalent to MappingType.getMappedJavaType() relative to ModelPart.getPartMappingType()

Specified by:

getJavaType in interface ModelPart

getNavigableRole

public NavigableRole getNavigableRole()

Specified by:

getNavigableRole in interface ModelPart

See Also:

• ModelPart.getPartName()

breakDownJdbcValues

public <X,
Y> int breakDownJdbcValues(Object domainValue,
 int offset,
 X x,
 Y y,
 ModelPart.JdbcValueBiConsumer<X,Y> valueConsumer,
 SharedSessionContractImplementor session)

Description copied from interface: ModelPart

Breaks down the domain value to its constituent JDBC values. Think of it as breaking the multi-dimensional array into a visitable flat array. Additionally, it passes through the values X and Y to the consumer. Returns the amount of jdbc types that have been visited.

Specified by:

breakDownJdbcValues in interface ModelPart

getAssociationKeyFromSide

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

Specified by:

getAssociationKeyFromSide in interface ForeignKeyDescriptor

findContainingEntityMapping

public EntityMappingType findContainingEntityMapping()

Specified by:

findContainingEntityMapping in interface ModelPart

getJdbcMapping

public JdbcMapping getJdbcMapping(int index)

Specified by:

getJdbcMapping in interface JdbcMappingContainer

forEachJdbcType

public int forEachJdbcType(int offset,
 IndexedConsumer<JdbcMapping> action)

Description copied from interface: JdbcMappingContainer

Visit each JdbcMapping starting from the given offset

Specified by:

forEachJdbcType in interface JdbcMappingContainer

forEachDisassembledJdbcValue

public <X,
Y> int forEachDisassembledJdbcValue(Object value,
 int offset,
 X x,
 Y y,
 Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer,
 SharedSessionContractImplementor session)

Description copied from interface: Bindable

Like Bindable.forEachDisassembledJdbcValue(Object, Object, Object, JdbcValuesBiConsumer, SharedSessionContractImplementor), but additionally receives an offset by which the selectionIndex is incremented when calling Bindable.JdbcValuesBiConsumer.consume(int, Object, Object, Object, JdbcMapping).

Specified by:

forEachDisassembledJdbcValue in interface Bindable

disassemble

public Object disassemble(Object value,
 SharedSessionContractImplementor session)

Description copied from interface: Bindable

Breaks down a value of J into its simple pieces. E.g., an embedded value gets broken down into an array of its attribute state; a basic value converts to itself; etc.

Generally speaking, this is the form in which entity state is kept relative to a Session via EntityEntry.

 @Entity class Person {
     @Id Integer id;
     @Embedded Name name;
     int age;
 }

 @Embeddable class Name {
     String familiarName;
     String familyName;
 }
 

At the top level, we would want to disassemble a Person value, so we'd ask the Bindable for the Person entity to disassemble. Given a Person value:

 Person( id=1, name=Name( 'Steve', 'Ebersole' ), 28 )
 

this disassemble would result in a multidimensional array:

 [ ["Steve", "Ebersole"], 28 ]
 

Note that the identifier is not part of this disassembled state. Note also how the embedded value results in a sub-array.

Specified by:

disassemble in interface Bindable

See Also:

addToCacheKey

public void addToCacheKey(MutableCacheKeyBuilder cacheKey,
 Object value,
 SharedSessionContractImplementor session)

Description copied from interface: Bindable

Add to the MutableCacheKey the values obtained disassembling the value and the hasCode generated from the disassembled value.

Specified by:

addToCacheKey in interface Bindable

Specified by:

addToCacheKey in interface JavaTypedExpressible

Parameters:

cacheKey - the MutableCacheKey used to add the disassembled value and the hashCode

value - the value to disassemble

session - the SharedSessionContractImplementor

hasPartitionedSelectionMapping

public boolean hasPartitionedSelectionMapping()

Specified by:

hasPartitionedSelectionMapping in interface ModelPart

isEmbedded

public boolean isEmbedded()

Specified by:

isEmbedded in interface ForeignKeyDescriptor