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

Class MappingMetamodelImpl

java.lang.Object

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

All Implemented Interfaces:

Metamodel, Serializable, MappingMetamodel, JpaMetamodel, MappingMetamodelImplementor, QueryParameterBindingTypeResolver, BindingContext

public class MappingMetamodelImpl
extends Object
implements MappingMetamodelImplementor, JpaMetamodel, Metamodel, QueryParameterBindingTypeResolver, BindingContext, 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.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MappingMetamodelImpl(TypeConfiguration typeConfiguration, ServiceRegistry serviceRegistry)

Method Summary

Modifier and Type	Method	Description
<X> EmbeddableDomainType<X>	embeddable(Class<X> cls)
EmbeddableDomainType<?>	embeddable(String embeddableName)	Access to an embeddable type from FQN
<X> EntityDomainType<X>	entity(Class<X> cls)
EntityDomainType<?>	entity(String entityName)	Access to an entity supporting Hibernate's entity-name feature
<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.
@Nullable EmbeddableDomainType<?>	findEmbeddableType(@Nullable String embeddableName)	Same as JpaMetamodel.embeddable(String) except null is returned rather than throwing an exception
<X> @Nullable EmbeddableDomainType<X>	findEmbeddableType(Class<X> cls)	Same as JpaMetamodel.embeddable(Class) except null is returned rather than throwing an exception
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.
@Nullable EntityDomainType<?>	findEntityType(@Nullable String entityName)	Same as JpaMetamodel.entity(String) except null is returned rather than throwing an exception
<X> EntityDomainType<X>	findEntityType(Class<X> cls)	Same as JpaMetamodel.entity(Class) except null is returned rather than throwing an exception
<X> @Nullable ManagedDomainType<X>	findManagedType(@Nullable String typeName)	Same as JpaMetamodel.managedType(String) except null is returned rather than throwing an exception
<X> ManagedDomainType<X>	findManagedType(Class<X> cls)	Same as JpaMetamodel.managedType(Class) except null is returned rather than throwing an exception
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
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()
EmbeddableValuedModelPart	getEmbeddableValuedModelPart(NavigableRole role)	Get an EmbeddableMappingType based on its NavigableRole.
Set<EntityType<?>>	getEntities()
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	getImportedName(String name)
<T> T	getJavaConstant(String className, String fieldName)
JavaType<?>	getJavaConstantType(String className, String fieldName)
JpaMetamodelImplementor	getJpaMetamodel()
Set<ManagedType<?>>	getManagedTypes()
MappingMetamodel	getMappingMetamodel()
ServiceRegistry	getServiceRegistry()
TypeConfiguration	getTypeConfiguration()	The TypeConfiguration this metamodel is associated with
boolean	isEntityClass(Class<?> entityJavaType)
EntityPersister	locateEntityDescriptor(Class<?> byClass)	Deprecated, for removal: This API element is subject to removal in a future version.
<X> ManagedDomainType<X>	managedType(Class<X> cls)
<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>	resolveParameterBindType(Class<T> javaType)
<T> BindableType<? super T>	resolveParameterBindType(T bindValue)
Stream<CollectionPersister>	streamCollectionDescriptors()	Deprecated, for removal: This API element is subject to removal in a future version.
Stream<EntityPersister>	streamEntityDescriptors()	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.type.BindingContext

resolveExpressible

Constructor Details

MappingMetamodelImpl

public MappingMetamodelImpl(TypeConfiguration typeConfiguration,
 ServiceRegistry serviceRegistry)

Method Details

getJpaMetamodel

public JpaMetamodelImplementor getJpaMetamodel()

Specified by:

getJpaMetamodel in interface BindingContext

finishInitialization

public void finishInitialization(RuntimeModelCreationContext context)

getTypeConfiguration

public TypeConfiguration getTypeConfiguration()

Description copied from interface: MappingMetamodel

The TypeConfiguration this metamodel is associated with

Specified by:

getTypeConfiguration in interface BindingContext

Specified by:

getTypeConfiguration in interface MappingMetamodel

Specified by:

getTypeConfiguration in interface QueryParameterBindingTypeResolver

getMappingMetamodel

public MappingMetamodel getMappingMetamodel()

Specified by:

getMappingMetamodel in interface BindingContext

Specified by:

getMappingMetamodel in interface QueryParameterBindingTypeResolver

getServiceRegistry

public ServiceRegistry getServiceRegistry()

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

@Deprecated(forRemoval=true)
public Stream<EntityPersister> streamEntityDescriptors()

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

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

@Deprecated(forRemoval=true)
public EntityPersister locateEntityDescriptor(Class<?> byClass)

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

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)

Specified by:

entity in interface JpaMetamodel

Specified by:

entity in interface Metamodel

managedType

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

Specified by:

managedType in interface JpaMetamodel

Specified by:

managedType in interface Metamodel

embeddable

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

Specified by:

embeddable in interface JpaMetamodel

Specified by:

embeddable in interface Metamodel

getManagedTypes

public Set<ManagedType<?>> getManagedTypes()

Specified by:

getManagedTypes in interface Metamodel

getEntities

public Set<EntityType<?>> getEntities()

Specified by:

getEntities in interface Metamodel

getEmbeddables

public Set<EmbeddableType<?>> getEmbeddables()

Specified by:

getEmbeddables in interface Metamodel

findManagedType

public <X> @Nullable ManagedDomainType<X> findManagedType(@Nullable String typeName)

Description copied from interface: JpaMetamodel

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

Specified by:

findManagedType in interface JpaMetamodel

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

findEntityType

public @Nullable EntityDomainType<?> findEntityType(@Nullable String entityName)

Description copied from interface: JpaMetamodel

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

Specified by:

findEntityType in interface JpaMetamodel

entity

public EntityDomainType<?> entity(String entityName)

Description copied from interface: JpaMetamodel

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

Specified by:

entity in interface JpaMetamodel

Specified by:

entity in interface Metamodel

findEmbeddableType

public @Nullable EmbeddableDomainType<?> findEmbeddableType(@Nullable String embeddableName)

Description copied from interface: JpaMetamodel

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

Specified by:

findEmbeddableType in interface JpaMetamodel

embeddable

public EmbeddableDomainType<?> 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(Class) 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(Class) except null is returned rather than throwing an exception

Specified by:

findEntityType in interface JpaMetamodel

findEmbeddableType

public <X> @Nullable EmbeddableDomainType<X> findEmbeddableType(Class<X> cls)

Description copied from interface: JpaMetamodel

Same as JpaMetamodel.embeddable(Class) except null is returned rather than throwing an exception

Specified by:

findEmbeddableType 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

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

@Deprecated(forRemoval=true)
public Stream<CollectionPersister> streamCollectionDescriptors()

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

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)

resolveMappingExpressible

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

Specified by:

resolveMappingExpressible in interface MappingMetamodel

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

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.

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

getAllEntityNames

public String[] getAllEntityNames()

Description copied from interface: MappingMetamodelImplementor

Get the names of all entities known to this Metamodel

Specified by:

getAllEntityNames in interface MappingMetamodelImplementor

Returns:

All the entity names

getAllCollectionRoles

public String[] getAllCollectionRoles()

Description copied from interface: MappingMetamodelImplementor

Get the names of all collections known to this Metamodel

Specified by:

getAllCollectionRoles in interface MappingMetamodelImplementor

Returns:

All the entity names

resolveParameterBindType

public <T> BindableType<T> resolveParameterBindType(Class<T> javaType)

Specified by:

resolveParameterBindType in interface QueryParameterBindingTypeResolver

resolveParameterBindType

public <T> BindableType<? super T> resolveParameterBindType(T bindValue)

Specified by:

resolveParameterBindType in interface QueryParameterBindingTypeResolver