Package org.hibernate.metamodel.mapping.internal

Class SimpleForeignKeyDescriptor

java.lang.Object

org.hibernate.metamodel.mapping.internal.SimpleForeignKeyDescriptor

All Implemented Interfaces:

BasicValuedMapping, BasicValuedModelPart, Bindable, ForeignKeyDescriptor, JdbcMappingContainer, MappingModelExpressible, ModelPart, SelectableMapping, SelectableMappings, SqlExpressible, SqlTypedMapping, ValuedModelPart, ValueMapping, VirtualModelPart, Fetchable, FetchOptions, FetchStyleAccess, FetchTimingAccess, JavaTypedExpressible

public class SimpleForeignKeyDescriptor
extends Object
implements ForeignKeyDescriptor, BasicValuedModelPart, FetchOptions

Nested Class Summary

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

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.IndexedJdbcValueConsumer, ModelPart.JdbcValueConsumer

Field Summary

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

PART_NAME, TARGET_PART_NAME

Constructor Summary

Constructors

Constructor	Description
SimpleForeignKeyDescriptor(BasicValuedModelPart keyModelPart, BasicValuedModelPart targetModelPart, boolean refersToPrimaryKey, boolean hasConstraint, boolean swapDirection)
SimpleForeignKeyDescriptor(ManagedMappingType keyDeclaringType, BasicValuedModelPart keyModelPart, PropertyAccess keyPropertyAccess, SelectableMapping keySelectableMapping, BasicValuedModelPart targetModelPart, boolean insertable, boolean updateable, boolean refersToPrimaryKey, boolean hasConstraint)
SimpleForeignKeyDescriptor(ManagedMappingType keyDeclaringType, SelectableMapping keySelectableMapping, BasicValuedModelPart targetModelPart, boolean refersToPrimaryKey, boolean hasConstraint)
SimpleForeignKeyDescriptor(ManagedMappingType keyDeclaringType, SelectableMapping keySelectableMapping, PropertyAccess valueAccess, BasicValuedModelPart targetModelPart, boolean refersToPrimaryKey, boolean hasConstraint, boolean swapDirection)

Method Summary

Modifier and Type	Method	Description
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.
void	breakDownJdbcValues(Object domainValue, ModelPart.JdbcValueConsumer valueConsumer, SharedSessionContractImplementor session)
int	compare(Object key1, Object key2)	Compare the 2 values
<T> DomainResult<T>	createDomainResult(NavigablePath navigablePath, TableGroup tableGroup, String resultVariable, DomainResultCreationState creationState)	Create a DomainResult for a specific reference to this ModelPart.
DomainResult<?>	createDomainResult(NavigablePath navigablePath, TableGroup tableGroup, ForeignKeyDescriptor.Nature side, FetchParent fetchParent, DomainResultCreationState creationState)
DomainResult<?>	createKeyDomainResult(NavigablePath navigablePath, TableGroup tableGroup, FetchParent fetchParent, DomainResultCreationState creationState)	Create a DomainResult for the referring-side of the fk
DomainResult<?>	createTargetDomainResult(NavigablePath navigablePath, TableGroup tableGroup, FetchParent fetchParent, DomainResultCreationState creationState)	Create a DomainResult for the target-side of the fk
Object	disassemble(Object value, SharedSessionContractImplementor session)
EntityMappingType	findContainingEntityMapping()
int	forEachDisassembledJdbcValue(Object value, int offset, Bindable.JdbcValuesConsumer valuesConsumer, SharedSessionContractImplementor session)
int	forEachJdbcType(int offset, IndexedConsumer<JdbcMapping> action)	Visit each JdbcMapping starting from the given offset
int	forEachJdbcValue(Object value, int offset, Bindable.JdbcValuesConsumer valuesConsumer, SharedSessionContractImplementor session)
int	forEachSelectable(int offset, SelectableConsumer consumer)	Visits the FK "referring" columns
Fetch	generateFetch(FetchParent fetchParent, NavigablePath fetchablePath, FetchTiming fetchTiming, boolean selected, String resultVariable, DomainResultCreationState creationState)	Generates a Fetch of this fetchable
Predicate	generateJoinPredicate(TableGroup targetSideTableGroup, TableGroup keySideTableGroup, SqlExpressionResolver sqlExpressionResolver, SqlAstCreationContext creationContext)
Predicate	generateJoinPredicate(TableReference targetSideReference, TableReference keySideReference, SqlExpressionResolver sqlExpressionResolver, SqlAstCreationContext creationContext)
AssociationKey	getAssociationKey()
Object	getAssociationKeyFromSide(Object targetObject, ForeignKeyDescriptor.Side side, SharedSessionContractImplementor session)
String	getColumnDefinition()
String	getContainingTableExpression()	The table which contains the columns mapped by this value
String	getCustomReadExpression()	The selection's read expression accounting for formula treatment as well as ColumnTransformer.read()
String	getCustomWriteExpression()	The selection's write expression accounting ColumnTransformer.write()
int	getFetchableKey()	The key that identifies this Fetchable within a FetchableContainer.
String	getFetchableName()	The name of the fetchable.
JavaType<?>	getJavaType()	The Java type for this part.
JdbcMapping	getJdbcMapping()	Anything that is expressible at the SQL AST level would be of basic type.
List<JdbcMapping>	getJdbcMappings()	The list of JDBC mappings
BasicValuedModelPart	getKeyPart()
ForeignKeyDescriptor.Side	getKeySide()
String	getKeyTable()
Long	getLength()
FetchOptions	getMappedFetchOptions()	The configured fetch timing and style
MappingType	getMappedType()	Descriptor for the type of this mapping
NavigableRole	getNavigableRole()
MappingType	getPartMappingType()	The type for this part.
Integer	getPrecision()
Integer	getScale()
SelectableMapping	getSelectable(int columnIndex)	Get the selectable at the given position
String	getSelectionExpression()	The selection's expression.
FetchStyle	getStyle()
BasicValuedModelPart	getTargetPart()
ForeignKeyDescriptor.Side	getTargetSide()
String	getTargetTable()
FetchTiming	getTiming()
boolean	hasConstraint()
boolean	isFormula()	Is the mapping a formula instead of a physical column?
boolean	isInsertable()
boolean	isNullable()	Is the mapping considered nullable?
boolean	isPartitioned()
boolean	isSimpleJoinPredicate(Predicate predicate)
boolean	isUpdateable()
String	toString()
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.

Methods inherited from class java.lang.Object

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

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

forEachSelectable, getJdbcTypeCount, hasPartitionedSelectionMapping

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

forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue

Methods inherited from interface org.hibernate.sql.results.graph.Fetchable

asAttributeMapping, incrementFetchDepth, resolveCircularFetch

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

getAssociationKeyFromSide, getPart, getPartName, getSide, visitKeySelectables, visitTargetSelectables

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

areEqual, decompose

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

getSelectableName, getSelectablePath, getWriteExpression

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

forEachInsertable, forEachUpdatable, getJdbcTypeCount

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

getExpressibleJavaType, treatAs

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

isVirtual

Constructor Detail

SimpleForeignKeyDescriptor

public SimpleForeignKeyDescriptor(ManagedMappingType keyDeclaringType,
                                  BasicValuedModelPart keyModelPart,
                                  PropertyAccess keyPropertyAccess,
                                  SelectableMapping keySelectableMapping,
                                  BasicValuedModelPart targetModelPart,
                                  boolean insertable,
                                  boolean updateable,
                                  boolean refersToPrimaryKey,
                                  boolean hasConstraint)

SimpleForeignKeyDescriptor

public SimpleForeignKeyDescriptor(BasicValuedModelPart keyModelPart,
                                  BasicValuedModelPart targetModelPart,
                                  boolean refersToPrimaryKey,
                                  boolean hasConstraint,
                                  boolean swapDirection)

SimpleForeignKeyDescriptor

public SimpleForeignKeyDescriptor(ManagedMappingType keyDeclaringType,
                                  SelectableMapping keySelectableMapping,
                                  BasicValuedModelPart targetModelPart,
                                  boolean refersToPrimaryKey,
                                  boolean hasConstraint)

SimpleForeignKeyDescriptor

public SimpleForeignKeyDescriptor(ManagedMappingType keyDeclaringType,
                                  SelectableMapping keySelectableMapping,
                                  PropertyAccess valueAccess,
                                  BasicValuedModelPart targetModelPart,
                                  boolean refersToPrimaryKey,
                                  boolean hasConstraint,
                                  boolean swapDirection)

Method Detail

getKeyTable

public String getKeyTable()

Specified by:

getKeyTable in interface ForeignKeyDescriptor

getTargetTable

public String getTargetTable()

Specified by:

getTargetTable in interface ForeignKeyDescriptor

getKeyPart

public BasicValuedModelPart getKeyPart()

Specified by:

getKeyPart in interface ForeignKeyDescriptor

getTargetPart

public BasicValuedModelPart getTargetPart()

Specified by:

getTargetPart 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

createKeyDomainResult

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

Description copied from interface: ForeignKeyDescriptor

Create a DomainResult for the referring-side of the fk

Specified by:

createKeyDomainResult in interface ForeignKeyDescriptor

createTargetDomainResult

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

Description copied from interface: ForeignKeyDescriptor

Create a DomainResult for the target-side of the fk

Specified by:

createTargetDomainResult in interface ForeignKeyDescriptor

createDomainResult

public DomainResult<?> createDomainResult(NavigablePath navigablePath,
                                          TableGroup tableGroup,
                                          ForeignKeyDescriptor.Nature side,
                                          FetchParent fetchParent,
                                          DomainResultCreationState creationState)

Specified by:

createDomainResult in interface ForeignKeyDescriptor

createDomainResult

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

Description copied from interface: ModelPart

Create a DomainResult for a specific reference to this ModelPart.

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(TableReference targetSideReference,
                                       TableReference keySideReference,
                                       SqlExpressionResolver sqlExpressionResolver,
                                       SqlAstCreationContext creationContext)

Specified by:

generateJoinPredicate in interface ForeignKeyDescriptor

generateJoinPredicate

public Predicate generateJoinPredicate(TableGroup targetSideTableGroup,
                                       TableGroup keySideTableGroup,
                                       SqlExpressionResolver sqlExpressionResolver,
                                       SqlAstCreationContext creationContext)

Specified by:

generateJoinPredicate in interface ForeignKeyDescriptor

isSimpleJoinPredicate

public boolean isSimpleJoinPredicate(Predicate predicate)

Specified by:

isSimpleJoinPredicate in interface ForeignKeyDescriptor

getPartMappingType

public MappingType getPartMappingType()

Description copied from interface: ModelPart

The type for this part.

Specified by:

getPartMappingType in interface BasicValuedModelPart

Specified by:

getPartMappingType in interface ModelPart

forEachSelectable

public int forEachSelectable(int offset,
                             SelectableConsumer consumer)

Description copied from interface: ForeignKeyDescriptor

Visits the FK "referring" columns

Specified by:

forEachSelectable in interface BasicValuedModelPart

Specified by:

forEachSelectable in interface ForeignKeyDescriptor

Specified by:

forEachSelectable in interface ModelPart

Specified by:

forEachSelectable in interface SelectableMappings

Specified by:

forEachSelectable in interface ValuedModelPart

See Also:

SelectableConsumer.accept(int, SelectableMapping)

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

findContainingEntityMapping

public EntityMappingType findContainingEntityMapping()

Specified by:

findContainingEntityMapping in interface ModelPart

disassemble

public Object disassemble(Object value,
                          SharedSessionContractImplementor session)

Specified by:

disassemble in interface Bindable

See Also:

As an example, consider the following domain model: ````

getAssociationKeyFromSide

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

Specified by:

getAssociationKeyFromSide in interface ForeignKeyDescriptor

forEachDisassembledJdbcValue

public int forEachDisassembledJdbcValue(Object value,
                                        int offset,
                                        Bindable.JdbcValuesConsumer valuesConsumer,
                                        SharedSessionContractImplementor session)

Specified by:

forEachDisassembledJdbcValue in interface Bindable

breakDownJdbcValues

public void breakDownJdbcValues(Object domainValue,
                                ModelPart.JdbcValueConsumer valueConsumer,
                                SharedSessionContractImplementor session)

Specified by:

breakDownJdbcValues in interface ModelPart

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

getJdbcMappings

public List<JdbcMapping> getJdbcMappings()

Description copied from interface: Bindable

The list of JDBC mappings

Specified by:

getJdbcMappings in interface BasicValuedMapping

Specified by:

getJdbcMappings in interface BasicValuedModelPart

Specified by:

getJdbcMappings in interface Bindable

Specified by:

getJdbcMappings in interface JdbcMappingContainer

Specified by:

getJdbcMappings in interface SelectableMappings

Specified by:

getJdbcMappings in interface ValuedModelPart

See Also:

SqlTypedMapping.getJdbcMapping()

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

forEachJdbcValue

public int forEachJdbcValue(Object value,
                            int offset,
                            Bindable.JdbcValuesConsumer valuesConsumer,
                            SharedSessionContractImplementor session)

Specified by:

forEachJdbcValue in interface Bindable

getContainingTableExpression

public String getContainingTableExpression()

Description copied from interface: ValuedModelPart

The table which contains the columns mapped by this value

Specified by:

getContainingTableExpression in interface ForeignKeyDescriptor

Specified by:

getContainingTableExpression in interface SelectableMapping

Specified by:

getContainingTableExpression in interface ValuedModelPart

getSelectionExpression

public String getSelectionExpression()

Description copied from interface: SelectableMapping

The selection's expression. This is the column name or formula

Specified by:

getSelectionExpression in interface SelectableMapping

getSelectable

public SelectableMapping getSelectable(int columnIndex)

Description copied from interface: SelectableMappings

Get the selectable at the given position

Specified by:

getSelectable in interface BasicValuedModelPart

Specified by:

getSelectable in interface ForeignKeyDescriptor

Specified by:

getSelectable in interface SelectableMappings

isFormula

public boolean isFormula()

Description copied from interface: SelectableMapping

Is the mapping a formula instead of a physical column?

Specified by:

isFormula in interface SelectableMapping

isNullable

public boolean isNullable()

Description copied from interface: SelectableMapping

Is the mapping considered nullable?

Specified by:

isNullable in interface SelectableMapping

isInsertable

public boolean isInsertable()

Specified by:

isInsertable in interface SelectableMapping

isUpdateable

public boolean isUpdateable()

Specified by:

isUpdateable in interface SelectableMapping

isPartitioned

public boolean isPartitioned()

Specified by:

isPartitioned in interface SelectableMapping

getCustomReadExpression

public String getCustomReadExpression()

Description copied from interface: SelectableMapping

The selection's read expression accounting for formula treatment as well as ColumnTransformer.read()

Specified by:

getCustomReadExpression in interface SelectableMapping

getCustomWriteExpression

public String getCustomWriteExpression()

Description copied from interface: SelectableMapping

The selection's write expression accounting ColumnTransformer.write()

Specified by:

getCustomWriteExpression in interface SelectableMapping

getColumnDefinition

public String getColumnDefinition()

Specified by:

getColumnDefinition in interface SqlTypedMapping

getLength

public Long getLength()

Specified by:

getLength in interface SqlTypedMapping

getPrecision

public Integer getPrecision()

Specified by:

getPrecision in interface SqlTypedMapping

getScale

public Integer getScale()

Specified by:

getScale in interface SqlTypedMapping

getFetchableName

public String getFetchableName()

Description copied from interface: Fetchable

The name of the fetchable. This is the part's "local name".

Specified by:

getFetchableName in interface Fetchable

See Also:

ModelPart.getNavigableRole(), NavigableRole.getLocalName()

getFetchableKey

public int getFetchableKey()

Description copied from interface: Fetchable

The key that identifies this Fetchable within a FetchableContainer. If this Fetchable is part of FetchableContainer.visitFetchables(IndexedConsumer, EntityMappingType), the values is guaranteed to be between 0 (inclusive) and FetchableContainer.getNumberOfFetchableKeys() (exclusive). Other Fetchable objects may have a special negative value.

The main intent of this key is to index e.g. Fetch objects in an array.

Specified by:

getFetchableKey in interface Fetchable

getMappedFetchOptions

public FetchOptions getMappedFetchOptions()

Description copied from interface: Fetchable

The configured fetch timing and style

Specified by:

getMappedFetchOptions in interface Fetchable

getStyle

public FetchStyle getStyle()

Specified by:

getStyle in interface FetchStyleAccess

getTiming

public FetchTiming getTiming()

Specified by:

getTiming in interface FetchTimingAccess

generateFetch

public Fetch generateFetch(FetchParent fetchParent,
                           NavigablePath fetchablePath,
                           FetchTiming fetchTiming,
                           boolean selected,
                           String resultVariable,
                           DomainResultCreationState creationState)

Description copied from interface: Fetchable

Generates a Fetch of this fetchable

Specified by:

generateFetch in interface Fetchable

Parameters:

fetchParent - The parent of the Fetch we are generating

fetchablePath - The overall path within the graph

fetchTiming - The requested fetch timing

getMappedType

public MappingType getMappedType()

Description copied from interface: ValueMapping

Descriptor for the type of this mapping

Specified by:

getMappedType in interface ValueMapping

getJdbcMapping

public JdbcMapping getJdbcMapping()

Description copied from interface: SqlExpressible

Anything that is expressible at the SQL AST level would be of basic type.

Specified by:

getJdbcMapping in interface BasicValuedMapping

Specified by:

getJdbcMapping in interface SqlExpressible

Specified by:

getJdbcMapping in interface SqlTypedMapping

toString

public String toString()

Overrides:

toString in class Object