MappingMetamodel (hibernate-core JavaDocs)

All Known Subinterfaces:

MetamodelImplementor
```
public interface MappingMetamodel
```
Access to information about Hibernate's runtime relational mapping model

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`RootGraph<?>`	`defaultGraph(Class entityJavaType)`
`RootGraph<?>`	`defaultGraph(EntityDomainType<?> entityDomainType)`
`RootGraph<?>`	`defaultGraph(EntityPersister entityDescriptor)`
`RootGraph<?>`	`defaultGraph(String entityName)`
`CollectionPersister`	`findCollectionDescriptor(NavigableRole role)` Find a collection mapping descriptor based on its role.
`CollectionPersister`	`findCollectionDescriptor(String 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.
`RootGraph<?>`	`findNamedGraph(String name)`
`List<RootGraph<?>>`	`findRootGraphsForType(Class baseEntityJavaType)`
`List<RootGraph<?>>`	`findRootGraphsForType(EntityPersister baseEntityDescriptor)`
`List<RootGraph<?>>`	`findRootGraphsForType(String baseEntityName)`
`CollectionPersister`	`getCollectionDescriptor(NavigableRole role)` Get a collection mapping descriptor based on its role
`CollectionPersister`	`getCollectionDescriptor(String role)` Get a collection mapping descriptor based on its role
`EntityPersister`	`getEntityDescriptor(Class entityJavaType)` Get an entity mapping descriptor based on its Class.
`EntityPersister`	`getEntityDescriptor(NavigableRole name)` Get an entity mapping descriptor based on its NavigableRole.
`EntityPersister`	`getEntityDescriptor(String entityName)` Get an entity mapping descriptor based on its Hibernate entity-name
`String`	`getImportedName(String name)`
`TypeConfiguration`	`getTypeConfiguration()` The TypeConfiguration this metamodel is associated with
`MappingModelExpressable`	`lenientlyResolveMappingExpressable(SqmExpressable<?> sqmExpressable, Function<NavigablePath,TableGroup> tableGroupLocator)`
`EntityPersister`	`locateEntityDescriptor(Class byClass)` Locate an entity mapping descriptor by Class.
`default EntityPersister`	`locateEntityPersister(Class byClass)` Deprecated. (since 6.0) use `locateEntityDescriptor(Class)` instead
`EntityPersister`	`locateEntityPersister(String byName)` Deprecated. (since 6.0) - use `getEntityDescriptor(String)` instead
`EntityPersister`	`resolveEntityDescriptor(EntityDomainType<?> entityDomainType)` Given a JPA entity domain type, get the associated Hibernate entity descriptor
`MappingModelExpressable`	`resolveMappingExpressable(SqmExpressable<?> sqmExpressable, Function<NavigablePath,TableGroup> tableGroupLocator)` todo (6.0) : POC!!! Intended for use in SQM -> SQL translation
`<T> AllowableParameterType<T>`	`resolveQueryParameterType(Class<T> javaType)` Given a Java type, determine the corresponding AllowableParameterType to use implicitly
`void`	`visitCollectionDescriptors(Consumer<CollectionPersister> action)` Visit the mapping descriptors for all collections defined in the model
`void`	`visitEntityDescriptors(Consumer<EntityPersister> action)` Visit all entity mapping descriptors defined in the model
`void`	`visitNamedGraphs(Consumer<RootGraph<?>> action)`

- Method Detail
  - getTypeConfiguration
```
TypeConfiguration getTypeConfiguration()
```
    The TypeConfiguration this metamodel is associated with
  - resolveMappingExpressable
```
MappingModelExpressable resolveMappingExpressable(SqmExpressable<?> sqmExpressable,
                                                  Function<NavigablePath,TableGroup> tableGroupLocator)
```
    todo (6.0) : POC!!! Intended for use in SQM -> SQL translation
  - lenientlyResolveMappingExpressable
```
MappingModelExpressable lenientlyResolveMappingExpressable(SqmExpressable<?> sqmExpressable,
                                                           Function<NavigablePath,TableGroup> tableGroupLocator)
```
  - resolveQueryParameterType
```
<T> AllowableParameterType<T> resolveQueryParameterType(Class<T> javaType)
```
    Given a Java type, determine the corresponding AllowableParameterType to use implicitly
  - visitEntityDescriptors
```
void visitEntityDescriptors(Consumer<EntityPersister> action)
```
    Visit all entity mapping descriptors defined in the model
  - resolveEntityDescriptor
```
EntityPersister resolveEntityDescriptor(EntityDomainType<?> entityDomainType)
```
    Given a JPA entity domain type, get the associated Hibernate entity descriptor
  - 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)
  - getEntityDescriptor
```
EntityPersister getEntityDescriptor(Class entityJavaType)
```
    Get an entity mapping descriptor based on its Class.
    
    Throws:
    
    IllegalArgumentException - if the name does not refer to an entity
    
    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
  - locateEntityDescriptor
```
EntityPersister locateEntityDescriptor(Class byClass)
```
    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
  - locateEntityPersister
```
@Deprecated
default EntityPersister locateEntityPersister(Class byClass)
```
    Deprecated. (since 6.0) use locateEntityDescriptor(Class) instead
    
    See Also:
    
    locateEntityDescriptor(java.lang.Class)
  - locateEntityPersister
```
@Deprecated
EntityPersister locateEntityPersister(String byName)
```
    Deprecated. (since 6.0) - use getEntityDescriptor(String) instead
    
    Locate the entity persister by name.
    
    Returns:
    
    The located EntityPersister, never null
    
    Throws:
    
    UnknownEntityTypeException - If a matching EntityPersister cannot be located
  - getImportedName
```
String getImportedName(String name)
```
  - visitCollectionDescriptors
```
void visitCollectionDescriptors(Consumer<CollectionPersister> action)
```
    Visit the mapping descriptors for all collections defined in the model
  - 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)
  - findNamedGraph
```
RootGraph<?> findNamedGraph(String name)
```
  - visitNamedGraphs
```
void visitNamedGraphs(Consumer<RootGraph<?>> action)
```
  - defaultGraph
```
RootGraph<?> defaultGraph(String entityName)
```
  - defaultGraph
```
RootGraph<?> defaultGraph(Class entityJavaType)
```
  - defaultGraph
```
RootGraph<?> defaultGraph(EntityPersister entityDescriptor)
```
  - defaultGraph
```
RootGraph<?> defaultGraph(EntityDomainType<?> entityDomainType)
```
  - findRootGraphsForType
```
List<RootGraph<?>> findRootGraphsForType(Class baseEntityJavaType)
```
  - findRootGraphsForType
```
List<RootGraph<?>> findRootGraphsForType(String baseEntityName)
```
  - findRootGraphsForType
```
List<RootGraph<?>> findRootGraphsForType(EntityPersister baseEntityDescriptor)
```

Interface MappingMetamodel

Method Summary

Method Detail

getTypeConfiguration

resolveMappingExpressable

lenientlyResolveMappingExpressable

resolveQueryParameterType

visitEntityDescriptors

resolveEntityDescriptor

getEntityDescriptor

getEntityDescriptor

getEntityDescriptor

findEntityDescriptor

findEntityDescriptor

locateEntityDescriptor

locateEntityPersister

locateEntityPersister

getImportedName

visitCollectionDescriptors

getCollectionDescriptor

getCollectionDescriptor

findCollectionDescriptor

findCollectionDescriptor

findNamedGraph

visitNamedGraphs

defaultGraph

defaultGraph

defaultGraph

defaultGraph

findRootGraphsForType

findRootGraphsForType

findRootGraphsForType