Package org.hibernate.metamodel.mapping.internal

Class DiscriminatedCollectionPart

java.lang.Object

org.hibernate.metamodel.mapping.internal.DiscriminatedCollectionPart

All Implemented Interfaces:

Bindable, CollectionPart, DiscriminatedAssociationModelPart, JdbcMappingContainer, MappingModelExpressible, ModelPart, ModelPartContainer, SelectableMappings, ValuedModelPart, ValueMapping, TableGroupJoinProducer, TableGroupProducer, Fetchable, FetchableContainer, JavaTypedExpressible

public class DiscriminatedCollectionPart
extends Object
implements DiscriminatedAssociationModelPart, CollectionPart

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

Constructor Summary

Constructors

Constructor	Description
DiscriminatedCollectionPart(CollectionPart.Nature nature, CollectionPersister collectionDescriptor, JavaType<Object> baseAssociationJtd, Any bootValueMapping, AnyType anyType, 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)
<T> DomainResult<T>	createDomainResult(NavigablePath navigablePath, TableGroup tableGroup, String resultVariable, DomainResultCreationState creationState)	Create a DomainResult for a specific reference to this ModelPart.
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.
void	decompose(Object domainValue, ModelPart.JdbcValueConsumer valueConsumer, SharedSessionContractImplementor session)
Object	disassemble(Object value, SharedSessionContractImplementor session)
EntityMappingType	findContainingEntityMapping()
ModelPart	findSubPart(String name, EntityMappingType treatTargetType)
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	forEachSelectable(int offset, SelectableConsumer consumer)	Visit each contained selectable mapping.
void	forEachSubPart(IndexedConsumer<ModelPart> consumer, EntityMappingType treatTarget)
Fetch	generateFetch(FetchParent fetchParent, NavigablePath fetchablePath, FetchTiming fetchTiming, boolean selected, String resultVariable, DomainResultCreationState creationState)	Generates a Fetch of this fetchable
String	getContainingTableExpression()	The table which contains the columns mapped by this value
SqlAstJoinType	getDefaultSqlAstJoinType(TableGroup parentTableGroup)
BasicValuedModelPart	getDiscriminatorPart()
JavaType<?>	getExpressibleJavaType()
Fetchable	getFetchable(int position)
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.
int	getJdbcTypeCount()	The number of JDBC mappings
BasicValuedModelPart	getKeyPart()
FetchOptions	getMappedFetchOptions()	The configured fetch timing and style
MappingType	getMappedType()	Descriptor for the type of this mapping
CollectionPart.Nature	getNature()
NavigableRole	getNavigableRole()
int	getNumberOfFetchables()	The number of fetchables in the container
MappingType	getPartMappingType()	The type for this part.
SelectableMapping	getSelectable(int columnIndex)	Get the selectable at the given position
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
boolean	hasPartitionedSelectionMapping()
Object	resolveDiscriminatorForEntityType(EntityMappingType entityMappingType)
EntityMappingType	resolveDiscriminatorValue(Object discriminatorValue)
String	toString()
void	visitSubParts(Consumer<ModelPart> consumer, EntityMappingType treatTargetType)

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, forEachJdbcValue

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

getInclusionCheckPart, getPartName

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

isSimpleJoinPredicate

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

asAttributeMapping, incrementFetchDepth, resolveCircularFetch

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

getKeyFetchable, getNumberOfFetchableKeys, getNumberOfKeyFetchables, getSelectableIndex, visitFetchables, visitFetchables, visitFetchables, visitKeyFetchables, visitKeyFetchables, visitKeyFetchables

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

areEqual, isVirtual

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

findByPath, forEachSubPart

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

createRootTableGroupJoin, createTableGroupJoin

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

containsTableReference

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

forEachInsertable, forEachSelectable, forEachUpdatable, getJdbcMappings

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

treatAs

Constructor Detail

DiscriminatedCollectionPart

public DiscriminatedCollectionPart(CollectionPart.Nature nature,
                                   CollectionPersister collectionDescriptor,
                                   JavaType<Object> baseAssociationJtd,
                                   Any bootValueMapping,
                                   AnyType anyType,
                                   MappingModelCreationProcess creationProcess)

Method Detail

getNature

public CollectionPart.Nature getNature()

Specified by:

getNature in interface CollectionPart

getDiscriminatorPart

public BasicValuedModelPart getDiscriminatorPart()

Specified by:

getDiscriminatorPart in interface DiscriminatedAssociationModelPart

getKeyPart

public BasicValuedModelPart getKeyPart()

Specified by:

getKeyPart in interface DiscriminatedAssociationModelPart

resolveDiscriminatorValue

public EntityMappingType resolveDiscriminatorValue(Object discriminatorValue)

Specified by:

resolveDiscriminatorValue in interface DiscriminatedAssociationModelPart

resolveDiscriminatorForEntityType

public Object resolveDiscriminatorForEntityType(EntityMappingType entityMappingType)

Specified by:

resolveDiscriminatorForEntityType in interface DiscriminatedAssociationModelPart

forEachSelectable

public int forEachSelectable(int offset,
                             SelectableConsumer consumer)

Description copied from interface: SelectableMappings

Visit each contained selectable mapping. As the selectables are iterated, we call `SelectionConsumer` passing along `offset` + our current iteration index. The return is the number of selectables we directly contain

Specified by:

forEachSelectable in interface ModelPart

Specified by:

forEachSelectable in interface SelectableMappings

Specified by:

forEachSelectable in interface ValuedModelPart

See Also:

SelectableConsumer.accept(int, SelectableMapping)

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

hasPartitionedSelectionMapping

public boolean hasPartitionedSelectionMapping()

Specified by:

hasPartitionedSelectionMapping in interface ModelPart

toString

public String toString()

Overrides:

toString in class Object

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

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

getPartMappingType

public MappingType getPartMappingType()

Description copied from interface: ModelPart

The type for this part.

Specified by:

getPartMappingType in interface ModelPart

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

getMappedType

public MappingType getMappedType()

Description copied from interface: ValueMapping

Descriptor for the type of this mapping

Specified by:

getMappedType in interface ValueMapping

getExpressibleJavaType

public JavaType<?> getExpressibleJavaType()

Specified by:

getExpressibleJavaType in interface JavaTypedExpressible

Specified by:

getExpressibleJavaType in interface ValueMapping

getNavigableRole

public NavigableRole getNavigableRole()

Specified by:

getNavigableRole in interface ModelPart

See Also:

ModelPart.getPartName()

findContainingEntityMapping

public EntityMappingType findContainingEntityMapping()

Specified by:

findContainingEntityMapping in interface ModelPart

findSubPart

public ModelPart findSubPart(String name,
                             EntityMappingType treatTargetType)

Specified by:

findSubPart in interface ModelPartContainer

forEachSubPart

public void forEachSubPart(IndexedConsumer<ModelPart> consumer,
                           EntityMappingType treatTarget)

Specified by:

forEachSubPart in interface ModelPartContainer

visitSubParts

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

Specified by:

visitSubParts in interface ModelPartContainer

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

getContainingTableExpression

public String getContainingTableExpression()

Description copied from interface: ValuedModelPart

The table which contains the columns mapped by this value

Specified by:

getContainingTableExpression in interface ValuedModelPart

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

Specified by:

getJdbcTypeCount in interface SelectableMappings

Specified by:

getJdbcTypeCount in interface ValuedModelPart

getSelectable

public SelectableMapping getSelectable(int columnIndex)

Description copied from interface: SelectableMappings

Get the selectable at the given position

Specified by:

getSelectable in interface SelectableMappings

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,
                                        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

decompose

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

Specified by:

decompose in interface ModelPart

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

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

getDefaultSqlAstJoinType

public SqlAstJoinType getDefaultSqlAstJoinType(TableGroup parentTableGroup)

Specified by:

getDefaultSqlAstJoinType in interface TableGroupJoinProducer

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)