Package org.hibernate.metamodel.mapping

Interface EntityMappingType

All Superinterfaces:

Bindable, Discriminatable, EntityValuedModelPart, FetchableContainer, FilterRestrictable, JdbcMappingContainer, Loadable, ManagedMappingType, MappingModelExpressible, MappingType, ModelPart, ModelPartContainer, Queryable, Restrictable, RootTableGroupProducer, TableGroupProducer, WhereRestrictable

All Known Subinterfaces:

EntityPersister, Loadable, Lockable, OuterJoinLoadable, PostInsertIdentityPersister, Queryable, SQLLoadable, UniqueKeyLoadable

All Known Implementing Classes:

AbstractEntityPersister, AnonymousTupleEntityValuedModelPart, JoinedSubclassEntityPersister, SingleTableEntityPersister, UnionSubclassEntityPersister

public interface EntityMappingType
extends ManagedMappingType, EntityValuedModelPart, Loadable, Restrictable, Discriminatable

Mapping of an entity

See Also:

Entity

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntityMappingType.ConstraintOrderedTableConsumer

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

Method Summary

Modifier and Type	Method	Description
default void	applyBaseRestrictions(Consumer<Predicate> predicateConsumer, TableGroup tableGroup, boolean useQualifier, Map<String,Filter> enabledFilters, Set<String> treatAsDeclarations, SqlAstCreationState creationState)	Applies the base set of restrictions.
default void	applyDiscriminator(Consumer<Predicate> predicateConsumer, String alias, TableGroup tableGroup, SqlAstCreationState creationState)
default void	applyFilterRestrictions(Consumer<Predicate> predicateConsumer, TableGroup tableGroup, boolean useQualifier, Map<String,Filter> enabledFilters, SqlAstCreationState creationState)	Applies just the Filter values enabled for the associated entity
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.
default void	applyWhereRestrictions(Consumer<Predicate> predicateConsumer, TableGroup tableGroup, boolean useQualifier, SqlAstCreationState creationState)	Apply the Where restrictions
<T> DomainResult<T>	createDomainResult(NavigablePath navigablePath, TableGroup tableGroup, String resultVariable, DomainResultCreationState creationState)	Create a DomainResult for a specific reference to this ModelPart.
default TableReference	createPrimaryTableReference(SqlAliasBase sqlAliasBase, SqlExpressionResolver sqlExpressionResolver, SqlAstCreationContext creationContext)
default TableGroup	createRootTableGroup(boolean canUseInnerJoins, NavigablePath navigablePath, String explicitSourceAlias, Supplier<Consumer<Predicate>> additionalPredicateCollectorAccess, SqlAliasBase sqlAliasBase, SqlExpressionResolver expressionResolver, FromClauseAccess fromClauseAccess, SqlAstCreationContext creationContext)
default 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
default TableReferenceJoin	createTableReferenceJoin(String joinTableExpression, SqlAliasBase sqlAliasBase, TableReference lhs, SqlExpressionResolver sqlExpressionResolver, SqlAstCreationContext creationContext)
Object	disassemble(Object value, SharedSessionContractImplementor session)
default Object[]	extractConcreteTypeStateValues(Map<AttributeMapping,DomainResultAssembler> assemblerMapping, RowProcessingState rowProcessingState)	Deprecated, for removal: This API element is subject to removal in a future version.
default EntityMappingType	findContainingEntityMapping()
AttributeMapping	findDeclaredAttributeMapping(String name)
default ModelPart	findSubPart(String name)
ModelPart	findSubPart(String name, EntityMappingType targetType)	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.
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
default int	forEachJdbcValue(Object value, Clause clause, int offset, Bindable.JdbcValuesConsumer consumer, SharedSessionContractImplementor session)
default AttributeMapping	getAttributeMapping(int position)	Retrieve an attribute by its contributor position
default List<AttributeMapping>	getAttributeMappings()	Get access to the attributes defined on this class and any supers
default String	getContributor()
Collection<AttributeMapping>	getDeclaredAttributeMappings()	Get access to the attributes defined on this class - do not access attributes defined on the super
EntityDiscriminatorMapping	getDiscriminatorMapping()
Object	getDiscriminatorValue()
String	getEntityName()
EntityPersister	getEntityPersister()	Safety-net.
default Fetchable	getFetchable(int position)
EntityIdentifierMapping	getIdentifierMapping()
default JavaType<?>	getJavaType()
default int	getJdbcTypeCount()	The number of JDBC mappings
default JavaType	getMappedJavaType()
MultiNaturalIdLoader<?>	getMultiNaturalIdLoader()	Access to performing multi-value natural-id database selection.
NaturalIdLoader<?>	getNaturalIdLoader()	Access to performing natural-id database selection.
NaturalIdMapping	getNaturalIdMapping()
default int	getNumberOfAttributeMappings()	Get the number of attributes defined on this class and any supers
default int	getNumberOfDeclaredAttributeMappings()	Get the number of attributes defined on this class - do not access attributes defined on the super
default int	getNumberOfFetchables()	The number of fetchables in the container
default MappingType	getPartMappingType()
default String	getPartName()
default EntityRepresentationStrategy	getRepresentationStrategy()
default EntityMappingType	getRootEntityDescriptor()
default String	getRootPathName()
EntityRowIdMapping	getRowIdMapping()
default 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
default SqmMultiTableInsertStrategy	getSqmMultiTableInsertStrategy()
default SqmMultiTableMutationStrategy	getSqmMultiTableMutationStrategy()
default Set<String>	getSubclassEntityNames()
String	getSubclassForDiscriminatorValue(Object value)
default int	getSubclassId()
default Collection<EntityMappingType>	getSubMappingTypes()
default EntityMappingType	getSuperMappingType()
EntityVersionMapping	getVersionMapping()
default boolean	hasSubclasses()
default boolean	isAbstract()
default boolean	isAffectedByEnabledFetchProfiles(LoadQueryInfluencers influencers)
default boolean	isAffectedByEnabledFilters(LoadQueryInfluencers influencers)
default boolean	isAffectedByEntityGraph(LoadQueryInfluencers influencers)
default boolean	isTypeOrSuperType(EntityMappingType targetType)
default boolean	isTypeOrSuperType(ManagedMappingType targetType)
default void	pruneForSubclasses(TableGroup tableGroup, Set<String> treatedEntityNames)	Adapts the table group and its table reference as well as table reference joins in a way such that unnecessary tables or joins are omitted if possible, based on the given treated entity names.
default void	visitAttributeMappings(Consumer<? super AttributeMapping> action)	Visit attributes defined on this class and any supers
default void	visitAttributeMappings(Consumer<? super AttributeMapping> action, EntityMappingType targetType)	Visit the mappings, but limited to just attributes defined in the targetType or its super-type(s) if any.
void	visitConstraintOrderedTables(EntityMappingType.ConstraintOrderedTableConsumer consumer)
void	visitDeclaredAttributeMappings(Consumer<? super AttributeMapping> action)	Visit attributes defined on this class - do not visit attributes defined on the super
void	visitQuerySpaces(Consumer<String> querySpaceConsumer)
void	visitSubParts(Consumer<ModelPart> consumer, EntityMappingType targetType)	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.
default void	visitSubTypeAttributeMappings(Consumer<? super AttributeMapping> action)	Walk this type's attributes as well as its sub-type's
default void	visitSuperTypeAttributeMappings(Consumer<? super AttributeMapping> action)	Walk this type's attributes as well as its super-type's

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

forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, getJdbcMappings

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

getEntityMappingType

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

getKeyFetchable, getNumberOfKeyFetchables, visitFetchables, visitFetchables, visitFetchables, visitKeyFetchables, visitKeyFetchables, visitKeyFetchables

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

findAttributeMapping, forEachAttributeMapping, getValue, getValues, setValue, setValues

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

areEqual, asAttributeMapping, breakDownJdbcValues, forEachSelectable, forEachSelectable, getNavigableRole

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

findByPath, findSubTypesSubPart, resolveSubPart

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

containsTableReference

Method Detail

getEntityPersister

EntityPersister getEntityPersister()

Safety-net. todo (6.0) : do we really need to expose?

getContributor

default String getContributor()

getRepresentationStrategy

default EntityRepresentationStrategy getRepresentationStrategy()

getEntityName

String getEntityName()

findContainingEntityMapping

default EntityMappingType findContainingEntityMapping()

Specified by:

findContainingEntityMapping in interface ModelPart

getPartName

default String getPartName()

Specified by:

getPartName in interface ModelPart

getRootPathName

default String getRootPathName()

Specified by:

getRootPathName in interface Loadable

getJavaType

default JavaType<?> getJavaType()

Specified by:

getJavaType in interface ManagedMappingType

Specified by:

getJavaType in interface ModelPart

getPartMappingType

default MappingType getPartMappingType()

Specified by:

getPartMappingType in interface ManagedMappingType

Specified by:

getPartMappingType in interface ModelPart

visitQuerySpaces

void visitQuerySpaces(Consumer<String> querySpaceConsumer)

findSubPart

default ModelPart findSubPart(String name)

Specified by:

findSubPart in interface EntityValuedModelPart

findSubPart

ModelPart findSubPart(String name,
                      EntityMappingType targetType)

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 EntityValuedModelPart

Specified by:

findSubPart in interface Queryable

visitSubParts

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

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 EntityValuedModelPart

Specified by:

visitSubParts in interface Queryable

createDomainResult

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

Specified by:

createDomainResult in interface ModelPart

applySqlSelections

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 EntityValuedModelPart

Specified by:

applySqlSelections in interface ModelPart

applySqlSelections

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 EntityValuedModelPart

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 EntityValuedModelPart

Specified by:

getJdbcTypeCount in interface JdbcMappingContainer

forEachJdbcType

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 EntityValuedModelPart

Specified by:

forEachJdbcType in interface JdbcMappingContainer

disassemble

Object disassemble(Object value,
                   SharedSessionContractImplementor session)

Specified by:

disassemble in interface Bindable

Specified by:

disassemble in interface EntityValuedModelPart

See Also:

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

forEachDisassembledJdbcValue

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

Specified by:

forEachDisassembledJdbcValue in interface Bindable

Specified by:

forEachDisassembledJdbcValue in interface EntityValuedModelPart

forEachJdbcValue

default int forEachJdbcValue(Object value,
                             Clause clause,
                             int offset,
                             Bindable.JdbcValuesConsumer consumer,
                             SharedSessionContractImplementor session)

Specified by:

forEachJdbcValue in interface Bindable

Specified by:

forEachJdbcValue in interface EntityValuedModelPart

getSubclassId

default int getSubclassId()

hasSubclasses

default boolean hasSubclasses()

getSubclassEntityNames

default Set<String> getSubclassEntityNames()

findDeclaredAttributeMapping

AttributeMapping findDeclaredAttributeMapping(String name)

getNumberOfDeclaredAttributeMappings

default int getNumberOfDeclaredAttributeMappings()

Get the number of attributes defined on this class - do not access attributes defined on the super

getDeclaredAttributeMappings

Collection<AttributeMapping> getDeclaredAttributeMappings()

Get access to the attributes defined on this class - do not access attributes defined on the super

visitDeclaredAttributeMappings

void visitDeclaredAttributeMappings(Consumer<? super AttributeMapping> action)

Visit attributes defined on this class - do not visit attributes defined on the super

getSuperMappingType

default EntityMappingType getSuperMappingType()

getSubMappingTypes

default Collection<EntityMappingType> getSubMappingTypes()

isTypeOrSuperType

default boolean isTypeOrSuperType(EntityMappingType targetType)

isTypeOrSuperType

default boolean isTypeOrSuperType(ManagedMappingType targetType)

getSqmMultiTableMutationStrategy

default SqmMultiTableMutationStrategy getSqmMultiTableMutationStrategy()

getSqmMultiTableInsertStrategy

default SqmMultiTableInsertStrategy getSqmMultiTableInsertStrategy()

getIdentifierMapping

EntityIdentifierMapping getIdentifierMapping()

getDiscriminatorMapping

EntityDiscriminatorMapping getDiscriminatorMapping()

getDiscriminatorValue

Object getDiscriminatorValue()

getSubclassForDiscriminatorValue

String getSubclassForDiscriminatorValue(Object value)

getVersionMapping

EntityVersionMapping getVersionMapping()

getNaturalIdMapping

NaturalIdMapping getNaturalIdMapping()

getRowIdMapping

EntityRowIdMapping getRowIdMapping()

visitAttributeMappings

default void visitAttributeMappings(Consumer<? super AttributeMapping> action,
                                    EntityMappingType targetType)

Visit the mappings, but limited to just attributes defined in the targetType or its super-type(s) if any.

"API Note:"

Passing null indicates that subclasses should be included. This matches legacy non-TREAT behavior and meets the need for EntityGraph processing

visitSubTypeAttributeMappings

default void visitSubTypeAttributeMappings(Consumer<? super AttributeMapping> action)

Walk this type's attributes as well as its sub-type's

visitSuperTypeAttributeMappings

default void visitSuperTypeAttributeMappings(Consumer<? super AttributeMapping> action)

Walk this type's attributes as well as its super-type's

visitConstraintOrderedTables

void visitConstraintOrderedTables(EntityMappingType.ConstraintOrderedTableConsumer consumer)

getRootEntityDescriptor

default EntityMappingType getRootEntityDescriptor()

pruneForSubclasses

default void pruneForSubclasses(TableGroup tableGroup,
                                Set<String> treatedEntityNames)

Adapts the table group and its table reference as well as table reference joins in a way such that unnecessary tables or joins are omitted if possible, based on the given treated entity names. The goal is to e.g. remove join inheritance "branches" or union selects that are impossible. Consider the following example: class BaseEntity {} class Sub1 extends BaseEntity {} class Sub1Sub1 extends Sub1 {} class Sub1Sub2 extends Sub1 {} class Sub2 extends BaseEntity {} class Sub2Sub1 extends Sub2 {} class Sub2Sub2 extends Sub2 {} If the treatedEntityNames only contains Sub1 or any of its subtypes, this means that Sub2 and all subtypes are impossible, thus the joins/selects for these types shall be omitted in the given table group.

Parameters:

tableGroup - The table group to prune subclass tables for

treatedEntityNames - The entity names for which path usages were registered

isAbstract

default boolean isAbstract()

visitAttributeMappings

default void visitAttributeMappings(Consumer<? super AttributeMapping> action)

Description copied from interface: ManagedMappingType

Visit attributes defined on this class and any supers

Specified by:

visitAttributeMappings in interface ManagedMappingType

extractConcreteTypeStateValues

@Deprecated(forRemoval=true)
default Object[] extractConcreteTypeStateValues(Map<AttributeMapping,DomainResultAssembler> assemblerMapping,
                                                RowProcessingState rowProcessingState)

Deprecated, for removal: This API element is subject to removal in a future version.

getNaturalIdLoader

NaturalIdLoader<?> getNaturalIdLoader()

Access to performing natural-id database selection. This is per-entity in the hierarchy

getMultiNaturalIdLoader

MultiNaturalIdLoader<?> getMultiNaturalIdLoader()

Access to performing multi-value natural-id database selection. This is per-entity in the hierarchy

isAffectedByEnabledFilters

default boolean isAffectedByEnabledFilters(LoadQueryInfluencers influencers)

Specified by:

isAffectedByEnabledFilters in interface Loadable

isAffectedByEntityGraph

default boolean isAffectedByEntityGraph(LoadQueryInfluencers influencers)

Specified by:

isAffectedByEntityGraph in interface Loadable

isAffectedByEnabledFetchProfiles

default boolean isAffectedByEnabledFetchProfiles(LoadQueryInfluencers influencers)

Specified by:

isAffectedByEnabledFetchProfiles in interface Loadable

createRootTableGroup

default 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

default 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

createPrimaryTableReference

default TableReference createPrimaryTableReference(SqlAliasBase sqlAliasBase,
                                                   SqlExpressionResolver sqlExpressionResolver,
                                                   SqlAstCreationContext creationContext)

createTableReferenceJoin

default TableReferenceJoin createTableReferenceJoin(String joinTableExpression,
                                                    SqlAliasBase sqlAliasBase,
                                                    TableReference lhs,
                                                    SqlExpressionResolver sqlExpressionResolver,
                                                    SqlAstCreationContext creationContext)

getNumberOfAttributeMappings

default int getNumberOfAttributeMappings()

Description copied from interface: ManagedMappingType

Get the number of attributes defined on this class and any supers

Specified by:

getNumberOfAttributeMappings in interface ManagedMappingType

getAttributeMappings

default List<AttributeMapping> getAttributeMappings()

Description copied from interface: ManagedMappingType

Get access to the attributes defined on this class and any supers

Specified by:

getAttributeMappings in interface ManagedMappingType

getAttributeMapping

default AttributeMapping getAttributeMapping(int position)

Description copied from interface: ManagedMappingType

Retrieve an attribute by its contributor position

Specified by:

getAttributeMapping in interface ManagedMappingType

getMappedJavaType

default JavaType getMappedJavaType()

Specified by:

getMappedJavaType in interface MappingType

getSqlAliasStem

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

getNumberOfFetchables

default int getNumberOfFetchables()

Description copied from interface: FetchableContainer

The number of fetchables in the container

Specified by:

getNumberOfFetchables in interface FetchableContainer

getFetchable

default Fetchable getFetchable(int position)

Specified by:

getFetchable in interface FetchableContainer

applyDiscriminator

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

Specified by:

applyDiscriminator in interface Discriminatable

applyFilterRestrictions

default void applyFilterRestrictions(Consumer<Predicate> predicateConsumer,
                                     TableGroup tableGroup,
                                     boolean useQualifier,
                                     Map<String,Filter> enabledFilters,
                                     SqlAstCreationState creationState)

Description copied from interface: FilterRestrictable

Applies just the Filter values enabled for the associated entity

Specified by:

applyFilterRestrictions in interface FilterRestrictable

applyBaseRestrictions

default void applyBaseRestrictions(Consumer<Predicate> predicateConsumer,
                                   TableGroup tableGroup,
                                   boolean useQualifier,
                                   Map<String,Filter> enabledFilters,
                                   Set<String> treatAsDeclarations,
                                   SqlAstCreationState creationState)

Description copied from interface: Restrictable

Applies the base set of restrictions. The impact varies based on Restrictable type - some apply restrictions for filter, where and/or discriminator

Specified by:

applyBaseRestrictions in interface Restrictable

applyWhereRestrictions

default void applyWhereRestrictions(Consumer<Predicate> predicateConsumer,
                                    TableGroup tableGroup,
                                    boolean useQualifier,
                                    SqlAstCreationState creationState)

Description copied from interface: WhereRestrictable

Apply the Where restrictions

Specified by:

applyWhereRestrictions in interface WhereRestrictable