Package org.hibernate.metamodel.mapping.internal

Class EntityCollectionPart

java.lang.Object

org.hibernate.metamodel.mapping.internal.EntityCollectionPart

All Implemented Interfaces:

Association, Bindable, CollectionPart, EntityAssociationMapping, EntityValuedModelPart, JdbcMappingContainer, MappingModelExpressible, ModelPart, ModelPartContainer, Queryable, TableGroupJoinProducer, TableGroupProducer, EntityValuedFetchable, Fetchable, FetchableContainer, FetchOptions, FetchStyleAccess, FetchTimingAccess, JavaTypedExpressible

public class EntityCollectionPart
extends Object
implements CollectionPart, EntityAssociationMapping, EntityValuedFetchable, 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.CollectionPart

CollectionPart.Nature

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

ModelPart.JdbcValueConsumer

Constructor Summary

Constructors

Constructor	Description
EntityCollectionPart(CollectionPersister collectionDescriptor, CollectionPart.Nature nature, Value bootModelValue, NotFoundAction notFoundAction, EntityMappingType entityMappingType, MappingModelCreationProcess creationProcess)

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)
boolean	containsTableReference(String tableExpression)
<T> DomainResult<T>	createDomainResult(NavigablePath navigablePath, TableGroup tableGroup, String resultVariable, DomainResultCreationState creationState)	Create a DomainResult for a specific reference to this ModelPart.
LazyTableGroup	createRootTableGroupJoin(NavigablePath navigablePath, TableGroup lhs, String explicitSourceAlias, SqlAstJoinType requestedJoinType, boolean fetched, Consumer<Predicate> predicateConsumer, SqlAliasBaseGenerator aliasBaseGenerator, SqlExpressionResolver sqlExpressionResolver, FromClauseAccess fromClauseAccess, SqlAstCreationContext creationContext)	Create a TableGroupJoin as defined for this producer, but as root TableGroup.
TableGroup	createTableGroupInternal(boolean canUseInnerJoins, NavigablePath navigablePath, boolean fetched, String sourceAlias, SqlAliasBase sqlAliasBase, SqlExpressionResolver sqlExpressionResolver, SqlAstCreationContext creationContext)
TableGroupJoin	createTableGroupJoin(NavigablePath navigablePath, TableGroup collectionTableGroup, String explicitSourceAlias, SqlAstJoinType requestedJoinType, boolean fetched, boolean addsPredicate, SqlAliasBaseGenerator aliasBaseGenerator, SqlExpressionResolver sqlExpressionResolver, FromClauseAccess fromClauseAccess, SqlAstCreationContext creationContext)	Create a TableGroupJoin as defined for this producer The sqlAstJoinType may be null to signal that the join is for an implicit path.
EntityMappingType	findContainingEntityMapping()
ModelPart	findSubPart(String name)
ModelPart	findSubPart(String name, EntityMappingType targetType)	For an entity, this form allows for Hibernate's "implicit treat" support - meaning it should find a sub-part whether defined on the entity, its super-type or even one of its sub-types.
void	finishInitialization(CollectionPersister collectionDescriptor, Collection bootValueMapping, String fkTargetModelPartName, MappingModelCreationProcess creationProcess)
int	forEachSelectable(int offset, SelectableConsumer consumer)
EntityFetch	generateFetch(FetchParent fetchParent, NavigablePath fetchablePath, FetchTiming fetchTiming, boolean selected, String resultVariable, DomainResultCreationState creationState)	Generates a Fetch of this fetchable
EntityMappingType	getAssociatedEntityMappingType()
CollectionPersister	getCollectionDescriptor()
SqlAstJoinType	getDefaultSqlAstJoinType(TableGroup parentTableGroup)
EntityMappingType	getEntityMappingType()
JavaType<?>	getExpressibleJavaType()
Fetchable	getFetchable(int position)
String	getFetchableName()	The name of the fetchable
ForeignKeyDescriptor	getForeignKeyDescriptor()	The descriptor, allowing access to column(s), etc
JavaType<?>	getJavaType()
ModelPart	getKeyTargetMatchPart()	The model sub-part relative to the associated entity type that is the target of this association's foreign-key
String	getMappedBy()
FetchOptions	getMappedFetchOptions()	The configured fetch timing and style
CollectionPart.Nature	getNature()
NavigableRole	getNavigableRole()
int	getNumberOfFetchables()	The number of fetchables in the container
MappingType	getPartMappingType()
ForeignKeyDescriptor.Nature	getSideNature()	Indicates which "side" of the foreign-key this association describes
String	getSqlAliasStem()	Get the "stem" used as the base for generating SQL table aliases for table references that are part of the TableGroup being generated
FetchStyle	getStyle()
FetchTiming	getTiming()
boolean	incrementFetchDepth()	Should this Fetchable affect the fetch depth? E.g., composites would generally not increment the fetch depth.
boolean	isFkOptimizationAllowed()
boolean	isOptional()
boolean	isReferenceToPrimaryKey()
boolean	isSimpleJoinPredicate(Predicate predicate)	Returns whether the given predicate is a simple join predicate for this attribute.
boolean	isUnwrapProxy()
String	toString()

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

forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, getJdbcMappings

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

getPartName

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

disassemble, forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, getJdbcTypeCount, visitSubParts

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

asAttributeMapping, resolveCircularFetch

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

getKeyFetchable, getNumberOfKeyFetchables, visitFetchables, visitFetchables, visitFetchables, visitKeyFetchables, visitKeyFetchables, visitKeyFetchables

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

areEqual, forEachSelectable

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

findByPath, findSubTypesSubPart, resolveSubPart

Methods inherited from interface org.hibernate.sql.ast.tree.from.TableGroupJoinProducer

createRootTableGroupJoin, createTableGroupJoin

Constructor Detail

EntityCollectionPart

public EntityCollectionPart(CollectionPersister collectionDescriptor,
                            CollectionPart.Nature nature,
                            Value bootModelValue,
                            NotFoundAction notFoundAction,
                            EntityMappingType entityMappingType,
                            MappingModelCreationProcess creationProcess)

Method Detail

finishInitialization

public void finishInitialization(CollectionPersister collectionDescriptor,
                                 Collection bootValueMapping,
                                 String fkTargetModelPartName,
                                 MappingModelCreationProcess creationProcess)

getDefaultSqlAstJoinType

public SqlAstJoinType getDefaultSqlAstJoinType(TableGroup parentTableGroup)

Specified by:

getDefaultSqlAstJoinType in interface TableGroupJoinProducer

isSimpleJoinPredicate

public boolean isSimpleJoinPredicate(Predicate predicate)

Description copied from interface: TableGroupJoinProducer

Returns whether the given predicate is a simple join predicate for this attribute. This is useful to understand if a predicate has additional conjunctions other than the FK related predicate.

Specified by:

isSimpleJoinPredicate in interface TableGroupJoinProducer

getNature

public CollectionPart.Nature getNature()

Specified by:

getNature in interface CollectionPart

getPartMappingType

public MappingType getPartMappingType()

Specified by:

getPartMappingType in interface ModelPart

getEntityMappingType

public EntityMappingType getEntityMappingType()

Specified by:

getEntityMappingType in interface EntityValuedModelPart

getAssociatedEntityMappingType

public EntityMappingType getAssociatedEntityMappingType()

Specified by:

getAssociatedEntityMappingType in interface EntityAssociationMapping

getKeyTargetMatchPart

public ModelPart getKeyTargetMatchPart()

Description copied from interface: EntityAssociationMapping

The model sub-part relative to the associated entity type that is the target of this association's foreign-key

Specified by:

getKeyTargetMatchPart in interface EntityAssociationMapping

getJavaType

public JavaType<?> getJavaType()

Specified by:

getJavaType in interface ModelPart

getExpressibleJavaType

public JavaType<?> getExpressibleJavaType()

Specified by:

getExpressibleJavaType in interface JavaTypedExpressible

getNavigableRole

public NavigableRole getNavigableRole()

Specified by:

getNavigableRole in interface ModelPart

See Also:

ModelPart.getPartName()

getFetchableName

public String getFetchableName()

Description copied from interface: Fetchable

The name of the fetchable

Specified by:

getFetchableName in interface EntityAssociationMapping

Specified by:

getFetchableName in interface Fetchable

getMappedFetchOptions

public FetchOptions getMappedFetchOptions()

Description copied from interface: Fetchable

The configured fetch timing and style

Specified by:

getMappedFetchOptions in interface Fetchable

incrementFetchDepth

public boolean incrementFetchDepth()

Description copied from interface: Fetchable

Should this Fetchable affect the fetch depth? E.g., composites would generally not increment the fetch depth.

Specified by:

incrementFetchDepth in interface EntityAssociationMapping

Specified by:

incrementFetchDepth in interface Fetchable

See Also:

AvailableSettings.MAX_FETCH_DEPTH

findSubPart

public ModelPart findSubPart(String name)

Specified by:

findSubPart in interface EntityValuedModelPart

findSubPart

public ModelPart findSubPart(String name,
                             EntityMappingType targetType)

Description copied from interface: Queryable

For an entity, this form allows for Hibernate's "implicit treat" support - meaning it should find a sub-part whether defined on the entity, its super-type or even one of its sub-types.

Specified by:

findSubPart in interface EntityValuedModelPart

Specified by:

findSubPart in interface Queryable

isOptional

public boolean isOptional()

Specified by:

isOptional in interface EntityValuedFetchable

isUnwrapProxy

public boolean isUnwrapProxy()

Specified by:

isUnwrapProxy in interface EntityValuedFetchable

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 EntityValuedModelPart

Specified by:

createDomainResult in interface ModelPart

generateFetch

public EntityFetch 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 EntityValuedFetchable

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

forEachSelectable

public int forEachSelectable(int offset,
                             SelectableConsumer consumer)

Specified by:

forEachSelectable in interface ModelPart

breakDownJdbcValues

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

Specified by:

breakDownJdbcValues 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 EntityValuedModelPart

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 EntityValuedModelPart

Specified by:

applySqlSelections in interface ModelPart

findContainingEntityMapping

public EntityMappingType findContainingEntityMapping()

Specified by:

findContainingEntityMapping in interface ModelPart

getNumberOfFetchables

public int getNumberOfFetchables()

Description copied from interface: FetchableContainer

The number of fetchables in the container

Specified by:

getNumberOfFetchables in interface FetchableContainer

getFetchable

public Fetchable getFetchable(int position)

Specified by:

getFetchable in interface FetchableContainer

getMappedBy

public String getMappedBy()

toString

public String toString()

Overrides:

toString in class Object

getForeignKeyDescriptor

public ForeignKeyDescriptor getForeignKeyDescriptor()

Description copied from interface: Association

The descriptor, allowing access to column(s), etc

Specified by:

getForeignKeyDescriptor in interface Association

getSideNature

public ForeignKeyDescriptor.Nature getSideNature()

Description copied from interface: Association

Indicates which "side" of the foreign-key this association describes

Specified by:

getSideNature in interface Association

isReferenceToPrimaryKey

public boolean isReferenceToPrimaryKey()

Specified by:

isReferenceToPrimaryKey in interface EntityAssociationMapping

isFkOptimizationAllowed

public boolean isFkOptimizationAllowed()

Specified by:

isFkOptimizationAllowed in interface EntityAssociationMapping

getCollectionDescriptor

public CollectionPersister getCollectionDescriptor()

getStyle

public FetchStyle getStyle()

Specified by:

getStyle in interface FetchStyleAccess

getTiming

public FetchTiming getTiming()

Specified by:

getTiming in interface FetchTimingAccess

createTableGroupJoin

public TableGroupJoin createTableGroupJoin(NavigablePath navigablePath,
                                           TableGroup collectionTableGroup,
                                           String explicitSourceAlias,
                                           SqlAstJoinType requestedJoinType,
                                           boolean fetched,
                                           boolean addsPredicate,
                                           SqlAliasBaseGenerator aliasBaseGenerator,
                                           SqlExpressionResolver sqlExpressionResolver,
                                           FromClauseAccess fromClauseAccess,
                                           SqlAstCreationContext creationContext)

Description copied from interface: TableGroupJoinProducer

Create a TableGroupJoin as defined for this producer The sqlAstJoinType may be null to signal that the join is for an implicit path. When addsPredicate is true, the SQM join for the attribute contains an explicit ON clause, and is false otherwise.

Specified by:

createTableGroupJoin in interface TableGroupJoinProducer

createRootTableGroupJoin

public LazyTableGroup createRootTableGroupJoin(NavigablePath navigablePath,
                                               TableGroup lhs,
                                               String explicitSourceAlias,
                                               SqlAstJoinType requestedJoinType,
                                               boolean fetched,
                                               Consumer<Predicate> predicateConsumer,
                                               SqlAliasBaseGenerator aliasBaseGenerator,
                                               SqlExpressionResolver sqlExpressionResolver,
                                               FromClauseAccess fromClauseAccess,
                                               SqlAstCreationContext creationContext)

Description copied from interface: TableGroupJoinProducer

Create a TableGroupJoin as defined for this producer, but as root TableGroup. The main purpose of this is for correlating an association in a subquery i.e. `... alias where exists (select 1 from SomeEntity e where alias.association.attr = 1)`. The sqlAstJoinType may be null to signal that the join is for an implicit path.

Specified by:

createRootTableGroupJoin in interface TableGroupJoinProducer

createTableGroupInternal

public TableGroup createTableGroupInternal(boolean canUseInnerJoins,
                                           NavigablePath navigablePath,
                                           boolean fetched,
                                           String sourceAlias,
                                           SqlAliasBase sqlAliasBase,
                                           SqlExpressionResolver sqlExpressionResolver,
                                           SqlAstCreationContext creationContext)

getSqlAliasStem

public String getSqlAliasStem()

Description copied from interface: TableGroupProducer

Get the "stem" used as the base for generating SQL table aliases for table references that are part of the TableGroup being generated

Note that this is a metadata-ive value. It is only ever used internal to the producer producing its TableGroup.

Specified by:

getSqlAliasStem in interface TableGroupProducer

See Also:

SqlAliasBaseManager.createSqlAliasBase(java.lang.String)

containsTableReference

public boolean containsTableReference(String tableExpression)

Specified by:

containsTableReference in interface TableGroupProducer