Package org.hibernate.metamodel.mapping.internal

Class DiscriminatedCollectionPart

java.lang.Object

org.hibernate.metamodel.mapping.internal.DiscriminatedCollectionPart

All Implemented Interfaces:

Bindable, CollectionPart, Discriminable, 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.JdbcValuesBiConsumer<X,Y>, 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.JdbcValueBiConsumer<X,Y>, 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	addToCacheKey(MutableCacheKeyBuilder cacheKey, Object value, SharedSessionContractImplementor session)	Add to the MutableCacheKey the values obtained disassembling the value and the hasCode generated from the disassembled value.
void	applyDiscriminator(Consumer<Predicate> predicateConsumer, String alias, TableGroup tableGroup, SqlAstCreationState creationState)	Apply the discriminator as a predicate via the predicateConsumer
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.
<X, Y> int	breakDownJdbcValues(Object domainValue, int offset, X x, Y y, ModelPart.JdbcValueBiConsumer<X,Y> valueConsumer, SharedSessionContractImplementor session)	Breaks down the domain value to its constituent JDBC values.
<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, SqlAliasBase explicitSqlAliasBase, SqlAstJoinType sqlAstJoinType, boolean fetched, Consumer<Predicate> predicateConsumer, SqlAstCreationState creationState)	Create the "join", but return a TableGroup.
TableGroupJoin	createTableGroupJoin(NavigablePath navigablePath, TableGroup lhs, String explicitSourceAlias, SqlAliasBase explicitSqlAliasBase, SqlAstJoinType requestedJoinType, boolean fetched, boolean addsPredicate, SqlAstCreationState creationState)	Create a TableGroupJoin.
<X, Y> int	decompose(Object domainValue, int offset, X x, Y y, ModelPart.JdbcValueBiConsumer<X,Y> valueConsumer, SharedSessionContractImplementor session)	Similar to ModelPart.breakDownJdbcValues(Object, int, Object, Object, JdbcValueBiConsumer, SharedSessionContractImplementor), but this method is supposed to be used for decomposing values for assignment expressions.
Object	disassemble(Object value, SharedSessionContractImplementor session)	Breaks down a value of J into its simple pieces.
EntityMappingType	findContainingEntityMapping()
ModelPart	findSubPart(String name, EntityMappingType treatTargetType)
<X, Y> int	forEachDisassembledJdbcValue(Object value, int offset, X x, Y y, Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer, SharedSessionContractImplementor session)	Like Bindable.forEachDisassembledJdbcValue(Object, Object, Object, JdbcValuesBiConsumer, SharedSessionContractImplementor), but additionally receives an offset by which the selectionIndex is incremented when calling Bindable.JdbcValuesBiConsumer.consume(int, Object, Object, Object, JdbcMapping).
int	forEachJdbcType(int offset, IndexedConsumer<JdbcMapping> action)	Visit each JdbcMapping starting from the given offset
int	forEachSelectable(int offset, SelectableConsumer consumer)	Visits each selectable mapping with the selectable index offset by the given value.
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
PluralAttributeMapping	getCollectionAttribute()
String	getContainingTableExpression()	The table which contains the columns mapped by this value
SqlAstJoinType	getDefaultSqlAstJoinType(TableGroup parentTableGroup)
DiscriminatorMapping	getDiscriminatorMapping()
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.
JdbcMapping	getJdbcMapping(int index)
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, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue

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

getInclusionCheckPart, getPartName

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

getDiscriminatorPart, isSimpleJoinPredicate

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

asAttributeMapping, incrementFetchDepth, isSelectable, 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, asBasicValuedModelPart, asEntityMappingType, breakDownJdbcValues, decompose, isEntityIdentifierMapping, isVirtual

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

findByPath, findByPath, forEachSubPart

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

determineSqlJoinType

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

containsTableReference

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

forEachInsertable, forEachNonFormula, forEachSelectable, forEachUpdatable, getSingleJdbcMapping

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

treatAs

Constructor Details

DiscriminatedCollectionPart

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

Method Details

getNature

public CollectionPart.Nature getNature()

Specified by:

getNature in interface CollectionPart

getCollectionAttribute

public PluralAttributeMapping getCollectionAttribute()

Specified by:

getCollectionAttribute in interface CollectionPart

getDiscriminatorMapping

public DiscriminatorMapping getDiscriminatorMapping()

Specified by:

getDiscriminatorMapping in interface Discriminable

applyDiscriminator

public void applyDiscriminator(Consumer<Predicate> predicateConsumer,
 String alias,
 TableGroup tableGroup,
 SqlAstCreationState creationState)

Description copied from interface: Discriminable

Apply the discriminator as a predicate via the predicateConsumer

Specified by:

applyDiscriminator in interface Discriminable

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: ModelPart

Visits each selectable mapping with the selectable index offset by the given value. Returns the amount of jdbc types that have been visited.

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

getJdbcMapping

public JdbcMapping getJdbcMapping(int index)

Specified by:

getJdbcMapping in interface JdbcMappingContainer

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)

Description copied from interface: Bindable

Breaks down a value of J into its simple pieces. E.g., an embedded value gets broken down into an array of its attribute state; a basic value converts to itself; etc.

Generally speaking, this is the form in which entity state is kept relative to a Session via EntityEntry.

 @Entity class Person {
     @Id Integer id;
     @Embedded Name name;
     int age;
 }

 @Embeddable class Name {
     String familiarName;
     String familyName;
 }
 

At the top level, we would want to disassemble a Person value, so we'd ask the Bindable for the Person entity to disassemble. Given a Person value:

 Person( id=1, name=Name( 'Steve', 'Ebersole' ), 28 )
 

this disassemble would result in a multidimensional array:

 [ ["Steve", "Ebersole"], 28 ]
 

Note that the identifier is not part of this disassembled state. Note also how the embedded value results in a sub-array.

Specified by:

disassemble in interface Bindable

See Also:

addToCacheKey

public void addToCacheKey(MutableCacheKeyBuilder cacheKey,
 Object value,
 SharedSessionContractImplementor session)

Description copied from interface: Bindable

Add to the MutableCacheKey the values obtained disassembling the value and the hasCode generated from the disassembled value.

Specified by:

addToCacheKey in interface Bindable

Specified by:

addToCacheKey in interface JavaTypedExpressible

Parameters:

cacheKey - the MutableCacheKey used to add the disassembled value and the hashCode

value - the value to disassemble

session - the SharedSessionContractImplementor

forEachDisassembledJdbcValue

public <X,
Y> int forEachDisassembledJdbcValue(Object value,
 int offset,
 X x,
 Y y,
 Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer,
 SharedSessionContractImplementor session)

Description copied from interface: Bindable

Like Bindable.forEachDisassembledJdbcValue(Object, Object, Object, JdbcValuesBiConsumer, SharedSessionContractImplementor), but additionally receives an offset by which the selectionIndex is incremented when calling Bindable.JdbcValuesBiConsumer.consume(int, Object, Object, Object, JdbcMapping).

Specified by:

forEachDisassembledJdbcValue in interface Bindable

breakDownJdbcValues

public <X,
Y> int breakDownJdbcValues(Object domainValue,
 int offset,
 X x,
 Y y,
 ModelPart.JdbcValueBiConsumer<X,Y> valueConsumer,
 SharedSessionContractImplementor session)

Description copied from interface: ModelPart

Breaks down the domain value to its constituent JDBC values. Think of it as breaking the multi-dimensional array into a visitable flat array. Additionally, it passes through the values X and Y to the consumer. Returns the amount of jdbc types that have been visited.

Specified by:

breakDownJdbcValues in interface ModelPart

decompose

public <X,
Y> int decompose(Object domainValue,
 int offset,
 X x,
 Y y,
 ModelPart.JdbcValueBiConsumer<X,Y> valueConsumer,
 SharedSessionContractImplementor session)

Description copied from interface: ModelPart

Similar to ModelPart.breakDownJdbcValues(Object, int, Object, Object, JdbcValueBiConsumer, SharedSessionContractImplementor), but this method is supposed to be used for decomposing values for assignment expressions. Returns the amount of jdbc types that have been visited.

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,
 SqlAliasBase explicitSqlAliasBase,
 SqlAstJoinType requestedJoinType,
 boolean fetched,
 boolean addsPredicate,
 SqlAstCreationState creationState)

Description copied from interface: TableGroupJoinProducer

Create a TableGroupJoin.

Specified by:

createTableGroupJoin in interface TableGroupJoinProducer

Parameters:

navigablePath - The NavigablePath to the join

lhs - The join's (L)eft-(H)and (S)ide

explicitSqlAliasBase - A specific SqlAliasBase to use. May be null indicating one should be created using the SqlAliasBaseGenerator from creationState

requestedJoinType - An explicit join-type. May be null to signal that the join is for an implicit path.

addsPredicate - Indicates there are explicit, additional predicates (from an SQM tree ON/WITH clause)

createRootTableGroupJoin

public TableGroup createRootTableGroupJoin(NavigablePath navigablePath,
 TableGroup lhs,
 String explicitSourceAlias,
 SqlAliasBase explicitSqlAliasBase,
 SqlAstJoinType sqlAstJoinType,
 boolean fetched,
 Consumer<Predicate> predicateConsumer,
 SqlAstCreationState creationState)

Description copied from interface: TableGroupJoinProducer

Create the "join", but return a TableGroup. Intended for creating sub-query correlations. E.g., given

     from SomeEntity e
     where exists (
         select 1
         from AnotherEntity a
         where e.association.attr = 1
     )
 

We call this for the `e.association` path.

Specified by:

createRootTableGroupJoin in interface TableGroupJoinProducer

Parameters:

navigablePath - The NavigablePath to the join

lhs - The join's (L)eft-(H)and (S)ide

explicitSqlAliasBase - A specific SqlAliasBase to use. May be null indicating one should be created using the SqlAliasBaseGenerator from creationState

sqlAstJoinType - An explicit join-type. May be null to signal that the join is for an implicit path.

predicateConsumer - Consumer for additional predicates from the producer's mapping.

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)