Package org.hibernate.metamodel.mapping

Interface EntityValuedModelPart

All Superinterfaces:

Bindable, FetchableContainer, JdbcMappingContainer, MappingModelExpressible, ModelPart, ModelPartContainer

All Known Subinterfaces:

DeprecatedEntityStuff, EntityCollectionPart, EntityMappingType, EntityPersister, EntityValuedFetchable, InFlightEntityMappingType, Loadable, Lockable, OuterJoinLoadable, PostInsertIdentityPersister, Queryable, SQLLoadable, UniqueKeyLoadable

All Known Implementing Classes:

AbstractEntityCollectionPart, AbstractEntityPersister, AnonymousTupleEntityValuedModelPart, JoinedSubclassEntityPersister, ManyToManyCollectionPart, MockEntityPersister, OneToManyCollectionPart, ProcessorSessionFactory.EntityPersister, SingleTableEntityPersister, ToOneAttributeMapping, UnionSubclassEntityPersister

public interface EntityValuedModelPart
extends FetchableContainer

Entity-valued model part

• ManyToOne
• OneToOne
• entity-valued collection element
• entity-valued Map key

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

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

Method Summary

Modifier and Type	Method	Description
default 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.
default 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.
default 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.
default <T> DomainResult<T>	createDomainResult(NavigablePath navigablePath, TableGroup tableGroup, String resultVariable, DomainResultCreationState creationState)	Create a DomainResult for a specific reference to this ModelPart.
default Object	disassemble(Object value, SharedSessionContractImplementor session)	Breaks down a value of J into its simple pieces.
default ModelPart	findSubPart(String name)
default ModelPart	findSubPart(String name, EntityMappingType targetType)
default <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).
default int	forEachJdbcType(int offset, IndexedConsumer<JdbcMapping> action)	Visit each JdbcMapping starting from the given offset
default <X,Y> int	forEachJdbcValue(Object value, int offset, X x, Y y, Bindable.JdbcValuesBiConsumer<X,Y> consumer, SharedSessionContractImplementor session)	Visit each constituent JDBC value extracted from the entity instance itself.
default void	forEachSubPart(IndexedConsumer<ModelPart> consumer, EntityMappingType treatTarget)
EntityMappingType	getEntityMappingType()	The descriptor of the entity that is the type for this part
default int	getJdbcTypeCount()	The number of JDBC mappings
default void	visitSubParts(Consumer<ModelPart> consumer, EntityMappingType targetType)

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

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

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

getFetchable, getKeyFetchable, getNumberOfFetchableKeys, getNumberOfFetchables, getNumberOfKeyFetchables, getSelectableIndex, visitFetchables, visitFetchables, visitFetchables, visitKeyFetchables, visitKeyFetchables, visitKeyFetchables

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

getJdbcMapping, getSingleJdbcMapping

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

areEqual, asAttributeMapping, asBasicValuedModelPart, asEntityMappingType, breakDownJdbcValues, breakDownJdbcValues, decompose, decompose, findContainingEntityMapping, forEachSelectable, forEachSelectable, getJavaType, getNavigableRole, getPartMappingType, getPartName, hasPartitionedSelectionMapping, isEntityIdentifierMapping, isVirtual

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

findByPath, findByPath, forEachSubPart

Method Detail

getEntityMappingType

EntityMappingType getEntityMappingType()

The descriptor of the entity that is the type for this part

findSubPart

default ModelPart findSubPart(String name)

forEachSubPart

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

Specified by:

forEachSubPart in interface ModelPartContainer

findSubPart

default ModelPart findSubPart(String name,
                              EntityMappingType targetType)

Specified by:

findSubPart in interface ModelPartContainer

visitSubParts

default void visitSubParts(Consumer<ModelPart> consumer,
                           EntityMappingType targetType)

Specified by:

visitSubParts in interface ModelPartContainer

createDomainResult

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

default 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

default 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

getJdbcTypeCount

default 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

default 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

default 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

default 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

Parameters:

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

value - the value to disassemble

session - the SharedSessionContractImplementor

forEachDisassembledJdbcValue

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

forEachJdbcValue

default <X,Y> int forEachJdbcValue(Object value,
                                         int offset,
                                         X x,
                                         Y y,
                                         Bindable.JdbcValuesBiConsumer<X,Y> consumer,
                                         SharedSessionContractImplementor session)

Description copied from interface: Bindable

Visit each constituent JDBC value extracted from the entity instance itself. Short-hand form of calling Bindable.disassemble(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor) and piping its result to Bindable.forEachDisassembledJdbcValue(Object, int, JdbcValuesConsumer, SharedSessionContractImplementor)

Specified by:

forEachJdbcValue in interface Bindable