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

All Methods Instance Methods Concrete Methods
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 Detail

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 Detail

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