Modifier and Type	Class and Description
public static enum	ForeignKeyDescriptor.Nature
public static interface	ForeignKeyDescriptor.Side

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

Method Summary

Modifier and Type	Method and Description
public int	compare(Object key1, Object key2) Compare the 2 values
public <T> DomainResult<T>	createDomainResult(NavigablePath navigablePath, TableGroup targetTableGroup, String resultVariable, DomainResultCreationState creationState) Redeclares 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.
public 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.
public 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.
public 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
public default int	forEachSelectable(int offset, SelectableConsumer consumer) Overrides default org.hibernate.metamodel.mapping.ModelPart.forEachSelectable, org.hibernate.metamodel.mapping.ValuedModelPart.forEachSelectable. Visits the FK "referring" columns
public Predicate	generateJoinPredicate(TableGroup targetSideTableGroup, TableGroup keySideTableGroup, SqlAstCreationState creationState)
public Predicate	generateJoinPredicate(TableReference targetSideReference, TableReference keySideReference, SqlAstCreationState creationState)
public AssociationKey	getAssociationKey()
public default Object	getAssociationKeyFromSide(Object targetObject, ForeignKeyDescriptor.Nature nature, SharedSessionContractImplementor session)
public Object	getAssociationKeyFromSide(Object targetObject, ForeignKeyDescriptor.Side side, SharedSessionContractImplementor session)
public default String	getContainingTableExpression() Implements org.hibernate.metamodel.mapping.ValuedModelPart.getContainingTableExpression. The table which contains the columns mapped by this value
public ValuedModelPart	getKeyPart()
public ForeignKeyDescriptor.Side	getKeySide()
public String	getKeyTable()
public default ValuedModelPart	getPart(ForeignKeyDescriptor.Nature nature)
public default String	getPartName() Implements org.hibernate.metamodel.mapping.ModelPart.getPartName. The local part name, which is generally the unqualified role name
public SelectableMapping	getSelectable(int columnIndex) Redeclares org.hibernate.metamodel.mapping.SelectableMappings.getSelectable. Get the selectable at the given position
public default ForeignKeyDescriptor.Side	getSide(ForeignKeyDescriptor.Nature nature)
public ValuedModelPart	getTargetPart()
public ForeignKeyDescriptor.Side	getTargetSide()
public String	getTargetTable()
public boolean	hasConstraint()
public boolean	isEmbedded()
public boolean	isKeyPart(ValuedModelPart modelPart)
public boolean	isSimpleJoinPredicate(Predicate predicate)
public int	visitKeySelectables(int offset, SelectableConsumer consumer)
public default int	visitKeySelectables(SelectableConsumer consumer)
public int	visitTargetSelectables(int offset, SelectableConsumer consumer)
public default int	visitTargetSelectables(SelectableConsumer consumer)
public 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.
public ForeignKeyDescriptor	withTargetPart(ValuedModelPart targetPart) Return a copy of this foreign key descriptor with the target part as given by the argument.

Inherited from org.hibernate.metamodel.mapping.ValuedModelPart:: forEachInsertable forEachNonFormula forEachSelectable forEachUpdatable getJdbcTypeCount getSingleJdbcMapping
Inherited from org.hibernate.metamodel.mapping.VirtualModelPart:: isVirtual

Field Detail

PART_NAME	back to summary
public static final String PART_NAME

TARGET_PART_NAME	back to summary
public static final String TARGET_PART_NAME

Method Detail

compare	back to summary
public int compare(Object key1, Object key2) Compare the 2 values

createDomainResult	back to summary
public <T> DomainResult<T> createDomainResult(NavigablePath navigablePath, TableGroup targetTableGroup, String resultVariable, DomainResultCreationState creationState) Redeclares 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. Annotations @Override

createKeyDomainResult	back to summary
public 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	back to summary
public 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 `Nature` is the association side of the foreign key i.e. `Association#getSideNature()`.

createTargetDomainResult	back to summary
public 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

forEachSelectable	back to summary
public default int forEachSelectable(int offset, SelectableConsumer consumer) Overrides default org.hibernate.metamodel.mapping.ModelPart.forEachSelectable, org.hibernate.metamodel.mapping.ValuedModelPart.forEachSelectable. Visits the FK "referring" columns Annotations @Override

forEachSelectable

back to summary

public default int forEachSelectable(int offset, SelectableConsumer consumer)

Overrides default org.hibernate.metamodel.mapping.ModelPart.forEachSelectable, org.hibernate.metamodel.mapping.ValuedModelPart.forEachSelectable.

Visits the FK "referring" columns

Annotations

@Override

generateJoinPredicate	back to summary
public Predicate generateJoinPredicate(TableGroup targetSideTableGroup, TableGroup keySideTableGroup, SqlAstCreationState creationState)

generateJoinPredicate	back to summary
public Predicate generateJoinPredicate(TableReference targetSideReference, TableReference keySideReference, SqlAstCreationState creationState)

getAssociationKey	back to summary
public AssociationKey getAssociationKey()

getAssociationKeyFromSide	back to summary
public default Object getAssociationKeyFromSide(Object targetObject, ForeignKeyDescriptor.Nature nature, SharedSessionContractImplementor session)

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

getContainingTableExpression	back to summary
public default String getContainingTableExpression() Implements org.hibernate.metamodel.mapping.ValuedModelPart.getContainingTableExpression. Doc from org.hibernate.metamodel.mapping.ValuedModelPart.getContainingTableExpression. The table which contains the columns mapped by this value Annotations @Override

getContainingTableExpression

back to summary

public default String getContainingTableExpression()

Implements org.hibernate.metamodel.mapping.ValuedModelPart.getContainingTableExpression.

Doc from org.hibernate.metamodel.mapping.ValuedModelPart.getContainingTableExpression.

The table which contains the columns mapped by this value

Annotations

@Override

getKeyPart	back to summary
public ValuedModelPart getKeyPart()

getKeySide	back to summary
public ForeignKeyDescriptor.Side getKeySide()

getKeyTable	back to summary
public String getKeyTable()

getPart	back to summary
public default ValuedModelPart getPart(ForeignKeyDescriptor.Nature nature)

getPartName	back to summary
public default String getPartName() Implements org.hibernate.metamodel.mapping.ModelPart.getPartName. Doc from org.hibernate.metamodel.mapping.ModelPart.getPartName. The local part name, which is generally the unqualified role name Annotations @Override

getPartName

back to summary

public default String getPartName()

Implements org.hibernate.metamodel.mapping.ModelPart.getPartName.

Doc from org.hibernate.metamodel.mapping.ModelPart.getPartName.

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

Annotations

@Override

getSelectable	back to summary
public SelectableMapping getSelectable(int columnIndex) Redeclares org.hibernate.metamodel.mapping.SelectableMappings.getSelectable. Doc from org.hibernate.metamodel.mapping.SelectableMappings.getSelectable. Get the selectable at the given position Annotations @Override

getSelectable

back to summary

public SelectableMapping getSelectable(int columnIndex)

Redeclares org.hibernate.metamodel.mapping.SelectableMappings.getSelectable.

Doc from org.hibernate.metamodel.mapping.SelectableMappings.getSelectable.

Get the selectable at the given position

Annotations

@Override

getSide	back to summary
public default ForeignKeyDescriptor.Side getSide(ForeignKeyDescriptor.Nature nature)

getTargetPart	back to summary
public ValuedModelPart getTargetPart()

getTargetSide	back to summary
public ForeignKeyDescriptor.Side getTargetSide()

getTargetTable	back to summary
public String getTargetTable()

hasConstraint	back to summary
public boolean hasConstraint()

isEmbedded	back to summary
public boolean isEmbedded()

isKeyPart	back to summary
public boolean isKeyPart(ValuedModelPart modelPart)

isSimpleJoinPredicate	back to summary
public boolean isSimpleJoinPredicate(Predicate predicate)

visitKeySelectables	back to summary
public int visitKeySelectables(int offset, SelectableConsumer consumer)

visitKeySelectables	back to summary
public default int visitKeySelectables(SelectableConsumer consumer)

visitTargetSelectables	back to summary
public int visitTargetSelectables(int offset, SelectableConsumer consumer)

visitTargetSelectables	back to summary
public default int visitTargetSelectables(SelectableConsumer consumer)

withKeySelectionMapping	back to summary
public 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.

withTargetPart	back to summary
public ForeignKeyDescriptor withTargetPart(ValuedModelPart targetPart) Return a copy of this foreign key descriptor with the target part as given by the argument.

org.hibernate.metamodel.mapping back to summary

public final Enum ForeignKeyDescriptor.Nature

Class Inheritance

extends Enum<ForeignKeyDescriptor.Nature>

java.lang.Object
java.lang.Enum
org.hibernate.metamodel.mapping.ForeignKeyDescriptor.Nature

Field Summary

Modifier and Type	Field and Description
public static final ForeignKeyDescriptor.Nature	KEY
public static final ForeignKeyDescriptor.Nature	TARGET

Constructor Summary

Access	Constructor and Description
private	Nature()

Method Summary

Modifier and Type	Method and Description
public ForeignKeyDescriptor.Nature	inverse()
public static ForeignKeyDescriptor.Nature	valueOf(String name)
public static ForeignKeyDescriptor.Nature[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

KEY	back to summary
public static final ForeignKeyDescriptor.Nature KEY

TARGET	back to summary
public static final ForeignKeyDescriptor.Nature TARGET

Constructor Detail

Nature	back to summary
private Nature()

Method Detail

inverse	back to summary
public ForeignKeyDescriptor.Nature inverse()

valueOf	back to summary
public static ForeignKeyDescriptor.Nature valueOf(String name)

values	back to summary
public static ForeignKeyDescriptor.Nature[] values()

public Interface ForeignKeyDescriptor

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public final Enum ForeignKeyDescriptor.Nature

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface ForeignKeyDescriptor.Side

Method Summary

Method Detail

Modifier and Type	Method and Description
public ValuedModelPart	getModelPart()
public ForeignKeyDescriptor.Nature	getNature()