Package org.hibernate.metamodel.model.domain

Interface JpaMetamodel

All Superinterfaces:

Metamodel

All Known Subinterfaces:

JpaMetamodelImplementor

All Known Implementing Classes:

JpaMetamodelImpl, MappingMetamodelImpl

@Incubating
public interface JpaMetamodel
extends Metamodel

Extensions to the JPA-defined metamodel of persistent Java types.

Since:

6.0

See Also:

• MappingMetamodel

API Note:

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

Method Summary

Modifier and Type	Method	Description
void	addNamedEntityGraph(String graphName, RootGraph<?> entityGraph)
<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)
@Nullable EmbeddableDomainType<?>	findEmbeddableType(@Nullable String embeddableName)	Same as embeddable(String) except null is returned rather than throwing an exception
<X> @Nullable EmbeddableDomainType<X>	findEmbeddableType(Class<X> cls)	Same as embeddable(Class) except null is returned rather than throwing an exception
RootGraph<?>	findEntityGraphByName(String name)
<T> List<RootGraph<? super T>>	findEntityGraphsByJavaType(Class<T> entityClass)
@Nullable EntityDomainType<?>	findEntityType(@Nullable String entityName)	Same as entity(String) except null is returned rather than throwing an exception
<X> @Nullable EntityDomainType<X>	findEntityType(Class<X> cls)	Same as entity(Class) except null is returned rather than throwing an exception
<X> @Nullable ManagedDomainType<X>	findManagedType(@Nullable String typeName)	Same as managedType(String) except null is returned rather than throwing an exception
<X> @Nullable ManagedDomainType<X>	findManagedType(Class<X> cls)	Same as managedType(Class) except null is returned rather than throwing an exception
EnumJavaType<?>	getEnumType(String className)
@Nullable Set<String>	getEnumTypesForValue(String enumValue)
<X> EntityDomainType<X>	getHqlEntityReference(String entityName)	Specialized handling for resolving entity-name references in an HQL query
<T> T	getJavaConstant(String className, String fieldName)
JavaType<?>	getJavaConstantType(String className, String fieldName)
<T> Map<String,EntityGraph<? extends T>>	getNamedEntityGraphs(Class<T> entityType)
<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

Methods inherited from interface jakarta.persistence.metamodel.Metamodel

getEmbeddables, getEntities, getManagedTypes

Method Details

managedType

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

Access to a managed type through its name

entity

EntityDomainType<?> entity(String entityName)

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

Specified by:

entity in interface Metamodel

embeddable

EmbeddableDomainType<?> embeddable(String embeddableName)

Access to an embeddable type from FQN

getHqlEntityReference

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

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

resolveHqlEntityReference

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

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

findManagedType

<X> @Nullable ManagedDomainType<X> findManagedType(Class<X> cls)

Same as managedType(Class) except null is returned rather than throwing an exception

findEntityType

<X> @Nullable EntityDomainType<X> findEntityType(Class<X> cls)

Same as entity(Class) except null is returned rather than throwing an exception

findEmbeddableType

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

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

findManagedType

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

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

findEntityType

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

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

findEmbeddableType

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

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

qualifyImportableName

String qualifyImportableName(String queryName)

getEnumTypesForValue

@Nullable Set<String> getEnumTypesForValue(String enumValue)

getEnumType

EnumJavaType<?> getEnumType(String className)

enumValue

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

getJavaConstantType

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

getJavaConstant

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

managedType

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

Specified by:

managedType in interface Metamodel

entity

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

Specified by:

entity in interface Metamodel

embeddable

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

Specified by:

embeddable in interface Metamodel

addNamedEntityGraph

void addNamedEntityGraph(String graphName,
 RootGraph<?> entityGraph)

findEntityGraphByName

RootGraph<?> findEntityGraphByName(String name)

findEntityGraphsByJavaType

<T> List<RootGraph<? super T>> findEntityGraphsByJavaType(Class<T> entityClass)

getNamedEntityGraphs

<T> Map<String,EntityGraph<? extends T>> getNamedEntityGraphs(Class<T> entityType)