JavaEE API 8.0.1 · javax.persistence.EntityManagerFactory

Method Summary

Modifier and Type	Method and Description
public <T> void	addNamedEntityGraph(String name for the entity graph graphName, EntityGraph<T> entity graph entityGraph) Add a named copy of the EntityGraph to the EntityManagerFactory.
public void	addNamedQuery(String name for the query name, Query Query, TypedQuery, or StoredProcedureQuery object 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` or `createNamedStoredProcedureQuery` method.
public void	close() Close the factory, releasing any resources that it holds.
public EntityManager	Returns: entity manager instance createEntityManager() Create a new application-managed `EntityManager`.
public EntityManager	Returns: entity manager instance createEntityManager(Map<K, V> properties for entity manager map) Create a new application-managed `EntityManager` with the specified Map of properties.
public EntityManager	Returns: entity manager instance createEntityManager(SynchronizationType how and when the entity manager should be synchronized with the current JTA transaction synchronizationType) Create a new JTA application-managed `EntityManager` with the specified synchronization type.
public EntityManager	Returns: entity manager instance createEntityManager(SynchronizationType how and when the entity manager should be synchronized with the current JTA transaction synchronizationType, Map<K, V> properties for entity manager map) Create a new JTA application-managed `EntityManager` with the specified synchronization type and map of properties.
public Cache	Returns: instance of the `Cache` interface or null if no cache is in use getCache() Access the cache that is associated with the entity manager factory (the "second level cache").
public CriteriaBuilder	Returns: CriteriaBuilder instance getCriteriaBuilder() Return an instance of `CriteriaBuilder` for the creation of `CriteriaQuery` objects.
public Metamodel	Returns: Metamodel instance getMetamodel() Return an instance of `Metamodel` interface for access to the metamodel of the persistence unit.
public PersistenceUnitUtil	Returns: `PersistenceUnitUtil` interface getPersistenceUnitUtil() Return interface providing access to utility methods for the persistence unit.
public Map<String, Object>	Returns: properties getProperties() Get the properties and associated values that are in effect for the entity manager factory.
public boolean	Returns: boolean indicating whether the factory is open isOpen() Indicates whether the factory is open.
public <T> T	Returns: an instance of the specified class unwrap(Class<T> the class of the object to be returned. This is normally either the underlying EntityManagerFactory implementation class or an interface that it implements. cls) Return an object of the specified type to allow access to the provider-specific API.

Method Detail

addNamedEntityGraph	back to summary
public <T> void addNamedEntityGraph(String graphName, EntityGraph<T> entityGraph) Add a named copy of the EntityGraph to the EntityManagerFactory. If an entity graph with the same name already exists, it is replaced. Parameters graphName:String name for the entity graph entityGraph:EntityGraph<T> entity graph Since Java Persistence 2.1

addNamedEntityGraph

back to summary

public <T> void addNamedEntityGraph(String graphName, EntityGraph<T> entityGraph)

Add a named copy of the EntityGraph to the EntityManagerFactory. If an entity graph with the same name already exists, it is replaced.

Parameters

graphName:String: name for the entity graph
entityGraph:EntityGraph<T>: entity graph

Since

Java Persistence 2.1

addNamedQuery back to summary

addNamedQuery	back to summary
public 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` or `createNamedStoredProcedureQuery` method. 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 APIs 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` or `createNamedStoredProcedureQuery` 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. Parameters name:String name for the query query:Query Query, TypedQuery, or StoredProcedureQuery object Since Java Persistence 2.1

public 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 or createNamedStoredProcedureQuery method.

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 APIs 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 or createNamedStoredProcedureQuery 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.

Parameters

name:String: name for the query
query:Query: Query, TypedQuery, or StoredProcedureQuery object

Since

Java Persistence 2.1

close back to summary

close	back to summary
public void close() 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. Exceptions IllegalStateException: if the entity manager factory has been closed

public void close()

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.

Exceptions

IllegalStateException:: if the entity manager factory has been closed

createEntityManager back to summary

createEntityManager	back to summary
public EntityManager createEntityManager() Create a new application-managed `EntityManager`. This method returns a new `EntityManager` instance each time it is invoked. The `isOpen` method will return true on the returned instance. Returns:EntityManager entity manager instance Exceptions IllegalStateException: if the entity manager factory has been closed

public EntityManager createEntityManager()

Create a new application-managed EntityManager. This method returns a new EntityManager instance each time it is invoked. The isOpen method will return true on the returned instance.

Returns:EntityManager

entity manager instance

Exceptions

IllegalStateException:: if the entity manager factory has been closed

createEntityManager back to summary

createEntityManager	back to summary
public EntityManager createEntityManager(Map<K, V> map) 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. Parameters map:Map<K, V> properties for entity manager Returns:EntityManager entity manager instance Exceptions IllegalStateException: if the entity manager factory has been closed

public EntityManager createEntityManager(Map<K, V> map)

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.

Parameters

map:Map<K, V>: properties for entity manager

Returns:EntityManager

entity manager instance

Exceptions

IllegalStateException:: if the entity manager factory has been closed

createEntityManager back to summary

createEntityManager	back to summary
public EntityManager createEntityManager(SynchronizationType synchronizationType) 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. Parameters synchronizationType:SynchronizationType how and when the entity manager should be synchronized with the current JTA transaction Returns:EntityManager entity manager instance Exceptions IllegalStateException: if the entity manager factory has been configured for resource-local entity managers or is closed Since Java Persistence 2.1

public EntityManager createEntityManager(SynchronizationType synchronizationType)

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.

Parameters

synchronizationType:SynchronizationType: how and when the entity manager should be synchronized with the current JTA transaction

Returns:EntityManager

entity manager instance

Exceptions

IllegalStateException:: if the entity manager factory has been configured for resource-local entity managers or is closed

Since

Java Persistence 2.1

createEntityManager back to summary

createEntityManager	back to summary
public EntityManager createEntityManager(SynchronizationType synchronizationType, Map<K, V> map) 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. Parameters synchronizationType:SynchronizationType how and when the entity manager should be synchronized with the current JTA transaction map:Map<K, V> properties for entity manager Returns:EntityManager entity manager instance Exceptions IllegalStateException: if the entity manager factory has been configured for resource-local entity managers or is closed Since Java Persistence 2.1

public EntityManager createEntityManager(SynchronizationType synchronizationType, Map<K, V> map)

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.

Parameters

synchronizationType:SynchronizationType: how and when the entity manager should be synchronized with the current JTA transaction
map:Map<K, V>: properties for entity manager

Returns:EntityManager

entity manager instance

Exceptions

IllegalStateException:: if the entity manager factory has been configured for resource-local entity managers or is closed

Since

Java Persistence 2.1

getCache back to summary

getCache	back to summary
public Cache getCache() Access the cache that is associated with the entity manager factory (the "second level cache"). Returns:Cache instance of the `Cache` interface or null if no cache is in use Exceptions IllegalStateException: if the entity manager factory has been closed Since Java Persistence 2.0

public Cache getCache()

Access the cache that is associated with the entity manager factory (the "second level cache").

Returns:Cache

instance of the Cache interface or null if no cache is in use

Exceptions

IllegalStateException:: if the entity manager factory has been closed

Since

Java Persistence 2.0

getCriteriaBuilder back to summary

getCriteriaBuilder	back to summary
public CriteriaBuilder getCriteriaBuilder() Return an instance of `CriteriaBuilder` for the creation of `CriteriaQuery` objects. Returns:CriteriaBuilder CriteriaBuilder instance Exceptions IllegalStateException: if the entity manager factory has been closed Since Java Persistence 2.0

public CriteriaBuilder getCriteriaBuilder()

Return an instance of CriteriaBuilder for the creation of CriteriaQuery objects.

Returns:CriteriaBuilder

CriteriaBuilder instance

Exceptions

IllegalStateException:: if the entity manager factory has been closed

Since

Java Persistence 2.0

getMetamodel back to summary

getMetamodel	back to summary
public Metamodel getMetamodel() Return an instance of `Metamodel` interface for access to the metamodel of the persistence unit. Returns:Metamodel Metamodel instance Exceptions IllegalStateException: if the entity manager factory has been closed Since Java Persistence 2.0

public Metamodel getMetamodel()

Return an instance of Metamodel interface for access to the metamodel of the persistence unit.

Returns:Metamodel

Metamodel instance

Exceptions

IllegalStateException:: if the entity manager factory has been closed

Since

Java Persistence 2.0

getPersistenceUnitUtil back to summary

getPersistenceUnitUtil	back to summary
public PersistenceUnitUtil getPersistenceUnitUtil() Return interface providing access to utility methods for the persistence unit. Returns:PersistenceUnitUtil `PersistenceUnitUtil` interface Exceptions IllegalStateException: if the entity manager factory has been closed Since Java Persistence 2.0

public PersistenceUnitUtil getPersistenceUnitUtil()

Return interface providing access to utility methods for the persistence unit.

Returns:PersistenceUnitUtil

PersistenceUnitUtil interface

Exceptions

IllegalStateException:: if the entity manager factory has been closed

Since

Java Persistence 2.0

getProperties	back to summary
public Map<String, Object> getProperties() 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. Returns:Map<String, Object> properties Exceptions IllegalStateException: if the entity manager factory has been closed Since Java Persistence 2.0

getProperties

back to summary

public Map<String, Object> getProperties()

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.

Returns:Map<String, Object>

properties

Exceptions

IllegalStateException:: if the entity manager factory has been closed

Since

Java Persistence 2.0

isOpen	back to summary
public boolean isOpen() Indicates whether the factory is open. Returns true until the factory has been closed. Returns:boolean boolean indicating whether the factory is open

isOpen

back to summary

public boolean isOpen()

Indicates whether the factory is open. Returns true until the factory has been closed.

Returns:boolean: boolean indicating whether the factory is open

unwrap	back to summary
public <T> T unwrap(Class<T> cls) 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. Parameters cls:Class<T> the class of the object to be returned. This is normally either the underlying EntityManagerFactory implementation class or an interface that it implements. Returns:T an instance of the specified class Exceptions PersistenceException: if the provider does not support the call Since Java Persistence 2.1

unwrap

back to summary

public <T> T unwrap(Class<T> cls)

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.

Parameters

cls:Class<T>: the class of the object to be returned. This is normally either the underlying EntityManagerFactory implementation class or an interface that it implements.

Returns:T

an instance of the specified class

Exceptions

PersistenceException:: if the provider does not support the call

Since

Java Persistence 2.1

public Interface EntityManagerFactory

Method Summary

Method Detail