Package org.hibernate.metamodel.mapping.internal

Class PluralAttributeMappingImpl

java.lang.Object

org.hibernate.metamodel.mapping.internal.AbstractAttributeMapping

org.hibernate.metamodel.mapping.internal.PluralAttributeMappingImpl

All Implemented Interfaces:

Loadable, AttributeMapping, Bindable, FilterRestrictable, JdbcMappingContainer, MappingModelExpressible, ModelPart, ModelPartContainer, PluralAttributeMapping, PropertyBasedMapping, Queryable, Restrictable, ValueMapping, WhereRestrictable, RootTableGroupProducer, TableGroupJoinProducer, TableGroupProducer, DatabaseSnapshotContributor, Fetchable, FetchableContainer, FetchOptions, FetchStyleAccess, FetchTimingAccess, JavaTypedExpressible, MutabilityPlanExposer

public class PluralAttributeMappingImpl
extends AbstractAttributeMapping
implements PluralAttributeMapping, FetchOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PluralAttributeMappingImpl.Aware

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

Bindable.JdbcValuesConsumer

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

ModelPart.JdbcValueConsumer

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

PluralAttributeMapping.IndexMetadata

Constructor Summary

Constructors

Constructor

Description

PluralAttributeMappingImpl(String attributeName, Collection bootDescriptor, PropertyAccess propertyAccess, AttributeMetadataAccess attributeMetadataAccess, CollectionMappingType<?> collectionMappingType, int stateArrayPosition, CollectionPart elementDescriptor, CollectionPart indexDescriptor, CollectionIdentifierDescriptor identifierDescriptor, FetchTiming fetchTiming, FetchStyle fetchStyle, CascadeStyle cascadeStyle, ManagedMappingType declaringType, CollectionPersister collectionDescriptor)

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.
TableGroup	createRootTableGroup(boolean canUseInnerJoins, NavigablePath navigablePath, String explicitSourceAlias, Supplier<Consumer<Predicate>> additionalPredicateCollectorAccess, SqlAliasBase sqlAliasBase, SqlExpressionResolver expressionResolver, FromClauseAccess fromClauseAccess, SqlAstCreationContext creationContext)
TableGroup	createRootTableGroup(boolean canUseInnerJoins, NavigablePath navigablePath, String explicitSourceAlias, Supplier<Consumer<Predicate>> additionalPredicateCollectorAccess, SqlAstCreationState creationState, SqlAstCreationContext creationContext)	Create a root TableGroup as defined by this producer
TableGroup	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.
TableGroupJoin	createTableGroupJoin(NavigablePath navigablePath, TableGroup lhs, 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.
Object	disassemble(Object value, SharedSessionContractImplementor session)
ModelPart	findSubPart(String name, EntityMappingType treatTargetType)	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(Property bootProperty, Collection bootDescriptor, MappingModelCreationProcess creationProcess)
int	forEachDisassembledJdbcValue(Object value, Clause clause, int offset, Bindable.JdbcValuesConsumer valuesConsumer, SharedSessionContractImplementor session)
int	forEachJdbcType(int offset, IndexedConsumer<JdbcMapping> action)	Visit each JdbcMapping starting from the given offset
Fetch	generateFetch(FetchParent fetchParent, NavigablePath fetchablePath, FetchTiming fetchTiming, boolean selected, String resultVariable, DomainResultCreationState creationState)	Generates a Fetch of this fetchable
AttributeMetadataAccess	getAttributeMetadataAccess()	Access to AttributeMetadata
CollectionPersister	getCollectionDescriptor()
SqlAstJoinType	getDefaultSqlAstJoinType(TableGroup parentTableGroup)
CollectionPart	getElementDescriptor()
String	getFetchableName()	The name of the fetchable
CollectionIdentifierDescriptor	getIdentifierDescriptor()
CollectionPart	getIndexDescriptor()
PluralAttributeMapping.IndexMetadata	getIndexMetadata()
int	getJdbcTypeCount()	The number of JDBC mappings
ForeignKeyDescriptor	getKeyDescriptor()
OrderByFragment	getManyToManyOrderByFragment()
FetchOptions	getMappedFetchOptions()	The configured fetch timing and style
CollectionMappingType	getMappedType()	Descriptor for the type of this mapping
NavigableRole	getNavigableRole()
OrderByFragment	getOrderByFragment()
PropertyAccess	getPropertyAccess()	The getter/setter access to this attribute
String	getRootPathName()
String	getSeparateCollectionTable()
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
int	getStateArrayPosition()	The attribute's position within the container's state array
FetchStyle	getStyle()
FetchTiming	getTiming()
ValueGeneration	getValueGeneration()	The value generation strategy to use for this attribute.
boolean	isAffectedByEnabledFetchProfiles(LoadQueryInfluencers influencers)
boolean	isAffectedByEnabledFilters(LoadQueryInfluencers influencers)
boolean	isAffectedByEntityGraph(LoadQueryInfluencers influencers)
boolean	isBidirectionalAttributeName(NavigablePath fetchablePath, ToOneAttributeMapping modelPart)
boolean	isSimpleJoinPredicate(Predicate predicate)	Returns whether the given predicate is a simple join predicate for this attribute.
Fetch	resolveCircularFetch(NavigablePath fetchablePath, FetchParent fetchParent, FetchTiming fetchTiming, DomainResultCreationState creationState)	Check whether this Fetchable is considered a circular fetch.
void	setForeignKeyDescriptor(ForeignKeyDescriptor fkDescriptor)
String	toString()
void	visitSubParts(Consumer<ModelPart> consumer, EntityMappingType treatTargetType)	Like Queryable.findSubPart(java.lang.String, org.hibernate.metamodel.mapping.EntityMappingType), this form visits all parts defined on the entity, its super-types and its sub-types.

Methods inherited from class org.hibernate.metamodel.mapping.internal.AbstractAttributeMapping

getAttributeName, getDeclaringType, getJavaType, getPartMappingType

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

asAttributeMapping, asEmbeddedAttributeMapping, findContainingEntityMapping, getAttributeName, getDeclaringType, getExposedMutabilityPlan, getPartName, getValue, isEmbeddedAttributeMapping, setValue

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

forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, forEachJdbcValue, getJdbcMappings

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

visitFetchables, visitKeyFetchables

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

areEqual, forEachSelectable, forEachSelectable, getJavaType, getPartMappingType

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

applyBaseManyToManyRestrictions, applyBaseRestrictions, applyFilterRestrictions, applyWhereRestrictions, asPluralAttributeMapping, createSnapshotDomainResult, getFetchable, getKeyFetchable, getNumberOfFetchables, getNumberOfKeyFetchables, incrementFetchDepth, isPluralAttributeMapping, visitFetchables, visitFetchables, visitKeyFetchables, visitKeyFetchables

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

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

getExpressibleJavaType, treatAs

Constructor Detail

PluralAttributeMappingImpl

public PluralAttributeMappingImpl(String attributeName,
                                  Collection bootDescriptor,
                                  PropertyAccess propertyAccess,
                                  AttributeMetadataAccess attributeMetadataAccess,
                                  CollectionMappingType<?> collectionMappingType,
                                  int stateArrayPosition,
                                  CollectionPart elementDescriptor,
                                  CollectionPart indexDescriptor,
                                  CollectionIdentifierDescriptor identifierDescriptor,
                                  FetchTiming fetchTiming,
                                  FetchStyle fetchStyle,
                                  CascadeStyle cascadeStyle,
                                  ManagedMappingType declaringType,
                                  CollectionPersister collectionDescriptor)

Method Detail

isBidirectionalAttributeName

public boolean isBidirectionalAttributeName(NavigablePath fetchablePath,
                                            ToOneAttributeMapping modelPart)

Specified by:

isBidirectionalAttributeName in interface PluralAttributeMapping

finishInitialization

public void finishInitialization(Property bootProperty,
                                 Collection bootDescriptor,
                                 MappingModelCreationProcess creationProcess)

getNavigableRole

public NavigableRole getNavigableRole()

Specified by:

getNavigableRole in interface ModelPart

See Also:

ModelPart.getPartName()

getMappedType

public CollectionMappingType getMappedType()

Description copied from interface: ValueMapping

Descriptor for the type of this mapping

Specified by:

getMappedType in interface PluralAttributeMapping

Specified by:

getMappedType in interface ValueMapping

getKeyDescriptor

public ForeignKeyDescriptor getKeyDescriptor()

Specified by:

getKeyDescriptor in interface PluralAttributeMapping

getCollectionDescriptor

public CollectionPersister getCollectionDescriptor()

Specified by:

getCollectionDescriptor in interface PluralAttributeMapping

getElementDescriptor

public CollectionPart getElementDescriptor()

Specified by:

getElementDescriptor in interface PluralAttributeMapping

getIndexDescriptor

public CollectionPart getIndexDescriptor()

Specified by:

getIndexDescriptor in interface PluralAttributeMapping

getIndexMetadata

public PluralAttributeMapping.IndexMetadata getIndexMetadata()

Specified by:

getIndexMetadata in interface PluralAttributeMapping

getIdentifierDescriptor

public CollectionIdentifierDescriptor getIdentifierDescriptor()

Specified by:

getIdentifierDescriptor in interface PluralAttributeMapping

getOrderByFragment

public OrderByFragment getOrderByFragment()

Specified by:

getOrderByFragment in interface PluralAttributeMapping

getManyToManyOrderByFragment

public OrderByFragment getManyToManyOrderByFragment()

Specified by:

getManyToManyOrderByFragment in interface PluralAttributeMapping

getSeparateCollectionTable

public String getSeparateCollectionTable()

Specified by:

getSeparateCollectionTable in interface PluralAttributeMapping

containsTableReference

public boolean containsTableReference(String tableExpression)

Specified by:

containsTableReference in interface TableGroupProducer

getStateArrayPosition

public int getStateArrayPosition()

Description copied from interface: AttributeMapping

The attribute's position within the container's state array

Specified by:

getStateArrayPosition in interface AttributeMapping

getAttributeMetadataAccess

public AttributeMetadataAccess getAttributeMetadataAccess()

Description copied from interface: AttributeMapping

Access to AttributeMetadata

Specified by:

getAttributeMetadataAccess in interface AttributeMapping

getPropertyAccess

public PropertyAccess getPropertyAccess()

Description copied from interface: AttributeMapping

The getter/setter access to this attribute

Specified by:

getPropertyAccess in interface AttributeMapping

Specified by:

getPropertyAccess in interface PropertyBasedMapping

getValueGeneration

public ValueGeneration getValueGeneration()

Description copied from interface: AttributeMapping

The value generation strategy to use for this attribute.

Specified by:

getValueGeneration in interface AttributeMapping

getFetchableName

public String getFetchableName()

Description copied from interface: Fetchable

The name of the fetchable

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

getStyle

public FetchStyle getStyle()

Specified by:

getStyle in interface FetchStyleAccess

getTiming

public FetchTiming getTiming()

Specified by:

getTiming in interface FetchTimingAccess

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

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

resolveCircularFetch

public Fetch resolveCircularFetch(NavigablePath fetchablePath,
                                  FetchParent fetchParent,
                                  FetchTiming fetchTiming,
                                  DomainResultCreationState creationState)

Description copied from interface: Fetchable

Check whether this Fetchable is considered a circular fetch.

Specified by:

resolveCircularFetch in interface Fetchable

Parameters:

fetchablePath - The overall path within the graph

Returns:

The Fetch representing the circularity; null indicates the fetch is not circular

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)

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

createTableGroupJoin

public TableGroupJoin createTableGroupJoin(NavigablePath navigablePath,
                                           TableGroup lhs,
                                           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 TableGroup 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

setForeignKeyDescriptor

public void setForeignKeyDescriptor(ForeignKeyDescriptor fkDescriptor)

createRootTableGroup

public TableGroup createRootTableGroup(boolean canUseInnerJoins,
                                       NavigablePath navigablePath,
                                       String explicitSourceAlias,
                                       Supplier<Consumer<Predicate>> additionalPredicateCollectorAccess,
                                       SqlAstCreationState creationState,
                                       SqlAstCreationContext creationContext)

Description copied from interface: RootTableGroupProducer

Create a root TableGroup as defined by this producer

Specified by:

createRootTableGroup in interface RootTableGroupProducer

createRootTableGroup

public TableGroup createRootTableGroup(boolean canUseInnerJoins,
                                       NavigablePath navigablePath,
                                       String explicitSourceAlias,
                                       Supplier<Consumer<Predicate>> additionalPredicateCollectorAccess,
                                       SqlAliasBase sqlAliasBase,
                                       SqlExpressionResolver expressionResolver,
                                       FromClauseAccess fromClauseAccess,
                                       SqlAstCreationContext creationContext)

Specified by:

createRootTableGroup in interface RootTableGroupProducer

isAffectedByEnabledFilters

public boolean isAffectedByEnabledFilters(LoadQueryInfluencers influencers)

Specified by:

isAffectedByEnabledFilters in interface Loadable

isAffectedByEntityGraph

public boolean isAffectedByEntityGraph(LoadQueryInfluencers influencers)

Specified by:

isAffectedByEntityGraph in interface Loadable

isAffectedByEnabledFetchProfiles

public boolean isAffectedByEnabledFetchProfiles(LoadQueryInfluencers influencers)

Specified by:

isAffectedByEnabledFetchProfiles in interface Loadable

getRootPathName

public String getRootPathName()

Specified by:

getRootPathName in interface Loadable

findSubPart

public ModelPart findSubPart(String name,
                             EntityMappingType treatTargetType)

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 Queryable

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

breakDownJdbcValues

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

Specified by:

breakDownJdbcValues in interface ModelPart

visitSubParts

public void visitSubParts(Consumer<ModelPart> consumer,
                          EntityMappingType treatTargetType)

Description copied from interface: Queryable

Like Queryable.findSubPart(java.lang.String, org.hibernate.metamodel.mapping.EntityMappingType), this form visits all parts defined on the entity, its super-types and its sub-types.

Specified by:

visitSubParts in interface Queryable

getJdbcTypeCount

public int getJdbcTypeCount()

Description copied from interface: Bindable

The number of JDBC mappings

Specified by:

getJdbcTypeCount in interface Bindable

Specified by:

getJdbcTypeCount in interface JdbcMappingContainer

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

disassemble

public Object disassemble(Object value,
                          SharedSessionContractImplementor session)

Specified by:

disassemble in interface Bindable

See Also:

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

forEachDisassembledJdbcValue

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

Specified by:

forEachDisassembledJdbcValue in interface Bindable

toString

public String toString()

Overrides:

toString in class Object