Package org.hibernate.metamodel.model.domain.internal

Class MappingMetamodelImpl

java.lang.Object

org.hibernate.internal.QueryParameterBindingTypeResolverImpl

org.hibernate.metamodel.model.domain.internal.MappingMetamodelImpl

All Implemented Interfaces:

Metamodel, Serializable, Metamodel, MappingMetamodel, JpaMetamodel, MappingMetamodelImplementor, MetamodelImplementor, QueryParameterBindingTypeResolver

public class MappingMetamodelImpl
extends QueryParameterBindingTypeResolverImpl
implements MappingMetamodelImplementor, MetamodelImplementor, Serializable

Implementation of the JPA-defined contract Metamodel.

Really more of the mapping model than the domain model, though it does have reference to the JpaMetamodel.

Author:

Steve Ebersole, Emmanuel Bernard, Andrea Boriero

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MappingMetamodelImpl(TypeConfiguration typeConfiguration, ServiceRegistry serviceRegistry)

Method Summary

Modifier and Type	Method	Description
<T> void	addNamedEntityGraph(String graphName, RootGraphImplementor<T> entityGraph)
void	close()
CollectionPersister	collectionPersister(String role)	Get the persister object for a collection role.
Map<String,CollectionPersister>	collectionPersisters()	Get all collection persisters as a Map, which collection role as the key and the persister is the value.
RootGraph<?>	defaultGraph(Class entityJavaType)
RootGraph<?>	defaultGraph(String entityName)
RootGraph<?>	defaultGraph(EntityDomainType<?> entityDomainType)
RootGraph<?>	defaultGraph(EntityPersister entityDescriptor)
<X> EmbeddableDomainType<X>	embeddable(Class<X> cls)	Return the metamodel embeddable type representing the embeddable class.
<X> EmbeddableDomainType<X>	embeddable(String embeddableName)	Access to an embeddable type from FQN
<X> EntityDomainType<X>	entity(Class<X> cls)	Return the metamodel entity type representing the entity.
<X> EntityDomainType<X>	entity(String entityName)	Access to an entity supporting Hibernate's entity-name feature
EntityPersister	entityPersister(Class<?> entityClass)	Locate the persister for an entity by the entity class.
EntityPersister	entityPersister(String entityName)	Locate the persister for an entity by the entity-name
Map<String,EntityPersister>	entityPersisters()	Get all entity persisters as a Map, which entity name its the key and the persister is the value.
<E extends Enum<E>> E	enumValue(EnumJavaType<E> enumType, String enumValueName)
CollectionPersister	findCollectionDescriptor(String role)	Find a collection mapping descriptor based on its role.
CollectionPersister	findCollectionDescriptor(NavigableRole role)	Find a collection mapping descriptor based on its role.
EntityPersister	findEntityDescriptor(Class<?> entityJavaType)	Find an entity mapping descriptor based on its Class.
EntityPersister	findEntityDescriptor(String entityName)	Find an entity mapping descriptor based on its Hibernate entity-name.
<T> RootGraphImplementor<T>	findEntityGraphByName(String name)
<T> List<RootGraphImplementor<? super T>>	findEntityGraphsByJavaType(Class<T> entityClass)
<X> EntityDomainType<X>	findEntityType(Class<X> cls)	Same as JpaMetamodel.entity(java.lang.String) except null is returned rather than throwing an exception
<X> ManagedDomainType<X>	findManagedType(Class<X> cls)	Same as JpaMetamodel.managedType(java.lang.String) except null is returned rather than throwing an exception
RootGraph<?>	findNamedGraph(String name)
List<RootGraph<?>>	findRootGraphsForType(Class baseEntityJavaType)
List<RootGraph<?>>	findRootGraphsForType(String baseEntityName)
List<RootGraph<?>>	findRootGraphsForType(EntityPersister baseEntityDescriptor)
void	finishInitialization(RuntimeModelCreationContext context)
void	forEachCollectionDescriptor(Consumer<CollectionPersister> action)	Visit the mapping descriptors for all collections defined in the model
void	forEachEntityDescriptor(Consumer<EntityPersister> action)	Visit all entity mapping descriptors defined in the model
void	forEachNamedGraph(Consumer<RootGraph<?>> action)
String[]	getAllCollectionRoles()	Get the names of all collections known to this Metamodel
String[]	getAllEntityNames()	Get the names of all entities known to this Metamodel
CollectionPersister	getCollectionDescriptor(String role)	Get a collection mapping descriptor based on its role
CollectionPersister	getCollectionDescriptor(NavigableRole role)	Get a collection mapping descriptor based on its role
Set<String>	getCollectionRolesByEntityParticipant(String entityName)	Retrieves a set of all the collection roles in which the given entity is a participant, as either an index or an element.
Set<EmbeddableType<?>>	getEmbeddables()	Return the metamodel embeddable types.
EmbeddableValuedModelPart	getEmbeddableValuedModelPart(NavigableRole role)	Get an EmbeddableMappingType based on its NavigableRole.
Set<EntityType<?>>	getEntities()	Return the metamodel entity types.
EntityPersister	getEntityDescriptor(Class<?> entityJavaType)	Get an entity mapping descriptor based on its Class.
EntityPersister	getEntityDescriptor(String entityName)	Get an entity mapping descriptor based on its Hibernate entity-name
EntityPersister	getEntityDescriptor(NavigableRole name)	Get an entity mapping descriptor based on its NavigableRole.
Collection<EntityNameResolver>	getEntityNameResolvers()	Access to the EntityNameResolver instance that Hibernate is configured to use for determining the entity descriptor from an instance of an entity
EnumJavaType<?>	getEnumType(String className)
Set<String>	getEnumTypesForValue(String enumValue)
<X> EntityDomainType<X>	getHqlEntityReference(String entityName)	Specialized handling for resolving entity-name references in an HQL query
String[]	getImplementors(String className)	Given the name of an entity class, determine all the class and interface names by which it can be referenced in an HQL query.
String	getImportedName(String name)
<T> T	getJavaConstant(String className, String fieldName)
JavaType<?>	getJavaConstantType(String className, String fieldName)
JpaCompliance	getJpaCompliance()
JpaMetamodelImplementor	getJpaMetamodel()
Set<ManagedType<?>>	getManagedTypes()	Return the metamodel managed types.
MappingMetamodel	getMappingMetamodel()
ServiceRegistry	getServiceRegistry()
TypeConfiguration	getTypeConfiguration()	The TypeConfiguration this metamodel is associated with
boolean	isEntityClass(Class<?> entityJavaType)
EntityPersister	locateEntityDescriptor(Class<?> byClass)	Locate an entity mapping descriptor by Class.
EntityPersister	locateEntityPersister(String byName)	Locate the entity persister by name.
<X> ManagedDomainType<X>	managedType(Class<X> cls)	Return the metamodel managed type representing the entity, mapped superclass, or embeddable class.
<X> ManagedDomainType<X>	managedType(String typeName)	Access to a managed type through its name
String	qualifyImportableName(String queryName)
<X> EntityDomainType<X>	resolveHqlEntityReference(String entityName)	Specialized handling for resolving entity-name references in an HQL query
MappingModelExpressible<?>	resolveMappingExpressible(SqmExpressible<?> sqmExpressible, Function<NavigablePath,TableGroup> tableGroupLocator)
<T> BindableType<T>	resolveQueryParameterType(Class<T> javaClass)	Given a Java type, determine the corresponding BindableType to use implicitly
Stream<CollectionPersister>	streamCollectionDescriptors()
Stream<EntityPersister>	streamEntityDescriptors()

Methods inherited from class org.hibernate.internal.QueryParameterBindingTypeResolverImpl

resolveParameterBindType, resolveParameterBindType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.metamodel.MappingMetamodel

locateEntityPersister

Methods inherited from interface org.hibernate.query.spi.QueryParameterBindingTypeResolver

resolveParameterBindType, resolveParameterBindType

Constructor Details

MappingMetamodelImpl

public MappingMetamodelImpl(TypeConfiguration typeConfiguration,
 ServiceRegistry serviceRegistry)

Method Details

getJpaMetamodel

public JpaMetamodelImplementor getJpaMetamodel()

finishInitialization

public void finishInitialization(RuntimeModelCreationContext context)

getEntityNameResolvers

public Collection<EntityNameResolver> getEntityNameResolvers()

Description copied from interface: MappingMetamodelImplementor

Access to the EntityNameResolver instance that Hibernate is configured to use for determining the entity descriptor from an instance of an entity

Specified by:

getEntityNameResolvers in interface MappingMetamodelImplementor

Specified by:

getEntityNameResolvers in interface MetamodelImplementor

getTypeConfiguration

public TypeConfiguration getTypeConfiguration()

Description copied from interface: MappingMetamodel

The TypeConfiguration this metamodel is associated with

Specified by:

getTypeConfiguration in interface JpaMetamodel

Specified by:

getTypeConfiguration in interface MappingMetamodel

Specified by:

getTypeConfiguration in interface QueryParameterBindingTypeResolver

getMappingMetamodel

public MappingMetamodel getMappingMetamodel()

Specified by:

getMappingMetamodel in interface QueryParameterBindingTypeResolver

getServiceRegistry

public ServiceRegistry getServiceRegistry()

Specified by:

getServiceRegistry in interface JpaMetamodel

forEachEntityDescriptor

public void forEachEntityDescriptor(Consumer<EntityPersister> action)

Description copied from interface: MappingMetamodel

Visit all entity mapping descriptors defined in the model

Specified by:

forEachEntityDescriptor in interface MappingMetamodel

streamEntityDescriptors

public Stream<EntityPersister> streamEntityDescriptors()

Specified by:

streamEntityDescriptors in interface MappingMetamodel

getEntityDescriptor

public EntityPersister getEntityDescriptor(String entityName)

Description copied from interface: MappingMetamodel

Get an entity mapping descriptor based on its Hibernate entity-name

Specified by:

getEntityDescriptor in interface MappingMetamodel

See Also:

• MappingMetamodel.findEntityDescriptor(java.lang.String)

getEntityDescriptor

public EntityPersister getEntityDescriptor(NavigableRole name)

Description copied from interface: MappingMetamodel

Get an entity mapping descriptor based on its NavigableRole.

Specified by:

getEntityDescriptor in interface MappingMetamodel

See Also:

• MappingMetamodel.findEntityDescriptor(java.lang.String)

getEmbeddableValuedModelPart

public EmbeddableValuedModelPart getEmbeddableValuedModelPart(NavigableRole role)

Description copied from interface: MappingMetamodel

Get an EmbeddableMappingType based on its NavigableRole.

Specified by:

getEmbeddableValuedModelPart in interface MappingMetamodel

See Also:

• MappingMetamodel.findEntityDescriptor(java.lang.String)

findEntityDescriptor

public EntityPersister findEntityDescriptor(String entityName)

Description copied from interface: MappingMetamodel

Find an entity mapping descriptor based on its Hibernate entity-name.

Specified by:

findEntityDescriptor in interface MappingMetamodel

findEntityDescriptor

public EntityPersister findEntityDescriptor(Class<?> entityJavaType)

Description copied from interface: MappingMetamodel

Find an entity mapping descriptor based on its Class.

Specified by:

findEntityDescriptor in interface MappingMetamodel

isEntityClass

public boolean isEntityClass(Class<?> entityJavaType)

Specified by:

isEntityClass in interface MappingMetamodel

getEntityDescriptor

public EntityPersister getEntityDescriptor(Class<?> entityJavaType)

Description copied from interface: MappingMetamodel

Get an entity mapping descriptor based on its Class.

Specified by:

getEntityDescriptor in interface MappingMetamodel

See Also:

• MappingMetamodel.findEntityDescriptor(java.lang.String)

locateEntityDescriptor

public EntityPersister locateEntityDescriptor(Class<?> byClass)

Description copied from interface: MappingMetamodel

Locate an entity mapping descriptor by Class. The passed Class might refer to either the entity Class directly, or it might name a proxy interface for the entity. This method accounts for both, preferring the direct entity name.

Specified by:

locateEntityDescriptor in interface MappingMetamodel

entity

public <X> EntityDomainType<X> entity(Class<X> cls)

Description copied from interface: Metamodel

Return the metamodel entity type representing the entity.

Specified by:

entity in interface JpaMetamodel

Specified by:

entity in interface Metamodel

Parameters:

cls - the type of the represented entity

Returns:

the metamodel entity type

managedType

public <X> ManagedDomainType<X> managedType(Class<X> cls)

Description copied from interface: Metamodel

Return the metamodel managed type representing the entity, mapped superclass, or embeddable class.

Specified by:

managedType in interface JpaMetamodel

Specified by:

managedType in interface Metamodel

Parameters:

cls - the type of the represented managed class

Returns:

the metamodel managed type

embeddable

public <X> EmbeddableDomainType<X> embeddable(Class<X> cls)

Description copied from interface: Metamodel

Return the metamodel embeddable type representing the embeddable class.

Specified by:

embeddable in interface JpaMetamodel

Specified by:

embeddable in interface Metamodel

Parameters:

cls - the type of the represented embeddable class

Returns:

the metamodel embeddable type

getManagedTypes

public Set<ManagedType<?>> getManagedTypes()

Description copied from interface: Metamodel

Return the metamodel managed types.

Specified by:

getManagedTypes in interface JpaMetamodel

Specified by:

getManagedTypes in interface Metamodel

Returns:

the metamodel managed types

getEntities

public Set<EntityType<?>> getEntities()

Description copied from interface: Metamodel

Return the metamodel entity types.

Specified by:

getEntities in interface JpaMetamodel

Specified by:

getEntities in interface Metamodel

Returns:

the metamodel entity types

getEmbeddables

public Set<EmbeddableType<?>> getEmbeddables()

Description copied from interface: Metamodel

Return the metamodel embeddable types. Returns empty set if there are no embeddable types.

Specified by:

getEmbeddables in interface JpaMetamodel

Specified by:

getEmbeddables in interface Metamodel

Returns:

the metamodel embeddable types

managedType

public <X> ManagedDomainType<X> managedType(String typeName)

Description copied from interface: JpaMetamodel

Access to a managed type through its name

Specified by:

managedType in interface JpaMetamodel

entity

public <X> EntityDomainType<X> entity(String entityName)

Description copied from interface: JpaMetamodel

Access to an entity supporting Hibernate's entity-name feature

Specified by:

entity in interface JpaMetamodel

embeddable

public <X> EmbeddableDomainType<X> embeddable(String embeddableName)

Description copied from interface: JpaMetamodel

Access to an embeddable type from FQN

Specified by:

embeddable in interface JpaMetamodel

getHqlEntityReference

public <X> EntityDomainType<X> getHqlEntityReference(String entityName)

Description copied from interface: JpaMetamodel

Specialized handling for resolving entity-name references in an HQL query

Specified by:

getHqlEntityReference in interface JpaMetamodel

resolveHqlEntityReference

public <X> EntityDomainType<X> resolveHqlEntityReference(String entityName)

Description copied from interface: JpaMetamodel

Specialized handling for resolving entity-name references in an HQL query

Specified by:

resolveHqlEntityReference in interface JpaMetamodel

findManagedType

public <X> ManagedDomainType<X> findManagedType(Class<X> cls)

Description copied from interface: JpaMetamodel

Same as JpaMetamodel.managedType(java.lang.String) except null is returned rather than throwing an exception

Specified by:

findManagedType in interface JpaMetamodel

findEntityType

public <X> EntityDomainType<X> findEntityType(Class<X> cls)

Description copied from interface: JpaMetamodel

Same as JpaMetamodel.entity(java.lang.String) except null is returned rather than throwing an exception

Specified by:

findEntityType in interface JpaMetamodel

qualifyImportableName

public String qualifyImportableName(String queryName)

Specified by:

qualifyImportableName in interface JpaMetamodel

getEnumTypesForValue

public Set<String> getEnumTypesForValue(String enumValue)

Specified by:

getEnumTypesForValue in interface JpaMetamodel

getJavaConstantType

public JavaType<?> getJavaConstantType(String className,
 String fieldName)

Specified by:

getJavaConstantType in interface JpaMetamodel

getJavaConstant

public <T> T getJavaConstant(String className,
 String fieldName)

Specified by:

getJavaConstant in interface JpaMetamodel

getEnumType

public EnumJavaType<?> getEnumType(String className)

Specified by:

getEnumType in interface JpaMetamodel

enumValue

public <E extends Enum<E>> E enumValue(EnumJavaType<E> enumType,
 String enumValueName)

Specified by:

enumValue in interface JpaMetamodel

getImplementors

public String[] getImplementors(String className)
                         throws MappingException

Description copied from interface: Metamodel

Given the name of an entity class, determine all the class and interface names by which it can be referenced in an HQL query.

Specified by:

getImplementors in interface Metamodel

Parameters:

className - The name of the entity class

Returns:

the names of all persistent (mapped) classes that extend or implement the given class or interface, accounting for implicit/explicit polymorphism settings and excluding mapped subclasses/joined-subclasses of other classes in the result.

Throws:

MappingException

entityPersisters

public Map<String,EntityPersister> entityPersisters()

Description copied from interface: MetamodelImplementor

Get all entity persisters as a Map, which entity name its the key and the persister is the value.

Specified by:

entityPersisters in interface MetamodelImplementor

Returns:

The Map contains all entity persisters.

collectionPersister

public CollectionPersister collectionPersister(String role)

Description copied from interface: MetamodelImplementor

Get the persister object for a collection role.

Specified by:

collectionPersister in interface MetamodelImplementor

Parameters:

role - The role of the collection for which to retrieve the persister.

Returns:

The persister

collectionPersisters

public Map<String,CollectionPersister> collectionPersisters()

Description copied from interface: MetamodelImplementor

Get all collection persisters as a Map, which collection role as the key and the persister is the value.

Specified by:

collectionPersisters in interface MetamodelImplementor

Returns:

The Map contains all collection persisters.

entityPersister

public EntityPersister entityPersister(Class<?> entityClass)

Description copied from interface: MetamodelImplementor

Locate the persister for an entity by the entity class.

Specified by:

entityPersister in interface MetamodelImplementor

Parameters:

entityClass - The entity class

Returns:

The entity persister

entityPersister

public EntityPersister entityPersister(String entityName)
                                throws MappingException

Description copied from interface: MetamodelImplementor

Locate the persister for an entity by the entity-name

Specified by:

entityPersister in interface MetamodelImplementor

Parameters:

entityName - The name of the entity for which to retrieve the persister.

Returns:

The persister

Throws:

MappingException - Indicates persister could not be found with that name.

locateEntityPersister

public EntityPersister locateEntityPersister(String byName)

Description copied from interface: MappingMetamodel

Locate the entity persister by name.

Specified by:

locateEntityPersister in interface MappingMetamodel

Returns:

The located EntityPersister, never null

getImportedName

public String getImportedName(String name)

Specified by:

getImportedName in interface MappingMetamodel

forEachCollectionDescriptor

public void forEachCollectionDescriptor(Consumer<CollectionPersister> action)

Description copied from interface: MappingMetamodel

Visit the mapping descriptors for all collections defined in the model

Specified by:

forEachCollectionDescriptor in interface MappingMetamodel

streamCollectionDescriptors

public Stream<CollectionPersister> streamCollectionDescriptors()

Specified by:

streamCollectionDescriptors in interface MappingMetamodel

getCollectionDescriptor

public CollectionPersister getCollectionDescriptor(String role)

Description copied from interface: MappingMetamodel

Get a collection mapping descriptor based on its role

Specified by:

getCollectionDescriptor in interface MappingMetamodel

See Also:

• MappingMetamodel.findCollectionDescriptor(org.hibernate.metamodel.model.domain.NavigableRole)

getCollectionDescriptor

public CollectionPersister getCollectionDescriptor(NavigableRole role)

Description copied from interface: MappingMetamodel

Get a collection mapping descriptor based on its role

Specified by:

getCollectionDescriptor in interface MappingMetamodel

See Also:

• MappingMetamodel.findCollectionDescriptor(org.hibernate.metamodel.model.domain.NavigableRole)

findCollectionDescriptor

public CollectionPersister findCollectionDescriptor(NavigableRole role)

Description copied from interface: MappingMetamodel

Find a collection mapping descriptor based on its role. Returns null if the role does not refer to a collection

Specified by:

findCollectionDescriptor in interface MappingMetamodel

See Also:

• MappingMetamodel.findCollectionDescriptor(org.hibernate.metamodel.model.domain.NavigableRole)

findCollectionDescriptor

public CollectionPersister findCollectionDescriptor(String role)

Description copied from interface: MappingMetamodel

Find a collection mapping descriptor based on its role. Returns null if the role does not refer to a collection

Specified by:

findCollectionDescriptor in interface MappingMetamodel

See Also:

• MappingMetamodel.findCollectionDescriptor(org.hibernate.metamodel.model.domain.NavigableRole)

getCollectionRolesByEntityParticipant

public Set<String> getCollectionRolesByEntityParticipant(String entityName)

Description copied from interface: MappingMetamodelImplementor

Retrieves a set of all the collection roles in which the given entity is a participant, as either an index or an element.

Specified by:

getCollectionRolesByEntityParticipant in interface MappingMetamodelImplementor

Specified by:

getCollectionRolesByEntityParticipant in interface MetamodelImplementor

Parameters:

entityName - The entity name for which to get the collection roles.

Returns:

set of all the collection roles in which the given entityName participates.

getAllEntityNames

public String[] getAllEntityNames()

Description copied from interface: MetamodelImplementor

Get the names of all entities known to this Metamodel

Specified by:

getAllEntityNames in interface MetamodelImplementor

Returns:

All the entity names

getAllCollectionRoles

public String[] getAllCollectionRoles()

Description copied from interface: MetamodelImplementor

Get the names of all collections known to this Metamodel

Specified by:

getAllCollectionRoles in interface MetamodelImplementor

Returns:

All the entity names

addNamedEntityGraph

public <T> void addNamedEntityGraph(String graphName,
 RootGraphImplementor<T> entityGraph)

Specified by:

addNamedEntityGraph in interface JpaMetamodel

Specified by:

addNamedEntityGraph in interface MappingMetamodel

findEntityGraphByName

public <T> RootGraphImplementor<T> findEntityGraphByName(String name)

Specified by:

findEntityGraphByName in interface JpaMetamodel

findEntityGraphsByJavaType

public <T> List<RootGraphImplementor<? super T>> findEntityGraphsByJavaType(Class<T> entityClass)

Specified by:

findEntityGraphsByJavaType in interface JpaMetamodel

getJpaCompliance

public JpaCompliance getJpaCompliance()

Specified by:

getJpaCompliance in interface JpaMetamodel

findNamedGraph

public RootGraph<?> findNamedGraph(String name)

Specified by:

findNamedGraph in interface MappingMetamodel

forEachNamedGraph

public void forEachNamedGraph(Consumer<RootGraph<?>> action)

Specified by:

forEachNamedGraph in interface MappingMetamodel

defaultGraph

public RootGraph<?> defaultGraph(String entityName)

Specified by:

defaultGraph in interface MappingMetamodel

defaultGraph

public RootGraph<?> defaultGraph(Class entityJavaType)

Specified by:

defaultGraph in interface MappingMetamodel

defaultGraph

public RootGraph<?> defaultGraph(EntityPersister entityDescriptor)

Specified by:

defaultGraph in interface MappingMetamodel

defaultGraph

public RootGraph<?> defaultGraph(EntityDomainType<?> entityDomainType)

Specified by:

defaultGraph in interface MappingMetamodel

findRootGraphsForType

public List<RootGraph<?>> findRootGraphsForType(Class baseEntityJavaType)

Specified by:

findRootGraphsForType in interface MappingMetamodel

findRootGraphsForType

public List<RootGraph<?>> findRootGraphsForType(String baseEntityName)

Specified by:

findRootGraphsForType in interface MappingMetamodel

findRootGraphsForType

public List<RootGraph<?>> findRootGraphsForType(EntityPersister baseEntityDescriptor)

Specified by:

findRootGraphsForType in interface MappingMetamodel

close

public void close()

Specified by:

close in interface MetamodelImplementor

resolveMappingExpressible

public MappingModelExpressible<?> resolveMappingExpressible(SqmExpressible<?> sqmExpressible,
 Function<NavigablePath,TableGroup> tableGroupLocator)

Specified by:

resolveMappingExpressible in interface MappingMetamodel

resolveQueryParameterType

public <T> BindableType<T> resolveQueryParameterType(Class<T> javaClass)

Description copied from interface: MappingMetamodel

Given a Java type, determine the corresponding BindableType to use implicitly

Specified by:

resolveQueryParameterType in interface MappingMetamodel