Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.metamodel.mapping.internal.SimpleForeignKeyDescriptor

Modifier and Type	Field and Description
private AssociationKey	associationKey
private final boolean	hasConstraint
private final SimpleForeignKeyDescriptorSide	keySide
private final boolean	refersToPrimaryKey
private final SimpleForeignKeyDescriptorSide	targetSide

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

Method Summary

Modifier and Type	Method and Description
public void	addToCacheKey(MutableCacheKeyBuilder the MutableCacheKey used to add the disassembled value and the hashCode cacheKey, Object the value to disassemble value, SharedSessionContractImplementor the SharedSessionContractImplementor session) Overrides default org.hibernate.metamodel.mapping.BasicValuedMapping.addToCacheKey. Implements org.hibernate.metamodel.mapping.Bindable.addToCacheKey, org.hibernate.type.descriptor.java.JavaTypedExpressible.addToCacheKey. Add to the MutableCacheKey the values obtained disassembling the value and the hasCode generated from the disassembled value.
public void	applySqlSelections(NavigablePath navigablePath, TableGroup tableGroup, DomainResultCreationState creationState) Implements org.hibernate.metamodel.mapping.ModelPart.applySqlSelections. Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.
public void	applySqlSelections(NavigablePath navigablePath, TableGroup tableGroup, DomainResultCreationState creationState, BiConsumer<SqlSelection, JdbcMapping> selectionConsumer) Implements org.hibernate.metamodel.mapping.ModelPart.applySqlSelections. Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.
public <X, Y> int	breakDownJdbcValues(Object domainValue, int offset, X x, Y y, ModelPart.JdbcValueBiConsumer<X, Y> valueConsumer, SharedSessionContractImplementor session) Implements org.hibernate.metamodel.mapping.ModelPart.breakDownJdbcValues. Breaks down the domain value to its constituent JDBC values.
public int	compare(Object key1, Object key2) Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.compare. Compare the 2 values
public <T> DomainResult<T>	createDomainResult(NavigablePath navigablePath, TableGroup targetTableGroup, String resultVariable, DomainResultCreationState creationState) Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.createDomainResult, org.hibernate.metamodel.mapping.ModelPart.createDomainResult. Create a DomainResult for the referring-side of the fk The table group must be the one containing the target.
private <T> DomainResult<T>	createDomainResult(NavigablePath navigablePath, TableGroup tableGroup, BasicValuedModelPart selectableMapping, FetchParent fetchParent, DomainResultCreationState creationState)
public DomainResult<?>	createKeyDomainResult(NavigablePath navigablePath, TableGroup targetTableGroup, FetchParent fetchParent, DomainResultCreationState creationState) Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.createKeyDomainResult. Create a DomainResult for the referring-side of the fk The table group must be the one containing the target.
public DomainResult<?>	createKeyDomainResult(NavigablePath navigablePath, TableGroup targetTableGroup, ForeignKeyDescriptor.Nature fromSide, FetchParent fetchParent, DomainResultCreationState creationState) Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.createKeyDomainResult. Create a DomainResult for the referring-side of the fk The table group must be the one containing the target.
public DomainResult<?>	createTargetDomainResult(NavigablePath navigablePath, TableGroup targetTableGroup, FetchParent fetchParent, DomainResultCreationState creationState) Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.createTargetDomainResult. Create a DomainResult for the target-side of the fk The table group must be the one containing the target
public Object	disassemble(Object value, SharedSessionContractImplementor session) Overrides default org.hibernate.metamodel.mapping.BasicValuedMapping.disassemble. Implements org.hibernate.metamodel.mapping.Bindable.disassemble. Breaks down a value of `J` into its simple pieces.
public EntityMappingType	findContainingEntityMapping() Implements org.hibernate.metamodel.mapping.ModelPart.findContainingEntityMapping.
public <X, Y> int	forEachDisassembledJdbcValue(Object value, int offset, X x, Y y, Bindable.JdbcValuesBiConsumer<X, Y> valuesConsumer, SharedSessionContractImplementor session) Implements org.hibernate.metamodel.mapping.Bindable.forEachDisassembledJdbcValue. Like `forEachDisassembledJdbcValue(Object, Object, Object, JdbcValuesBiConsumer, SharedSessionContractImplementor)`, but additionally receives an offset by which the selectionIndex is incremented when calling `JdbcValuesBiConsumer#consume(int, Object, Object, Object, JdbcMapping)`.
public int	forEachJdbcType(int offset, IndexedConsumer<JdbcMapping> action) Implements org.hibernate.metamodel.mapping.JdbcMappingContainer.forEachJdbcType. Visit each JdbcMapping starting from the given offset
public <X, Y> int	forEachJdbcValue(Object value, int offset, X x, Y y, Bindable.JdbcValuesBiConsumer<X, Y> valuesConsumer, SharedSessionContractImplementor session) Overrides default org.hibernate.metamodel.mapping.Bindable.forEachJdbcValue. Visit each constituent JDBC value extracted from the entity instance itself.
public int	forEachSelectable(int offset, SelectableConsumer consumer) Overrides default org.hibernate.metamodel.mapping.ForeignKeyDescriptor.forEachSelectable, org.hibernate.metamodel.mapping.BasicValuedModelPart.forEachSelectable. Visits the FK "referring" columns
public Fetch	generateFetch(FetchParent The parent of the Fetch we are generating fetchParent, NavigablePath The overall path within the graph fetchablePath, FetchTiming The requested fetch timing fetchTiming, boolean selected, String resultVariable, DomainResultCreationState creationState) Implements org.hibernate.sql.results.graph.Fetchable.generateFetch. Generates a Fetch of this fetchable
public Predicate	generateJoinPredicate(TableReference targetSideReference, TableReference keySideReference, SqlAstCreationState creationState) Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.generateJoinPredicate.
public Predicate	generateJoinPredicate(TableGroup targetSideTableGroup, TableGroup keySideTableGroup, SqlAstCreationState creationState) Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.generateJoinPredicate.
public AssociationKey	getAssociationKey() Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.getAssociationKey.
public Object	getAssociationKeyFromSide(Object targetObject, ForeignKeyDescriptor.Side side, SharedSessionContractImplementor session) Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.getAssociationKeyFromSide.
public String	getColumnDefinition() Implements org.hibernate.metamodel.mapping.SqlTypedMapping.getColumnDefinition.
public String	getContainingTableExpression() Overrides default org.hibernate.metamodel.mapping.ForeignKeyDescriptor.getContainingTableExpression. Implements org.hibernate.metamodel.mapping.ValuedModelPart.getContainingTableExpression, org.hibernate.metamodel.mapping.SelectableMapping.getContainingTableExpression. The table which contains the columns mapped by this value
public String	getCustomReadExpression() Implements org.hibernate.metamodel.mapping.SelectableMapping.getCustomReadExpression. The selection's read expression accounting for formula treatment as well as `ColumnTransformer#read()`
public String	getCustomWriteExpression() Implements org.hibernate.metamodel.mapping.SelectableMapping.getCustomWriteExpression. The selection's write expression accounting `ColumnTransformer#write()`
public int	getFetchableKey() Implements org.hibernate.sql.results.graph.Fetchable.getFetchableKey. The key that identifies this Fetchable within a `FetchableContainer`.
public String	getFetchableName() Implements org.hibernate.sql.results.graph.Fetchable.getFetchableName. The name of the fetchable.
public JavaType<?>	getJavaType() Implements org.hibernate.metamodel.mapping.ModelPart.getJavaType. The Java type for this part.
public JdbcMapping	getJdbcMapping(int index) Overrides default org.hibernate.metamodel.mapping.BasicValuedModelPart.getJdbcMapping. Implements org.hibernate.metamodel.mapping.JdbcMappingContainer.getJdbcMapping.
public JdbcMapping	getJdbcMapping() Implements org.hibernate.metamodel.mapping.BasicValuedMapping.getJdbcMapping, org.hibernate.metamodel.mapping.SqlTypedMapping.getJdbcMapping. Anything that is expressible at the SQL AST level would be of basic type.
public BasicValuedModelPart	getKeyPart() Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.getKeyPart.
public ForeignKeyDescriptor.Side	getKeySide() Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.getKeySide.
public String	getKeyTable() Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.getKeyTable.
public Long	getLength() Implements org.hibernate.metamodel.mapping.SqlTypedMapping.getLength.
public FetchOptions	getMappedFetchOptions() Implements org.hibernate.sql.results.graph.Fetchable.getMappedFetchOptions. The configured fetch timing and style
public MappingType	getMappedType() Implements org.hibernate.metamodel.mapping.ValueMapping.getMappedType. Descriptor for the type of this mapping
public NavigableRole	getNavigableRole() Implements org.hibernate.metamodel.mapping.ModelPart.getNavigableRole.
public MappingType	getPartMappingType() Overrides default org.hibernate.metamodel.mapping.BasicValuedModelPart.getPartMappingType. Implements org.hibernate.metamodel.mapping.ModelPart.getPartMappingType. The type for this part.
public Integer	getPrecision() Implements org.hibernate.metamodel.mapping.SqlTypedMapping.getPrecision.
public Integer	getScale() Implements org.hibernate.metamodel.mapping.SqlTypedMapping.getScale.
public SelectableMapping	getSelectable(int columnIndex) Overrides default org.hibernate.metamodel.mapping.BasicValuedModelPart.getSelectable. Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.getSelectable. Get the selectable at the given position
public String	getSelectionExpression() Implements org.hibernate.metamodel.mapping.SelectableMapping.getSelectionExpression. The selection's expression.
public JdbcMapping	getSingleJdbcMapping() Overrides default org.hibernate.metamodel.mapping.JdbcMappingContainer.getSingleJdbcMapping, org.hibernate.metamodel.mapping.ValuedModelPart.getSingleJdbcMapping, org.hibernate.metamodel.mapping.BasicValuedModelPart.getSingleJdbcMapping.
public FetchStyle	getStyle() Implements org.hibernate.sql.results.graph.FetchStyleAccess.getStyle.
public BasicValuedModelPart	getTargetPart() Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.getTargetPart.
public ForeignKeyDescriptor.Side	getTargetSide() Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.getTargetSide.
public String	getTargetTable() Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.getTargetTable.
public FetchTiming	getTiming() Implements org.hibernate.sql.results.graph.FetchTimingAccess.getTiming.
private static TableGroup	getUnderlyingTableGroup(TableGroup tableGroup)
public boolean	hasConstraint() Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.hasConstraint.
public boolean	isEmbedded() Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.isEmbedded.
public boolean	isFormula() Implements org.hibernate.metamodel.mapping.SelectableMapping.isFormula. Is the mapping a formula instead of a physical column?
public boolean	isInsertable() Implements org.hibernate.metamodel.mapping.SelectableMapping.isInsertable.
public boolean	isKeyPart(ValuedModelPart modelPart) Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.isKeyPart.
public boolean	isNullable() Implements org.hibernate.metamodel.mapping.SelectableMapping.isNullable. Is the mapping considered nullable?
public boolean	isPartitioned() Implements org.hibernate.metamodel.mapping.SelectableMapping.isPartitioned.
public boolean	isSimpleJoinPredicate(Predicate predicate) Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.isSimpleJoinPredicate.
private boolean	isTargetTableGroup(TableGroup tableGroup)
public boolean	isUpdateable() Implements org.hibernate.metamodel.mapping.SelectableMapping.isUpdateable.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public int	visitKeySelectables(int offset, SelectableConsumer consumer) Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.visitKeySelectables.
public int	visitTargetSelectables(int offset, SelectableConsumer consumer) Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.visitTargetSelectables.
public ForeignKeyDescriptor	withKeySelectionMapping(ManagedMappingType declaringType, TableGroupProducer declaringTableGroupProducer, IntFunction<SelectableMapping> selectableMappingAccess, MappingModelCreationProcess creationProcess) Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.withKeySelectionMapping. Return a copy of this foreign key descriptor with the selectable mappings as provided by the given accessor.
public ForeignKeyDescriptor	withTargetPart(ValuedModelPart targetPart) Implements org.hibernate.metamodel.mapping.ForeignKeyDescriptor.withTargetPart. Return a copy of this foreign key descriptor with the target part as given by the argument.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

public Class SimpleForeignKeyDescriptor

Field Summary

Constructor Summary

Method Summary