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:

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

public class PluralAttributeMappingImpl
extends AbstractAttributeMapping
implements PluralAttributeMapping, FetchProfileAffectee, FetchOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PluralAttributeMappingImpl.Aware	Allows callback after creation of the attribute mapping.

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

ModelPart.JdbcValueBiConsumer<X,Y>, ModelPart.JdbcValueConsumer

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

PluralAttributeMapping.IndexMetadata, PluralAttributeMapping.PredicateConsumer

Constructor Summary

Constructors

Modifier	Constructor	Description
	PluralAttributeMappingImpl(String attributeName, Collection bootDescriptor, PropertyAccess propertyAccess, AttributeMetadata attributeMetadata, CollectionMappingType<?> collectionMappingType, int stateArrayPosition, int fetchableIndex, CollectionPart elementDescriptor, CollectionPart indexDescriptor, CollectionIdentifierDescriptor identifierDescriptor, FetchTiming fetchTiming, FetchStyle fetchStyle, CascadeStyle cascadeStyle, ManagedMappingType declaringType, CollectionPersister collectionDescriptor, MappingModelCreationProcess creationProcess)
protected	PluralAttributeMappingImpl(PluralAttributeMappingImpl original)	For Hibernate Reactive

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	applySoftDeleteRestrictions(TableGroup tableGroup, PluralAttributeMapping.PredicateConsumer 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.
protected Fetch	buildDelayedCollectionFetch(NavigablePath fetchedPath, PluralAttributeMapping fetchedAttribute, FetchParent fetchParent, DomainResult<?> collectionKeyResult)	For Hibernate Reactive
protected Fetch	buildEagerCollectionFetch(NavigablePath fetchedPath, PluralAttributeMapping fetchedAttribute, TableGroup collectionTableGroup, FetchParent fetchParent, DomainResultCreationState creationState)	For Hibernate Reactive
protected Fetch	buildSelectEagerCollectionFetch(NavigablePath fetchedPath, PluralAttributeMapping fetchedAttribute, DomainResult<?> collectionKeyDomainResult, FetchParent fetchParent)	For Hibernate Reactive
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, SqlAliasBase explicitSqlAliasBase, Supplier<Consumer<Predicate>> additionalPredicateCollectorAccess, SqlAstCreationState creationState)	Create a root TableGroup as defined by this producer
TableGroup	createRootTableGroupJoin(NavigablePath navigablePath, TableGroup lhs, String explicitSourceAlias, SqlAliasBase explicitSqlAliasBase, SqlAstJoinType requestedJoinType, 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.
SqlAstJoinType	determineSqlJoinType(TableGroup lhs, SqlAstJoinType requestedJoinType, boolean fetched)
Object	disassemble(Object value, SharedSessionContractImplementor session)	Breaks down a value of J into its simple pieces.
ModelPart	findSubPart(String name, EntityMappingType treatTargetType)
void	finishInitialization(Property bootProperty, Collection bootDescriptor, MappingModelCreationProcess creationProcess)
<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
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
AttributeMetadata	getAttributeMetadata()	Access to AttributeMetadata
int	getBatchSize()
CollectionPersister	getCollectionDescriptor()
String	getContainingTableExpression()	The table which contains the columns mapped by this value
SqlAstJoinType	getDefaultSqlAstJoinType(TableGroup parentTableGroup)
CollectionPart	getElementDescriptor()
String	getFetchableName()	The name of the fetchable.
Generator	getGenerator()	The value generation strategy to use for this attribute.
CollectionIdentifierDescriptor	getIdentifierDescriptor()
CollectionPart	getIndexDescriptor()
PluralAttributeMapping.IndexMetadata	getIndexMetadata()
JdbcMapping	getJdbcMapping(int index)
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()	The name for this loadable, for use as the root when generating relative paths
SelectableMapping	getSelectable(int columnIndex)	Get the selectable at the given position
String	getSeparateCollectionTable()
SoftDeleteMapping	getSoftDeleteMapping()	Mapping for soft-delete support, or null if soft-delete not defined
TableDetails	getSoftDeleteTableDetails()
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()
boolean	hasPartitionedSelectionMapping()
boolean	isAffectedByEnabledFetchProfiles(LoadQueryInfluencers influencers)	Whether any of the LoadQueryInfluencers.getEnabledFetchProfileNames() apply to this loadable
boolean	isAffectedByEnabledFilters(LoadQueryInfluencers influencers)	Whether any of the "influencers" affect this loadable.
boolean	isAffectedByEntityGraph(LoadQueryInfluencers influencers)	Whether the effective entity-graph applies to this loadable
boolean	isBidirectionalAttributeName(NavigablePath fetchablePath, ToOneAttributeMapping modelPart)
boolean	isSimpleJoinPredicate(Predicate predicate)	Returns whether the given predicate is a simple join predicate for this attribute.
void	registerAffectingFetchProfile(String fetchProfileName)	Register the profile name with the entity/collection
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)

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

getAttributeName, getDeclaringType, getFetchableKey, 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, compare, findContainingEntityMapping, getAttributeName, getDeclaringType, getExposedMutabilityPlan, getPartName, getValue, isEmbeddedAttributeMapping, setValue

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

forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue

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

getFetchableKey, isSelectable

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

getSelectableIndex, visitFetchables, visitKeyFetchables

Methods inherited from interface org.hibernate.loader.ast.spi.Loadable

isAffectedByInfluencers, isNotAffectedByInfluencers

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

areEqual, asEntityMappingType, breakDownJdbcValues, decompose, decompose, getJavaType, getPartMappingType, isEntityIdentifierMapping, isVirtual

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

findByPath, findByPath, forEachSubPart

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

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

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

forEachInsertable, forEachNonFormula, forEachSelectable, forEachSelectable, forEachUpdatable, getSingleJdbcMapping

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

getExpressibleJavaType, treatAs

Constructor Detail

PluralAttributeMappingImpl

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

PluralAttributeMappingImpl

protected PluralAttributeMappingImpl(PluralAttributeMappingImpl original)

For Hibernate Reactive

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

getSoftDeleteMapping

public SoftDeleteMapping getSoftDeleteMapping()

Description copied from interface: PluralAttributeMapping

Mapping for soft-delete support, or null if soft-delete not defined

Specified by:

getSoftDeleteMapping in interface PluralAttributeMapping

Specified by:

getSoftDeleteMapping in interface SoftDeletableModelPart

getSoftDeleteTableDetails

public TableDetails getSoftDeleteTableDetails()

Specified by:

getSoftDeleteTableDetails in interface SoftDeletableModelPart

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

getAttributeMetadata

public AttributeMetadata getAttributeMetadata()

Description copied from interface: AttributeMapping

Access to AttributeMetadata

Specified by:

getAttributeMetadata 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

getGenerator

public Generator getGenerator()

Description copied from interface: AttributeMapping

The value generation strategy to use for this attribute.

Specified by:

getGenerator in interface AttributeMapping

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()

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

hasPartitionedSelectionMapping

public boolean hasPartitionedSelectionMapping()

Specified by:

hasPartitionedSelectionMapping in interface ModelPart

applySoftDeleteRestrictions

public void applySoftDeleteRestrictions(TableGroup tableGroup,
                                        PluralAttributeMapping.PredicateConsumer predicateConsumer)

Specified by:

applySoftDeleteRestrictions in interface PluralAttributeMapping

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

buildDelayedCollectionFetch

protected Fetch buildDelayedCollectionFetch(NavigablePath fetchedPath,
                                            PluralAttributeMapping fetchedAttribute,
                                            FetchParent fetchParent,
                                            DomainResult<?> collectionKeyResult)

For Hibernate Reactive

buildSelectEagerCollectionFetch

protected Fetch buildSelectEagerCollectionFetch(NavigablePath fetchedPath,
                                                PluralAttributeMapping fetchedAttribute,
                                                DomainResult<?> collectionKeyDomainResult,
                                                FetchParent fetchParent)

For Hibernate Reactive

buildEagerCollectionFetch

protected Fetch buildEagerCollectionFetch(NavigablePath fetchedPath,
                                          PluralAttributeMapping fetchedAttribute,
                                          TableGroup collectionTableGroup,
                                          FetchParent fetchParent,
                                          DomainResultCreationState creationState)

For Hibernate Reactive

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

determineSqlJoinType

public SqlAstJoinType determineSqlJoinType(TableGroup lhs,
                                           SqlAstJoinType requestedJoinType,
                                           boolean fetched)

Specified by:

determineSqlJoinType in interface TableGroupJoinProducer

createRootTableGroupJoin

public TableGroup createRootTableGroupJoin(NavigablePath navigablePath,
                                           TableGroup lhs,
                                           String explicitSourceAlias,
                                           SqlAliasBase explicitSqlAliasBase,
                                           SqlAstJoinType requestedJoinType,
                                           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

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

setForeignKeyDescriptor

public void setForeignKeyDescriptor(ForeignKeyDescriptor fkDescriptor)

createRootTableGroup

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

Description copied from interface: RootTableGroupProducer

Create a root TableGroup as defined by this producer

Specified by:

createRootTableGroup in interface RootTableGroupProducer

Parameters:

canUseInnerJoins - Whether inner joins can be used when creating table-references within this group

navigablePath - The overall NavigablePath for the root

explicitSourceAlias - The alias, if one, explicitly provided by the application for this root

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

additionalPredicateCollectorAccess - Collector for additional predicates associated with this producer

creationState - The creation state

getBatchSize

public int getBatchSize()

Specified by:

getBatchSize in interface Loadable

isAffectedByEnabledFilters

public boolean isAffectedByEnabledFilters(LoadQueryInfluencers influencers)

Description copied from interface: Loadable

Whether any of the "influencers" affect this loadable.

Specified by:

isAffectedByEnabledFilters in interface Loadable

isAffectedByEntityGraph

public boolean isAffectedByEntityGraph(LoadQueryInfluencers influencers)

Description copied from interface: Loadable

Whether the effective entity-graph applies to this loadable

Specified by:

isAffectedByEntityGraph in interface Loadable

registerAffectingFetchProfile

public void registerAffectingFetchProfile(String fetchProfileName)

Description copied from interface: FetchProfileAffectee

Register the profile name with the entity/collection

Specified by:

registerAffectingFetchProfile in interface FetchProfileAffectee

isAffectedByEnabledFetchProfiles

public boolean isAffectedByEnabledFetchProfiles(LoadQueryInfluencers influencers)

Description copied from interface: Loadable

Whether any of the LoadQueryInfluencers.getEnabledFetchProfileNames() apply to this loadable

Specified by:

isAffectedByEnabledFetchProfiles in interface Loadable

getRootPathName

public String getRootPathName()

Description copied from interface: Loadable

The name for this loadable, for use as the root when generating relative paths

Specified by:

getRootPathName in interface Loadable

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

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

visitSubParts

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

Specified by:

visitSubParts in interface ModelPartContainer

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

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)

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:

EntityEntry

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

toString

public String toString()

Overrides:

toString in class Object