com.afrunt.jpa.powerdao

Class AbstractEntityManagerAdapter

java.lang.Object

com.afrunt.jpa.powerdao.AbstractEntityManagerAdapter

All Implemented Interfaces:

EntityManagerAdapter, WithCollectionOperations, javax.persistence.EntityManager

Direct Known Subclasses:

AbstractExtendedQueryApiDao

public abstract class AbstractEntityManagerAdapter
extends Object
implements EntityManagerAdapter

Author:

Andrii Frunt

Constructor Summary

Constructors

Constructor and Description
AbstractEntityManagerAdapter()

Method Summary

Modifier and Type	Method and Description
void	clear()
void	close()
boolean	contains(Object entity)
<T> javax.persistence.EntityGraph<T>	createEntityGraph(Class<T> rootType)
javax.persistence.EntityGraph<?>	createEntityGraph(String graphName)
javax.persistence.Query	createNamedQuery(String name) Create an instance of Query for executing a named query (in the Java Persistence query language or in native SQL).
<T> javax.persistence.TypedQuery<T>	createNamedQuery(String name, Class<T> resultClass) Create an instance of TypedQuery for executing a Java Persistence query language named query.
javax.persistence.StoredProcedureQuery	createNamedStoredProcedureQuery(String name)
javax.persistence.Query	createNativeQuery(String sql)
javax.persistence.Query	createNativeQuery(String sqlString, Class resultClass)
javax.persistence.Query	createNativeQuery(String sqlString, String resultSetMapping)
javax.persistence.Query	createQuery(javax.persistence.criteria.CriteriaDelete deleteQuery) Create an instance of Query for executing a criteria delete query.
<T> javax.persistence.TypedQuery<T>	createQuery(javax.persistence.criteria.CriteriaQuery<T> criteriaQuery) Create an instance of TypedQuery for executing a criteria query.
javax.persistence.Query	createQuery(javax.persistence.criteria.CriteriaUpdate updateQuery) Create an instance of Query for executing a criteria update query.
javax.persistence.Query	createQuery(String qlString) Create an instance of Query for executing a Java Persistence query language statement.
<T> javax.persistence.TypedQuery<T>	createQuery(String qlString, Class<T> resultClass) Create an instance of TypedQuery for executing a Java Persistence query language statement.
javax.persistence.StoredProcedureQuery	createStoredProcedureQuery(String procedureName)
javax.persistence.StoredProcedureQuery	createStoredProcedureQuery(String procedureName, Class... resultClasses)
javax.persistence.StoredProcedureQuery	createStoredProcedureQuery(String procedureName, String... resultSetMappings)
void	detach(Object entity)
<T> T	find(Class<T> entityClass, Object primaryKey) Find by primary key.
<T> T	find(Class<T> entityClass, Object primaryKey, javax.persistence.LockModeType lockMode) Find by primary key and lock.
<T> T	find(Class<T> entityClass, Object primaryKey, javax.persistence.LockModeType lockMode, Map<String,Object> properties) Find by primary key and lock, using the specified properties.
<T> T	find(Class<T> entityClass, Object primaryKey, Map<String,Object> properties) Find by primary key, using the specified properties.
void	flush()
javax.persistence.criteria.CriteriaBuilder	getCriteriaBuilder() Return an instance of CriteriaBuilder for the creation of CriteriaQuery objects.
Object	getDelegate()
javax.persistence.EntityGraph<?>	getEntityGraph(String graphName)
<T> List<javax.persistence.EntityGraph<? super T>>	getEntityGraphs(Class<T> entityClass)
protected Class<?>	getEntityIdType(Class<?> entity)
protected Class<?>	getEntityIdType(javax.persistence.metamodel.EntityType<?> entity)
javax.persistence.EntityManagerFactory	getEntityManagerFactory()
protected javax.persistence.metamodel.EntityType<?>	getEntityMetaModel(Class<?> entityType)
javax.persistence.FlushModeType	getFlushMode()
protected String	getIdFieldName(Class<?> entityType)
javax.persistence.LockModeType	getLockMode(Object entity)
javax.persistence.metamodel.Metamodel	getMetamodel() Return an instance of Metamodel interface for access to the metamodel of the persistence unit.
Map<String,Object>	getProperties()
<T> T	getReference(Class<T> entityClass, Object primaryKey)
javax.persistence.EntityTransaction	getTransaction()
boolean	isJoinedToTransaction()
boolean	isOpen()
void	joinTransaction()
void	lock(Object entity, javax.persistence.LockModeType lockMode)
void	lock(Object entity, javax.persistence.LockModeType lockMode, Map<String,Object> properties)
<T> T	merge(T entity)
void	persist(Object entity)
void	refresh(Object entity)
void	refresh(Object entity, javax.persistence.LockModeType lockMode)
void	refresh(Object entity, javax.persistence.LockModeType lockMode, Map<String,Object> properties)
void	refresh(Object entity, Map<String,Object> properties)
void	remove(Object entity)
void	setFlushMode(javax.persistence.FlushModeType flushMode)
void	setProperty(String propertyName, Object value)
<T> T	unwrap(Class<T> cls)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.afrunt.jpa.powerdao.EntityManagerAdapter

getEntityManager

Methods inherited from interface com.afrunt.jpa.powerdao.WithCollectionOperations

emptyMap, listOf, mapOf, mapPartitions, mapPartitions, partitions, partitionsStream, partitionsTo, range, range, rawRange, rawRange

Constructor Detail

AbstractEntityManagerAdapter

public AbstractEntityManagerAdapter()

Method Detail

createNativeQuery

public javax.persistence.Query createNativeQuery(String sql)

Specified by:

createNativeQuery in interface EntityManagerAdapter

Specified by:

createNativeQuery in interface javax.persistence.EntityManager

createNativeQuery

public javax.persistence.Query createNativeQuery(String sqlString,
                                                 Class resultClass)

Specified by:

createNativeQuery in interface EntityManagerAdapter

Specified by:

createNativeQuery in interface javax.persistence.EntityManager

createNativeQuery

public javax.persistence.Query createNativeQuery(String sqlString,
                                                 String resultSetMapping)

Specified by:

createNativeQuery in interface EntityManagerAdapter

Specified by:

createNativeQuery in interface javax.persistence.EntityManager

createQuery

public javax.persistence.Query createQuery(String qlString)

Create an instance of Query for executing a Java Persistence query language statement.

Specified by:

createQuery in interface EntityManagerAdapter

Specified by:

createQuery in interface javax.persistence.EntityManager

Parameters:

qlString - a Java Persistence query string

Returns:

the new query instance

Throws:

IllegalArgumentException - if the query string is found to be invalid

createQuery

public <T> javax.persistence.TypedQuery<T> createQuery(javax.persistence.criteria.CriteriaQuery<T> criteriaQuery)

Create an instance of TypedQuery for executing a criteria query.

Specified by:

createQuery in interface EntityManagerAdapter

Specified by:

createQuery in interface javax.persistence.EntityManager

Parameters:

criteriaQuery - a criteria query object

Returns:

the new query instance

Throws:

IllegalArgumentException - if the criteria query is found to be invalid

Since:

Java Persistence 2.0

createQuery

public javax.persistence.Query createQuery(javax.persistence.criteria.CriteriaUpdate updateQuery)

Create an instance of Query for executing a criteria update query.

Specified by:

createQuery in interface EntityManagerAdapter

Specified by:

createQuery in interface javax.persistence.EntityManager

Parameters:

updateQuery - a criteria update query object

Returns:

the new query instance

Throws:

IllegalArgumentException - if the update query is found to be invalid

createQuery

public javax.persistence.Query createQuery(javax.persistence.criteria.CriteriaDelete deleteQuery)

Create an instance of Query for executing a criteria delete query.

Specified by:

createQuery in interface EntityManagerAdapter

Specified by:

createQuery in interface javax.persistence.EntityManager

Parameters:

deleteQuery - a criteria delete query object

Returns:

the new query instance

Throws:

IllegalArgumentException - if the delete query isfound to be invalid

createQuery

public <T> javax.persistence.TypedQuery<T> createQuery(String qlString,
                                                       Class<T> resultClass)

Create an instance of TypedQuery for executing a Java Persistence query language statement. The select list of the query must contain only a single item, which must be assignable to the type specified by the resultClass argument.

Specified by:

createQuery in interface EntityManagerAdapter

Specified by:

createQuery in interface javax.persistence.EntityManager

Parameters:

qlString - a Java Persistence query string

resultClass - the type of the query result

Returns:

the new query instance

Throws:

IllegalArgumentException - if the query string is found to be invalid or if the query result is found to not be assignable to the specified type

Since:

Java Persistence 2.0

createNamedQuery

public javax.persistence.Query createNamedQuery(String name)

Create an instance of Query for executing a named query (in the Java Persistence query language or in native SQL).

Specified by:

createNamedQuery in interface EntityManagerAdapter

Specified by:

createNamedQuery in interface javax.persistence.EntityManager

Parameters:

name - the name of a query defined in metadata

Returns:

the new query instance

Throws:

IllegalArgumentException - if a query has not been defined with the given name or if the query string is found to be invalid

createNamedQuery

public <T> javax.persistence.TypedQuery<T> createNamedQuery(String name,
                                                            Class<T> resultClass)

Create an instance of TypedQuery for executing a Java Persistence query language named query. The select list of the query must contain only a single item, which must be assignable to the type specified by the resultClass argument.

Specified by:

createNamedQuery in interface EntityManagerAdapter

Specified by:

createNamedQuery in interface javax.persistence.EntityManager

Parameters:

name - the name of a query defined in metadata

resultClass - the type of the query result

Returns:

the new query instance

Throws:

IllegalArgumentException - if a query has not been defined with the given name or if the query string is found to be invalid or if the query result is found to not be assignable to the specified type

Since:

Java Persistence 2.0

getCriteriaBuilder

public javax.persistence.criteria.CriteriaBuilder getCriteriaBuilder()

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

Specified by:

getCriteriaBuilder in interface EntityManagerAdapter

Specified by:

getCriteriaBuilder in interface javax.persistence.EntityManager

Returns:

CriteriaBuilder instance

Throws:

IllegalStateException - if the entity manager has been closed

Since:

Java Persistence 2.0

find

public <T> T find(Class<T> entityClass,
                  Object primaryKey)

Find by primary key. Search for an entity of the specified class and primary key. If the entity instance is contained in the persistence context, it is returned from there.

Specified by:

find in interface EntityManagerAdapter

Specified by:

find in interface javax.persistence.EntityManager

Parameters:

entityClass - entity class

primaryKey - primary key

Returns:

the found entity instance or null if the entity does not exist

Throws:

IllegalArgumentException - if the first argument does not denote an entity type or the second argument is is not a valid type for that entity's primary key or is null

find

public <T> T find(Class<T> entityClass,
                  Object primaryKey,
                  Map<String,Object> properties)

Find by primary key, using the specified properties. Search for an entity of the specified class and primary key. If the entity instance is contained in the persistence context, it is returned from there. If a vendor-specific property or hint is not recognized, it is silently ignored.

Specified by:

find in interface EntityManagerAdapter

Specified by:

find in interface javax.persistence.EntityManager

Parameters:

entityClass - entity class

primaryKey - primary key

properties - standard and vendor-specific properties and hints

Returns:

the found entity instance or null if the entity does not exist

Throws:

IllegalArgumentException - if the first argument does not denote an entity type or the second argument is is not a valid type for that entity's primary key or is null

Since:

Java Persistence 2.0

find

public <T> T find(Class<T> entityClass,
                  Object primaryKey,
                  javax.persistence.LockModeType lockMode)

Find by primary key and lock. Search for an entity of the specified class and primary key and lock it with respect to the specified lock type. If the entity instance is contained in the persistence context, it is returned from there, and the effect of this method is the same as if the lock method had been called on the entity.

If the entity is found within the persistence context and the lock mode type is pessimistic and the entity has a version attribute, the persistence provider must perform optimistic version checks when obtaining the database lock. If these checks fail, the OptimisticLockException will be thrown.

If the lock mode type is pessimistic and the entity instance is found but cannot be locked:

• the PessimisticLockException will be thrown if the database locking failure causes transaction-level rollback
• the LockTimeoutException will be thrown if the database locking failure causes only statement-level rollback

Specified by:

find in interface EntityManagerAdapter

Specified by:

find in interface javax.persistence.EntityManager

Parameters:

entityClass - entity class

primaryKey - primary key

lockMode - lock mode

Returns:

the found entity instance or null if the entity does not exist

Throws:

IllegalArgumentException - if the first argument does not denote an entity type or the second argument is not a valid type for that entity's primary key or is null

javax.persistence.TransactionRequiredException - if there is no transaction and a lock mode other than NONE is specified or if invoked on an entity manager which has not been joined to the current transaction and a lock mode other than NONE is specified

javax.persistence.OptimisticLockException - if the optimistic version check fails

javax.persistence.PessimisticLockException - if pessimistic locking fails and the transaction is rolled back

javax.persistence.LockTimeoutException - if pessimistic locking fails and only the statement is rolled back

javax.persistence.PersistenceException - if an unsupported lock call is made

Since:

Java Persistence 2.0

find

public <T> T find(Class<T> entityClass,
                  Object primaryKey,
                  javax.persistence.LockModeType lockMode,
                  Map<String,Object> properties)

Find by primary key and lock, using the specified properties. Search for an entity of the specified class and primary key and lock it with respect to the specified lock type. If the entity instance is contained in the persistence context, it is returned from there.

If the entity is found within the persistence context and the lock mode type is pessimistic and the entity has a version attribute, the persistence provider must perform optimistic version checks when obtaining the database lock. If these checks fail, the OptimisticLockException will be thrown.

If the lock mode type is pessimistic and the entity instance is found but cannot be locked:

• the PessimisticLockException will be thrown if the database locking failure causes transaction-level rollback
• the LockTimeoutException will be thrown if the database locking failure causes only statement-level rollback

If a vendor-specific property or hint is not recognized, it is silently ignored.

Portable applications should not rely on the standard timeout hint. Depending on the database in use and the locking mechanisms used by the provider, the hint may or may not be observed.

Specified by:

find in interface EntityManagerAdapter

Specified by:

find in interface javax.persistence.EntityManager

Parameters:

entityClass - entity class

primaryKey - primary key

lockMode - lock mode

properties - standard and vendor-specific properties and hints

Returns:

the found entity instance or null if the entity does not exist

Throws:

IllegalArgumentException - if the first argument does not denote an entity type or the second argument is not a valid type for that entity's primary key or is null

javax.persistence.TransactionRequiredException - if there is no transaction and a lock mode other than NONE is specified or if invoked on an entity manager which has not been joined to the current transaction and a lock mode other than NONE is specified

javax.persistence.OptimisticLockException - if the optimistic version check fails

javax.persistence.PessimisticLockException - if pessimistic locking fails and the transaction is rolled back

javax.persistence.LockTimeoutException - if pessimistic locking fails and only the statement is rolled back

javax.persistence.PersistenceException - if an unsupported lock call is made

Since:

Java Persistence 2.0

merge

public <T> T merge(T entity)

Specified by:

merge in interface EntityManagerAdapter

Specified by:

merge in interface javax.persistence.EntityManager

remove

public void remove(Object entity)

Specified by:

remove in interface EntityManagerAdapter

Specified by:

remove in interface javax.persistence.EntityManager

getMetamodel

public javax.persistence.metamodel.Metamodel getMetamodel()

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

Specified by:

getMetamodel in interface EntityManagerAdapter

Specified by:

getMetamodel in interface javax.persistence.EntityManager

Returns:

Metamodel instance

Throws:

IllegalStateException - if the entity manager has been closed

Since:

Java Persistence 2.0

persist

public void persist(Object entity)

Specified by:

persist in interface EntityManagerAdapter

Specified by:

persist in interface javax.persistence.EntityManager

getReference

public <T> T getReference(Class<T> entityClass,
                          Object primaryKey)

Specified by:

getReference in interface EntityManagerAdapter

Specified by:

getReference in interface javax.persistence.EntityManager

flush

public void flush()

Specified by:

flush in interface EntityManagerAdapter

Specified by:

flush in interface javax.persistence.EntityManager

getFlushMode

public javax.persistence.FlushModeType getFlushMode()

Specified by:

getFlushMode in interface EntityManagerAdapter

Specified by:

getFlushMode in interface javax.persistence.EntityManager

setFlushMode

public void setFlushMode(javax.persistence.FlushModeType flushMode)

Specified by:

setFlushMode in interface EntityManagerAdapter

Specified by:

setFlushMode in interface javax.persistence.EntityManager

lock

public void lock(Object entity,
                 javax.persistence.LockModeType lockMode)

Specified by:

lock in interface EntityManagerAdapter

Specified by:

lock in interface javax.persistence.EntityManager

lock

public void lock(Object entity,
                 javax.persistence.LockModeType lockMode,
                 Map<String,Object> properties)

Specified by:

lock in interface EntityManagerAdapter

Specified by:

lock in interface javax.persistence.EntityManager

refresh

public void refresh(Object entity)

Specified by:

refresh in interface EntityManagerAdapter

Specified by:

refresh in interface javax.persistence.EntityManager

refresh

public void refresh(Object entity,
                    Map<String,Object> properties)

Specified by:

refresh in interface EntityManagerAdapter

Specified by:

refresh in interface javax.persistence.EntityManager

refresh

public void refresh(Object entity,
                    javax.persistence.LockModeType lockMode)

Specified by:

refresh in interface EntityManagerAdapter

Specified by:

refresh in interface javax.persistence.EntityManager

refresh

public void refresh(Object entity,
                    javax.persistence.LockModeType lockMode,
                    Map<String,Object> properties)

Specified by:

refresh in interface EntityManagerAdapter

Specified by:

refresh in interface javax.persistence.EntityManager

clear

public void clear()

Specified by:

clear in interface EntityManagerAdapter

Specified by:

clear in interface javax.persistence.EntityManager

detach

public void detach(Object entity)

Specified by:

detach in interface EntityManagerAdapter

Specified by:

detach in interface javax.persistence.EntityManager

contains

public boolean contains(Object entity)

Specified by:

contains in interface EntityManagerAdapter

Specified by:

contains in interface javax.persistence.EntityManager

getLockMode

public javax.persistence.LockModeType getLockMode(Object entity)

Specified by:

getLockMode in interface EntityManagerAdapter

Specified by:

getLockMode in interface javax.persistence.EntityManager

setProperty

public void setProperty(String propertyName,
                        Object value)

Specified by:

setProperty in interface EntityManagerAdapter

Specified by:

setProperty in interface javax.persistence.EntityManager

getProperties

public Map<String,Object> getProperties()

Specified by:

getProperties in interface EntityManagerAdapter

Specified by:

getProperties in interface javax.persistence.EntityManager

createNamedStoredProcedureQuery

public javax.persistence.StoredProcedureQuery createNamedStoredProcedureQuery(String name)

Specified by:

createNamedStoredProcedureQuery in interface EntityManagerAdapter

Specified by:

createNamedStoredProcedureQuery in interface javax.persistence.EntityManager

createStoredProcedureQuery

public javax.persistence.StoredProcedureQuery createStoredProcedureQuery(String procedureName)

Specified by:

createStoredProcedureQuery in interface EntityManagerAdapter

Specified by:

createStoredProcedureQuery in interface javax.persistence.EntityManager

createStoredProcedureQuery

public javax.persistence.StoredProcedureQuery createStoredProcedureQuery(String procedureName,
                                                                         Class... resultClasses)

Specified by:

createStoredProcedureQuery in interface EntityManagerAdapter

Specified by:

createStoredProcedureQuery in interface javax.persistence.EntityManager

createStoredProcedureQuery

public javax.persistence.StoredProcedureQuery createStoredProcedureQuery(String procedureName,
                                                                         String... resultSetMappings)

Specified by:

createStoredProcedureQuery in interface EntityManagerAdapter

Specified by:

createStoredProcedureQuery in interface javax.persistence.EntityManager

joinTransaction

public void joinTransaction()

Specified by:

joinTransaction in interface EntityManagerAdapter

Specified by:

joinTransaction in interface javax.persistence.EntityManager

isJoinedToTransaction

public boolean isJoinedToTransaction()

Specified by:

isJoinedToTransaction in interface EntityManagerAdapter

Specified by:

isJoinedToTransaction in interface javax.persistence.EntityManager

unwrap

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

Specified by:

unwrap in interface EntityManagerAdapter

Specified by:

unwrap in interface javax.persistence.EntityManager

getDelegate

public Object getDelegate()

Specified by:

getDelegate in interface EntityManagerAdapter

Specified by:

getDelegate in interface javax.persistence.EntityManager

close

public void close()

Specified by:

close in interface EntityManagerAdapter

Specified by:

close in interface javax.persistence.EntityManager

isOpen

public boolean isOpen()

Specified by:

isOpen in interface EntityManagerAdapter

Specified by:

isOpen in interface javax.persistence.EntityManager

getTransaction

public javax.persistence.EntityTransaction getTransaction()

Specified by:

getTransaction in interface EntityManagerAdapter

Specified by:

getTransaction in interface javax.persistence.EntityManager

getEntityManagerFactory

public javax.persistence.EntityManagerFactory getEntityManagerFactory()

Specified by:

getEntityManagerFactory in interface EntityManagerAdapter

Specified by:

getEntityManagerFactory in interface javax.persistence.EntityManager

createEntityGraph

public <T> javax.persistence.EntityGraph<T> createEntityGraph(Class<T> rootType)

Specified by:

createEntityGraph in interface EntityManagerAdapter

Specified by:

createEntityGraph in interface javax.persistence.EntityManager

createEntityGraph

public javax.persistence.EntityGraph<?> createEntityGraph(String graphName)

Specified by:

createEntityGraph in interface EntityManagerAdapter

Specified by:

createEntityGraph in interface javax.persistence.EntityManager

getEntityGraph

public javax.persistence.EntityGraph<?> getEntityGraph(String graphName)

Specified by:

getEntityGraph in interface EntityManagerAdapter

Specified by:

getEntityGraph in interface javax.persistence.EntityManager

getEntityGraphs

public <T> List<javax.persistence.EntityGraph<? super T>> getEntityGraphs(Class<T> entityClass)

Specified by:

getEntityGraphs in interface EntityManagerAdapter

Specified by:

getEntityGraphs in interface javax.persistence.EntityManager

getIdFieldName

protected String getIdFieldName(Class<?> entityType)

getEntityIdType

protected Class<?> getEntityIdType(Class<?> entity)

getEntityIdType

protected Class<?> getEntityIdType(javax.persistence.metamodel.EntityType<?> entity)

getEntityMetaModel

protected javax.persistence.metamodel.EntityType<?> getEntityMetaModel(Class<?> entityType)