EntityManagerFactoryImpl (Red Hat JBoss Enterprise Application Platform 7.2.0.Beta public API)

java.lang.Object
- org.hibernate.jpa.internal.EntityManagerFactoryImpl

All Implemented Interfaces:

Serializable, EntityManagerFactory, HibernateEntityManagerFactory
```
public class EntityManagerFactoryImpl
extends Object
implements HibernateEntityManagerFactory
```
Actual Hibernate implementation of EntityManagerFactory.

Author:

Gavin King, Emmanuel Bernard, Steve Ebersole

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`EntityManagerFactoryImpl(String persistenceUnitName, SessionFactoryImplementor sessionFactory, MetadataImplementor metadata, SettingsImpl settings, Map<?,?> configurationValues)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> void`	`addNamedEntityGraph(String graphName, EntityGraph<T> entityGraph)` Add a named copy of the EntityGraph to the EntityManagerFactory.
`void`	`addNamedQuery(String name, Query query)` Define the query, typed query, or stored procedure query as a named query such that future query objects can be created from it using the createNamedQuery methods.
`void`	`close()` Close the factory, releasing any resources that it holds.
`EntityManager`	`createEntityManager()` Create a new application-managed `EntityManager`.
`EntityManager`	`createEntityManager(Map map)` Create a new application-managed `EntityManager` with the specified Map of properties.
`EntityManager`	`createEntityManager(SynchronizationType synchronizationType)` Create a new JTA application-managed EntityManager with the specified synchronization type.
`EntityManager`	`createEntityManager(SynchronizationType synchronizationType, Map map)` Create a new JTA application-managed EntityManager with the specified synchronization type and Map of properties.
`protected org.hibernate.jpa.internal.EntityManagerFactoryImpl.JpaMetaModelPopulationSetting`	`determineJpaMetaModelPopulationSetting(Map configurationValues)`
`EntityGraphImpl`	`findEntityGraphByName(String name)`
`<T> List<EntityGraph<? super T>>`	`findEntityGraphsByType(Class<T> entityClass)` Find all `EntityGraph`s associated with a given entity type.
`Cache`	`getCache()` Access the cache that is associated with the entity manager factory (the "second level cache").
`CriteriaBuilder`	`getCriteriaBuilder()` Return an instance of `CriteriaBuilder` for the creation of `CriteriaQuery` objects.
`String`	`getEntityManagerFactoryName()` Returns the name of the factory.
`EntityType`	`getEntityTypeByName(String entityName)` Find an entity type by name
`Metamodel`	`getMetamodel()` Return an instance of `Metamodel` interface for access to the metamodel of the persistence unit.
`PersistenceUnitUtil`	`getPersistenceUnitUtil()` Return interface providing access to utility methods for the persistence unit.
`Map<String,Object>`	`getProperties()` Get the properties and associated values that are in effect for the entity manager factory.
`SessionFactoryImplementor`	`getSessionFactory()` Obtain the underlying Hibernate SessionFactory.
`boolean`	`isOpen()` Indicates whether the factory is open.
`<T> T`	`unwrap(Class<T> type)` Return an object of the specified type to allow access to the provider-specific API.
`protected void`	`validateNotClosed()`

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

- Constructor Detail
  - EntityManagerFactoryImpl
```
public EntityManagerFactoryImpl(String persistenceUnitName,
                                SessionFactoryImplementor sessionFactory,
                                MetadataImplementor metadata,
                                SettingsImpl settings,
                                Map<?,?> configurationValues)
```
- Method Detail
  - determineJpaMetaModelPopulationSetting
```
protected org.hibernate.jpa.internal.EntityManagerFactoryImpl.JpaMetaModelPopulationSetting determineJpaMetaModelPopulationSetting(Map configurationValues)
```
  - createEntityManager
```
public EntityManager createEntityManager()
```
    Description copied from interface: EntityManagerFactory
    
    Create a new application-managed EntityManager. This method returns a new code>EntityManager instance each time it is invoked. The isOpen method will return true on the returned instance.
    
    Specified by:
    
    createEntityManager in interface EntityManagerFactory
    
    Returns:
    
    entity manager instance
  - createEntityManager
```
public EntityManager createEntityManager(SynchronizationType synchronizationType)
```
    Description copied from interface: EntityManagerFactory
    
    Create a new JTA application-managed EntityManager with the specified synchronization type. This method returns a new EntityManager instance each time it is invoked. The isOpen method will return true on the returned instance.
    
    Specified by:
    
    createEntityManager in interface EntityManagerFactory
    
    Parameters:
    
    synchronizationType - how and when the entity manager should be synchronized with the current JTA transaction
    
    Returns:
    
    entity manager instance
  - createEntityManager
```
public EntityManager createEntityManager(Map map)
```
    Description copied from interface: EntityManagerFactory
    
    Create a new application-managed EntityManager with the specified Map of properties. This method returns a new EntityManager instance each time it is invoked. The isOpen method will return true on the returned instance.
    
    Specified by:
    
    createEntityManager in interface EntityManagerFactory
    
    Parameters:
    
    map - properties for entity manager
    
    Returns:
    
    entity manager instance
  - createEntityManager
```
public EntityManager createEntityManager(SynchronizationType synchronizationType,
                                         Map map)
```
    Description copied from interface: EntityManagerFactory
    
    Create a new JTA application-managed EntityManager with the specified synchronization type and Map of properties. This method returns a new EntityManager instance each time it is invoked. The isOpen method will return true on the returned instance.
    
    Specified by:
    
    createEntityManager in interface EntityManagerFactory
    
    Parameters:
    
    synchronizationType - how and when the entity manager should be synchronized with the current JTA transaction
    
    map - properties for entity manager; may be null
    
    Returns:
    
    entity manager instance
  - getCriteriaBuilder
```
public CriteriaBuilder getCriteriaBuilder()
```
    Description copied from interface: EntityManagerFactory
    
    Return an instance of CriteriaBuilder for the creation of CriteriaQuery objects.
    
    Specified by:
    
    getCriteriaBuilder in interface EntityManagerFactory
    
    Returns:
    
    CriteriaBuilder instance
  - getMetamodel
```
public Metamodel getMetamodel()
```
    Description copied from interface: EntityManagerFactory
    
    Return an instance of Metamodel interface for access to the metamodel of the persistence unit.
    
    Specified by:
    
    getMetamodel in interface EntityManagerFactory
    
    Returns:
    
    Metamodel instance
  - close
```
public void close()
```
    Description copied from interface: EntityManagerFactory
    
    Close the factory, releasing any resources that it holds. After a factory instance has been closed, all methods invoked on it will throw the IllegalStateException, except for isOpen, which will return false. Once an EntityManagerFactory has been closed, all its entity managers are considered to be in the closed state.
    
    Specified by:
    
    close in interface EntityManagerFactory
  - getProperties
```
public Map<String,Object> getProperties()
```
    Description copied from interface: EntityManagerFactory
    
    Get the properties and associated values that are in effect for the entity manager factory. Changing the contents of the map does not change the configuration in effect.
    
    Specified by:
    
    getProperties in interface EntityManagerFactory
    
    Returns:
    
    properties
  - getCache
```
public Cache getCache()
```
    Description copied from interface: EntityManagerFactory
    
    Access the cache that is associated with the entity manager factory (the "second level cache").
    
    Specified by:
    
    getCache in interface EntityManagerFactory
    
    Returns:
    
    instance of the Cache interface
  - validateNotClosed
```
protected void validateNotClosed()
```
  - getPersistenceUnitUtil
```
public PersistenceUnitUtil getPersistenceUnitUtil()
```
    Description copied from interface: EntityManagerFactory
    
    Return interface providing access to utility methods for the persistence unit.
    
    Specified by:
    
    getPersistenceUnitUtil in interface EntityManagerFactory
    
    Returns:
    
    PersistenceUnitUtil interface
  - addNamedQuery
```
public void addNamedQuery(String name,
                          Query query)
```
    Description copied from interface: EntityManagerFactory
    
    Define the query, typed query, or stored procedure query as a named query such that future query objects can be created from it using the createNamedQuery methods. Any configuration of the query object (except for actual parameter binding) in effect when the named query is added is retained as part of the named query definition. This includes configuration information such as max results, hints, flush mode, lock mode, result set mapping information, and information about stored procedure parameters. When the query is executed, information that can be set by means of the Query API can be overridden. Information that is overridden does not affect the named query as registered with the entity manager factory, and thus does not affect subsequent query objects created from it by means of the createNamedQuery method. If a named query of the same name has been previously defined, either statically via metadata or via this method, that query definition is replaced.
    
    Specified by:
    
    addNamedQuery in interface EntityManagerFactory
    
    Parameters:
    
    name - name for the query
    
    query - Query, TypedQuery, or StoredProcedureQuery object
  - unwrap
```
public <T> T unwrap(Class<T> type)
```
    Description copied from interface: EntityManagerFactory
    
    Return an object of the specified type to allow access to the provider-specific API. If the provider's EntityManagerFactory implementation does not support the specified class, the PersistenceException is thrown.
    
    Specified by:
    
    unwrap in interface EntityManagerFactory
    
    Parameters:
    
    type - the class of the object to be returned. This is normally either the underlying EntityManagerFactory implementation class or an interface that it implements.
    
    Returns:
    
    an instance of the specified class
  - addNamedEntityGraph
```
public <T> void addNamedEntityGraph(String graphName,
                                    EntityGraph<T> entityGraph)
```
    Description copied from interface: EntityManagerFactory
    
    Add a named copy of the EntityGraph to the EntityManagerFactory. If an entity graph with the same name already exists, it is replaced.
    
    Specified by:
    
    addNamedEntityGraph in interface EntityManagerFactory
    
    Parameters:
    
    graphName - name for the entity graph
    
    entityGraph - entity graph
  - findEntityGraphByName
```
public EntityGraphImpl findEntityGraphByName(String name)
```
  - findEntityGraphsByType
```
public <T> List<EntityGraph<? super T>> findEntityGraphsByType(Class<T> entityClass)
```
    Description copied from interface: HibernateEntityManagerFactory
    
    Find all EntityGraphs associated with a given entity type.
    
    Specified by:
    
    findEntityGraphsByType in interface HibernateEntityManagerFactory
    
    Parameters:
    
    entityClass - the entity type for which to find all EntityGraphs.
    
    Returns:
    
    A list of EntityGraph instances associated with the given entity type. The empty list is returned in case there are not entity graphs.
  - isOpen
```
public boolean isOpen()
```
    Description copied from interface: EntityManagerFactory
    
    Indicates whether the factory is open. Returns true until the factory has been closed.
    
    Specified by:
    
    isOpen in interface EntityManagerFactory
    
    Returns:
    
    boolean indicating whether the factory is open
  - getSessionFactory
```
public SessionFactoryImplementor getSessionFactory()
```
    Description copied from interface: HibernateEntityManagerFactory
    
    Obtain the underlying Hibernate SessionFactory.
    
    Specified by:
    
    getSessionFactory in interface HibernateEntityManagerFactory
    
    Returns:
    
    The underlying Hibernate SessionFactory
  - getEntityTypeByName
```
public EntityType getEntityTypeByName(String entityName)
```
    Description copied from interface: HibernateEntityManagerFactory
    
    Find an entity type by name
    
    Specified by:
    
    getEntityTypeByName in interface HibernateEntityManagerFactory
    
    Parameters:
    
    entityName - entity name
    
    Returns:
    
    the EntityType for the specified name
  - getEntityManagerFactoryName
```
public String getEntityManagerFactoryName()
```
    Description copied from interface: HibernateEntityManagerFactory
    
    Returns the name of the factory. The name is either can be specified via the property hibernate.ejb.entitymanager_factory_name. If the property is not set the persistence unit name is used. If persistence unit name is not available, a unique name will be generated.
    
    Specified by:
    
    getEntityManagerFactoryName in interface HibernateEntityManagerFactory
    
    Returns:
    
    the name of the factory.

Class EntityManagerFactoryImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EntityManagerFactoryImpl

Method Detail

determineJpaMetaModelPopulationSetting

createEntityManager

createEntityManager

createEntityManager

createEntityManager

getCriteriaBuilder

getMetamodel

close

getProperties

getCache

validateNotClosed

getPersistenceUnitUtil

addNamedQuery

unwrap

addNamedEntityGraph

findEntityGraphByName

findEntityGraphsByType

isOpen

getSessionFactory

getEntityTypeByName

getEntityManagerFactoryName