public interface EntityManagerFactory
When the application has finished using the entity manager
factory, and/or at application shutdown, the application should
close the entity manager factory. Once an
EntityManagerFactory
has been closed, all its entity managers
are considered to be in the closed state.
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.
|
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. |
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.
|
boolean |
isOpen()
Indicates whether the factory is open.
|
<T> T |
unwrap(Class<T> cls)
Return an object of the specified type to allow access to the
provider-specific API.
|
EntityManager createEntityManager()
EntityManager
. This method returns a new
code>EntityManager instance each time it is invoked. The isOpen
method will return true
on the returned instance.IllegalStateException
- if the entity manager factory has been closedEntityManager createEntityManager(Map map)
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.map
- properties for entity managerIllegalStateException
- if the entity manager factory
has been closedEntityManager createEntityManager(SynchronizationType synchronizationType)
synchronizationType
- how and when the entity manager should be synchronized with the current JTA
transactionIllegalStateException
- if the entity manager factory has been configured for resource-local entity
managers or has been closedEntityManager createEntityManager(SynchronizationType synchronizationType, Map map)
synchronizationType
- how and when the entity manager
should be synchronized with the current JTA transactionmap
- properties for entity manager; may be nullIllegalStateException
- if the entity manager factory has been configured for resource-local entity
managers or has been closedCriteriaBuilder getCriteriaBuilder()
CriteriaBuilder
for the creation of
CriteriaQuery
objects.IllegalStateException
- if the entity manager factory
has been closedMetamodel getMetamodel()
Metamodel
interface for access to the
metamodel of the persistence unit.IllegalStateException
- if the entity manager factory
has been closedboolean isOpen()
void close()
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.IllegalStateException
- if the entity manager factory
has been closedMap<String,Object> getProperties()
IllegalStateException
- if the entity manager factory
has been closedCache getCache()
Cache
interfaceIllegalStateException
- if the entity manager factory
has been closedPersistenceUnitUtil getPersistenceUnitUtil()
PersistenceUnitUtil
interfaceIllegalStateException
- if the entity manager factory
has been closedvoid addNamedQuery(String name, Query query)
name
- name for the queryquery
- Query, TypedQuery, or StoredProcedureQuery object<T> T unwrap(Class<T> cls)
cls
- the class of the object to be returned. This is
normally either the underlying EntityManagerFactory
implementation class or an interface that it implements.PersistenceException
- if the provider does not
support the call<T> void addNamedEntityGraph(String graphName, EntityGraph<T> entityGraph)
graphName
- name for the entity graphentityGraph
- entity graphCopyright © 2017 JBoss by Red Hat. All rights reserved.