MetamodelImpl (Red Hat JBoss Enterprise Application Platform 7.2.0.GA public API)

java.lang.Object
- org.hibernate.metamodel.internal.MetamodelImpl

All Implemented Interfaces:

Serializable, Metamodel, MetamodelImplementor
```
public class MetamodelImpl
extends Object
implements MetamodelImplementor, Serializable
```
Hibernate implementation of the JPA Metamodel contract.

Author:

Steve Ebersole, Emmanuel Bernard

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

MetamodelImpl(SessionFactoryImplementor sessionFactory, TypeConfiguration typeConfiguration)

Constructors
Constructor and Description
`MetamodelImpl(SessionFactoryImplementor sessionFactory, TypeConfiguration typeConfiguration)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> void`	`addNamedEntityGraph(String graphName, EntityGraph<T> entityGraph)`
`void`	`close()`
`CollectionPersister`	`collectionPersister(String role)` Get the persister object for a collection role.
`Map<String,CollectionPersister>`	`collectionPersisters()` Get all collection persisters as a Map, which collection role as the key and the persister is the value.
`<X> EmbeddableType<X>`	`embeddable(Class<X> cls)` Return the metamodel embeddable type representing the embeddable class.
`<X> EntityType<X>`	`entity(Class<X> cls)` Return the metamodel entity type representing the entity.
`<X> EntityType<X>`	`entity(String entityName)` Access to an entity supporting Hibernate's entity-name feature
`EntityPersister`	`entityPersister(Class entityClass)` Locate the persister for an entity by the entity class.
`EntityPersister`	`entityPersister(String entityName)` Locate the persister for an entity by the entity-name
`Map<String,EntityPersister>`	`entityPersisters()` Get all entity persisters as a Map, which entity name its the key and the persister is the value.
`<T> EntityGraph<T>`	`findEntityGraphByName(String name)`
`<T> List<EntityGraph<? super T>>`	`findEntityGraphsByType(Class<T> entityClass)`
`String[]`	`getAllCollectionRoles()` Get the names of all collections known to this Metamodel
`String[]`	`getAllEntityNames()` Get the names of all entities known to this Metamodel
`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()` Return the metamodel embeddable types.
`Set<EntityType<?>>`	`getEntities()` Return the metamodel entity types.
`Collection<EntityNameResolver>`	`getEntityNameResolvers()`
`String[]`	`getImplementors(String className)` Given the name of an entity class, determine all the class and interface names by which it can be referenced in an HQL query.
`String`	`getImportedClassName(String className)`
`Set<ManagedType<?>>`	`getManagedTypes()` Return the metamodel managed types.
`SessionFactoryImplementor`	`getSessionFactory()` Access to the SessionFactory that this Metamodel instance is bound to.
`TypeConfiguration`	`getTypeConfiguration()` Access to the TypeConfiguration in effect for this SessionFactory/Metamodel
`void`	`initialize(MetadataImplementor mappingMetadata, JpaMetaModelPopulationSetting jpaMetaModelPopulationSetting)` Prepare the metamodel using the information from the collection of Hibernate `PersistentClass` models
`EntityPersister`	`locateEntityPersister(Class byClass)` Locate an EntityPersister by the entity class.
`EntityPersister`	`locateEntityPersister(String byName)` Locate the entity persister by name.
`<X> ManagedType<X>`	`managedType(Class<X> cls)` Return the metamodel managed type representing the entity, mapped superclass, or embeddable class.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.Metamodel
getEntityTypeByName

- Constructor Detail
  - MetamodelImpl
```
public MetamodelImpl(SessionFactoryImplementor sessionFactory,
                     TypeConfiguration typeConfiguration)
```
- Method Detail
  - initialize
```
public void initialize(MetadataImplementor mappingMetadata,
                       JpaMetaModelPopulationSetting jpaMetaModelPopulationSetting)
```
    Prepare the metamodel using the information from the collection of Hibernate PersistentClass models
    
    Parameters:
    
    mappingMetadata - The mapping information
    
    jpaMetaModelPopulationSetting - Should the JPA Metamodel be built as well?
  - getEntityNameResolvers
```
public Collection<EntityNameResolver> getEntityNameResolvers()
```
    Specified by:
    
    getEntityNameResolvers in interface MetamodelImplementor
  - getTypeConfiguration
```
public TypeConfiguration getTypeConfiguration()
```
    Description copied from interface: MetamodelImplementor
    
    Access to the TypeConfiguration in effect for this SessionFactory/Metamodel
    
    Specified by:
    
    getTypeConfiguration in interface MetamodelImplementor
    
    Returns:
    
    Access to the TypeConfiguration
  - getSessionFactory
```
public SessionFactoryImplementor getSessionFactory()
```
    Description copied from interface: Metamodel
    
    Access to the SessionFactory that this Metamodel instance is bound to.
    
    Specified by:
    
    getSessionFactory in interface MetamodelImplementor
    
    Returns:
    
    The SessionFactory
  - entity
```
public <X> EntityType<X> entity(Class<X> cls)
```
    Description copied from interface: Metamodel
    
    Return the metamodel entity type representing the entity.
    
    Specified by:
    
    entity in interface Metamodel
    
    Parameters:
    
    cls - the type of the represented entity
    
    Returns:
    
    the metamodel entity type
  - managedType
```
public <X> ManagedType<X> managedType(Class<X> cls)
```
    Description copied from interface: Metamodel
    
    Return the metamodel managed type representing the entity, mapped superclass, or embeddable class.
    
    Specified by:
    
    managedType in interface Metamodel
    
    Parameters:
    
    cls - the type of the represented managed class
    
    Returns:
    
    the metamodel managed type
  - embeddable
```
public <X> EmbeddableType<X> embeddable(Class<X> cls)
```
    Description copied from interface: Metamodel
    
    Return the metamodel embeddable type representing the embeddable class.
    
    Specified by:
    
    embeddable in interface Metamodel
    
    Parameters:
    
    cls - the type of the represented embeddable class
    
    Returns:
    
    the metamodel embeddable type
  - getManagedTypes
```
public Set<ManagedType<?>> getManagedTypes()
```
    Description copied from interface: Metamodel
    
    Return the metamodel managed types.
    
    Specified by:
    
    getManagedTypes in interface Metamodel
    
    Returns:
    
    the metamodel managed types
  - getEntities
```
public Set<EntityType<?>> getEntities()
```
    Description copied from interface: Metamodel
    
    Return the metamodel entity types.
    
    Specified by:
    
    getEntities in interface Metamodel
    
    Returns:
    
    the metamodel entity types
  - getEmbeddables
```
public Set<EmbeddableType<?>> getEmbeddables()
```
    Description copied from interface: Metamodel
    
    Return the metamodel embeddable types. Returns empty set if there are no embeddable types.
    
    Specified by:
    
    getEmbeddables in interface Metamodel
    
    Returns:
    
    the metamodel embeddable types
  - entity
```
public <X> EntityType<X> entity(String entityName)
```
    Description copied from interface: Metamodel
    
    Access to an entity supporting Hibernate's entity-name feature
    
    Parameters:
    
    entityName - The entity-name
    
    Returns:
    
    The entity descriptor
  - getImportedClassName
```
public String getImportedClassName(String className)
```
  - getImplementors
```
public String[] getImplementors(String className)
                         throws MappingException
```
    Description copied from interface: Metamodel
    
    Given the name of an entity class, determine all the class and interface names by which it can be referenced in an HQL query.
    
    Parameters:
    
    className - The name of the entity class
    
    Returns:
    
    the names of all persistent (mapped) classes that extend or implement the given class or interface, accounting for implicit/explicit polymorphism settings and excluding mapped subclasses/joined-subclasses of other classes in the result.
    
    Throws:
    
    MappingException
  - entityPersisters
```
public Map<String,EntityPersister> entityPersisters()
```
    Description copied from interface: MetamodelImplementor
    
    Get all entity persisters as a Map, which entity name its the key and the persister is the value.
    
    Specified by:
    
    entityPersisters in interface MetamodelImplementor
    
    Returns:
    
    The Map contains all entity persisters.
  - collectionPersister
```
public CollectionPersister collectionPersister(String role)
```
    Description copied from interface: MetamodelImplementor
    
    Get the persister object for a collection role.
    
    Specified by:
    
    collectionPersister in interface MetamodelImplementor
    
    Parameters:
    
    role - The role of the collection for which to retrieve the persister.
    
    Returns:
    
    The persister
  - collectionPersisters
```
public Map<String,CollectionPersister> collectionPersisters()
```
    Description copied from interface: MetamodelImplementor
    
    Get all collection persisters as a Map, which collection role as the key and the persister is the value.
    
    Specified by:
    
    collectionPersisters in interface MetamodelImplementor
    
    Returns:
    
    The Map contains all collection persisters.
  - entityPersister
```
public EntityPersister entityPersister(Class entityClass)
```
    Description copied from interface: MetamodelImplementor
    
    Locate the persister for an entity by the entity class.
    
    Specified by:
    
    entityPersister in interface MetamodelImplementor
    
    Parameters:
    
    entityClass - The entity class
    
    Returns:
    
    The entity persister
  - entityPersister
```
public EntityPersister entityPersister(String entityName)
                                throws MappingException
```
    Description copied from interface: MetamodelImplementor
    
    Locate the persister for an entity by the entity-name
    
    Specified by:
    
    entityPersister in interface MetamodelImplementor
    
    Parameters:
    
    entityName - The name of the entity for which to retrieve the persister.
    
    Returns:
    
    The persister
    
    Throws:
    
    MappingException - Indicates persister could not be found with that name.
  - locateEntityPersister
```
public EntityPersister locateEntityPersister(Class byClass)
```
    Description copied from interface: MetamodelImplementor
    
    Locate an EntityPersister by the entity class. The passed Class might refer to either the entity name directly, or it might name a proxy interface for the entity. This method accounts for both, preferring the direct named entity name.
    
    Specified by:
    
    locateEntityPersister in interface MetamodelImplementor
    
    Parameters:
    
    byClass - The concrete Class or proxy interface for the entity to locate the persister for.
    
    Returns:
    
    The located EntityPersister, never null
  - locateEntityPersister
```
public EntityPersister locateEntityPersister(String byName)
```
    Description copied from interface: MetamodelImplementor
    
    Locate the entity persister by name.
    
    Specified by:
    
    locateEntityPersister in interface MetamodelImplementor
    
    Parameters:
    
    byName - The entity name
    
    Returns:
    
    The located EntityPersister, never null
  - getCollectionRolesByEntityParticipant
```
public Set<String> getCollectionRolesByEntityParticipant(String entityName)
```
    Description copied from interface: MetamodelImplementor
    
    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 MetamodelImplementor
    
    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.
  - getAllEntityNames
```
public String[] getAllEntityNames()
```
    Description copied from interface: MetamodelImplementor
    
    Get the names of all entities known to this Metamodel
    
    Specified by:
    
    getAllEntityNames in interface MetamodelImplementor
    
    Returns:
    
    All of the entity names
  - getAllCollectionRoles
```
public String[] getAllCollectionRoles()
```
    Description copied from interface: MetamodelImplementor
    
    Get the names of all collections known to this Metamodel
    
    Specified by:
    
    getAllCollectionRoles in interface MetamodelImplementor
    
    Returns:
    
    All of the entity names
  - addNamedEntityGraph
```
public <T> void addNamedEntityGraph(String graphName,
                                    EntityGraph<T> entityGraph)
```
    Specified by:
    
    addNamedEntityGraph in interface MetamodelImplementor
  - findEntityGraphByName
```
public <T> EntityGraph<T> findEntityGraphByName(String name)
```
    Specified by:
    
    findEntityGraphByName in interface MetamodelImplementor
  - findEntityGraphsByType
```
public <T> List<EntityGraph<? super T>> findEntityGraphsByType(Class<T> entityClass)
```
    Specified by:
    
    findEntityGraphsByType in interface MetamodelImplementor
  - close
```
public void close()
```
    Specified by:
    
    close in interface MetamodelImplementor

Class MetamodelImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.hibernate.Metamodel

Constructor Detail

MetamodelImpl

Method Detail

initialize

getEntityNameResolvers

getTypeConfiguration

getSessionFactory

entity

managedType

embeddable

getManagedTypes

getEntities

getEmbeddables

entity

getImportedClassName

getImplementors

entityPersisters

collectionPersister

collectionPersisters

entityPersister

entityPersister

locateEntityPersister

locateEntityPersister

getCollectionRolesByEntityParticipant

getAllEntityNames

getAllCollectionRoles

addNamedEntityGraph

findEntityGraphByName

findEntityGraphsByType

close