Package org.hibernate.metamodel

Interface MappingMetamodel

All Superinterfaces:

Metamodel

All Known Subinterfaces:

MappingMetamodelImplementor

@Incubating
public interface MappingMetamodel
extends Metamodel

Access to information about the runtime relational O/R mapping model.

API Note:

This is an incubating SPI. Its name and package may change.

Method Summary

Modifier and Type	Method	Description
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.
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
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
EmbeddableValuedModelPart	getEmbeddableValuedModelPart(NavigableRole role)	Get an EmbeddableMappingType based on its NavigableRole.
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.
String	getImportedName(String name)
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. No longer used
MappingModelExpressible<?>	resolveMappingExpressible(SqmExpressible<?> sqmExpressible, Function<NavigablePath,TableGroup> tableGroupLocator)
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 interface jakarta.persistence.metamodel.Metamodel

embeddable, entity, entity, getEmbeddables, getEntities, getManagedTypes, managedType

Method Details

getTypeConfiguration

TypeConfiguration getTypeConfiguration()

The TypeConfiguration this metamodel is associated with

forEachEntityDescriptor

void forEachEntityDescriptor(Consumer<EntityPersister> action)

Visit all entity mapping descriptors defined in the model

streamEntityDescriptors

@Deprecated(forRemoval=true,
            since="7")
Stream<EntityPersister> streamEntityDescriptors()

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

getEntityDescriptor

EntityPersister getEntityDescriptor(String entityName)

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

Throws:

IllegalArgumentException - if the name does not refer to an entity

See Also:

• findEntityDescriptor(java.lang.String)

getEntityDescriptor

EntityPersister getEntityDescriptor(NavigableRole name)

Get an entity mapping descriptor based on its NavigableRole.

Throws:

IllegalArgumentException - if the name does not refer to an entity

See Also:

• findEntityDescriptor(java.lang.String)

getEmbeddableValuedModelPart

EmbeddableValuedModelPart getEmbeddableValuedModelPart(NavigableRole role)

Get an EmbeddableMappingType based on its NavigableRole.

Throws:

IllegalArgumentException - if the role does not refer to an entity

See Also:

• findEntityDescriptor(java.lang.String)

getEntityDescriptor

EntityPersister getEntityDescriptor(Class<?> entityJavaType)

Get an entity mapping descriptor based on its Class.

Throws:

IllegalArgumentException - if the class is not an entity class

See Also:

• findEntityDescriptor(java.lang.String)

findEntityDescriptor

EntityPersister findEntityDescriptor(String entityName)

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

API Note:

Returns null rather than throwing exception

findEntityDescriptor

EntityPersister findEntityDescriptor(Class<?> entityJavaType)

Find an entity mapping descriptor based on its Class.

API Note:

Returns null rather than throwing exception

isEntityClass

boolean isEntityClass(Class<?> entityJavaType)

locateEntityDescriptor

@Deprecated(forRemoval=true,
            since="7")
EntityPersister locateEntityDescriptor(Class<?> byClass)

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

No longer used

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.

Throws:

UnknownEntityTypeException - If a matching EntityPersister cannot be located

getImportedName

String getImportedName(String name)

forEachCollectionDescriptor

void forEachCollectionDescriptor(Consumer<CollectionPersister> action)

Visit the mapping descriptors for all collections defined in the model

streamCollectionDescriptors

@Deprecated(forRemoval=true,
            since="7")
Stream<CollectionPersister> streamCollectionDescriptors()

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

getCollectionDescriptor

CollectionPersister getCollectionDescriptor(String role)

Get a collection mapping descriptor based on its role

Throws:

IllegalArgumentException - if the role does not refer to a collection

See Also:

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

getCollectionDescriptor

CollectionPersister getCollectionDescriptor(NavigableRole role)

Get a collection mapping descriptor based on its role

Throws:

IllegalArgumentException - if the role does not refer to a collection

See Also:

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

findCollectionDescriptor

CollectionPersister findCollectionDescriptor(NavigableRole role)

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

See Also:

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

findCollectionDescriptor

CollectionPersister findCollectionDescriptor(String role)

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

See Also:

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

resolveMappingExpressible

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