Interface JpaMetamodel

All Superinterfaces:

Metamodel

All Known Subinterfaces:

JpaMetamodelImplementor

@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
<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)
<X> EmbeddableDomainType<X>	findEmbeddableType(Class<X> cls)	Same as embeddable(Class) except null is returned rather than throwing an exception
EmbeddableDomainType<?>	findEmbeddableType(String embeddableName)	Same as embeddable(String) except null is returned rather than throwing an exception
<X> EntityDomainType<X>	findEntityType(Class<X> cls)	Same as entity(Class) except null is returned rather than throwing an exception
EntityDomainType<?>	findEntityType(String entityName)	Same as entity(String) except null is returned rather than throwing an exception
<X> ManagedDomainType<X>	findManagedType(Class<X> cls)	Same as managedType(Class) except null is returned rather than throwing an exception
ManagedDomainType<?>	findManagedType(String typeName)	Same as managedType(String) except null is returned rather than throwing an exception
EnumJavaType<?>	getEnumType(String className)
Set<String>	getEnumTypesForValue(String enumValue)
EntityDomainType<?>	getHqlEntityReference(String entityName)	Specialized handling for resolving entity-name references in an HQL query
<E> E	getJavaConstant(String className, String fieldName, Class<E> javaTypeClass)
JavaType<?>	getJavaConstantType(String className, String fieldName)
<X> ManagedDomainType<X>	managedType(Class<X> cls)
ManagedDomainType<?>	managedType(String typeName)	Access to a managed type through its name
String	qualifyImportableName(String queryName)
EntityDomainType<?>	resolveHqlEntityReference(String entityName)	Specialized handling for resolving entity-name references in an HQL query

Methods inherited from interface Metamodel

getEmbeddables, getEntities, getManagedTypes

Method Details

managedType

@Nonnull
ManagedDomainType<?> managedType(@Nullable
 String typeName)

Access to a managed type through its name

entity

@Nonnull
EntityDomainType<?> entity(@Nullable
 String entityName)

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

Specified by:

entity in interface Metamodel

embeddable

@Nonnull
EmbeddableDomainType<?> embeddable(@Nullable
 String embeddableName)

Access to an embeddable type from FQN

getHqlEntityReference

@Nullable
EntityDomainType<?> getHqlEntityReference(@Nonnull
 String entityName)

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

resolveHqlEntityReference

@Nonnull
EntityDomainType<?> resolveHqlEntityReference(@Nonnull
 String entityName)

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

findManagedType

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

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

findEntityType

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

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

findEmbeddableType

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

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

findManagedType

@Nullable
ManagedDomainType<?> 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

@Nullable
<E> E getJavaConstant(String className,
 String fieldName,
 Class<E> javaTypeClass)

managedType

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

Specified by:

managedType in interface Metamodel

entity

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

Specified by:

entity in interface Metamodel

embeddable

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

Specified by:

embeddable in interface Metamodel