au.com.cybersearch2.classyjpa.entity

Class EntityManagerImpl

java.lang.Object

au.com.cybersearch2.classyjpa.entity.EntityManagerImpl

All Implemented Interfaces:

EntityManagerLite, UserTransactionSupport

public class EntityManagerImpl
extends Object
implements EntityManagerLite, UserTransactionSupport

EntityManagerImpl Implementation of EntityManager interface Transaction scoped. Entity objects are managed only while a transaction is active. Excect for when the EntityManger has been closed, a new transaction will begin whenever an object needs to be managed and the transaction is not active.

Author:

Andrew Bowley 01/05/2014

Constructor Summary

Constructors

Constructor and Description
EntityManagerImpl(com.j256.ormlite.support.ConnectionSource connectionSource, PersistenceConfig persistenceConfig) Create ClassyEntityManager object

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear the persistence context, causing all managed entities to become detached.
void	close() DO NOT CALL close() as the container will do this automatically.
boolean	contains(Object entity) Check if the instance belongs to the current persistence context.
javax.persistence.Query	createNamedQuery(String name) Create an instance of Query for executing a named query (executed using OrmLite QueryBuilder or in native SQL).
<T> T	find(Class<T> entityClass, Object primaryKey) Find by primary key.
void	flush() Synchronize the persistence context to the underlying database.
Object	getDelegate() Returns EntityManagerDelegate object which provides access to OrmLite DAOs.
javax.persistence.FlushModeType	getFlushMode() Get the flush mode that applies to all objects contained in the persistence context.
<T> T	getReference(Class<T> entityClass, Object primaryKey) Javax PersistenceUnitAdmin: "Get an instance, whose state may be lazily fetched".
javax.persistence.EntityTransaction	getTransaction() Returns the resource-level transaction object, if User Transactions selected, otherwise proxy object returned for which only setRollbackOnly() is active.
boolean	isOpen() Determine whether the entity manager is open.
void	joinTransaction() NOT SUPPORTED Indicate to the EntityManager that a JTA transaction is active.
void	lock(Object entity, javax.persistence.LockModeType lockMode) NOT SUPPORTED.
<T> T	merge(T entity) Merge the state of the given entity into the current persistence context.
void	persist(Object entity) Make an entity instance managed and persistent.
void	refresh(Object entity) Refresh the state of the instance from the database, overwriting changes made to the entity, if any.
void	remove(Object entity) Remove the entity instance.
void	setFlushMode(javax.persistence.FlushModeType flushMode) Set the flush mode that applies to all objects contained in the persistence context.
void	setUserTransaction(boolean value) setUserTransaction Determines if getTransaction() returns null (false) or entityTransaction (true)

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityManagerImpl

public EntityManagerImpl(com.j256.ormlite.support.ConnectionSource connectionSource,
                 PersistenceConfig persistenceConfig)

Create ClassyEntityManager object

Parameters:

connectionSource - Source of all database connections

persistenceConfig - PersistenceUnitAdmin Unit configuration

Method Detail

setUserTransaction

public void setUserTransaction(boolean value)

setUserTransaction Determines if getTransaction() returns null (false) or entityTransaction (true)

Specified by:

setUserTransaction in interface UserTransactionSupport

Parameters:

value - boolean

persist

public void persist(Object entity)

Make an entity instance managed and persistent.

Specified by:

persist in interface EntityManagerLite

Parameters:

entity - The entity instance

Throws:

IllegalArgumentException - if not an entity

IllegalStateException - if this EntityManager has been closed.

merge

public <T> T merge(T entity)

Merge the state of the given entity into the current persistence context.

Specified by:

merge in interface EntityManagerLite

Type Parameters:

T - the object type of the entity

Parameters:

entity - The entity instance

Returns:

The instance that the state was merged to

Throws:

IllegalArgumentException - if instance is not an entity or is a removed entity

IllegalStateException - if this EntityManager has been closed.

refresh

public void refresh(Object entity)

Refresh the state of the instance from the database, overwriting changes made to the entity, if any.

Specified by:

refresh in interface EntityManagerLite

Parameters:

entity - The entity instance

Throws:

IllegalArgumentException - if not an entity or entity is not managed

IllegalStateException - if this EntityManager has been closed.

remove

public void remove(Object entity)

Remove the entity instance.

Specified by:

remove in interface EntityManagerLite

Parameters:

entity - The entity instance

Throws:

IllegalArgumentException - if not an entity or if a detached entity

IllegalStateException - if this EntityManager has been closed.

find

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

Find by primary key. Does not require transaction.

Specified by:

find in interface EntityManagerLite

Type Parameters:

T - the object type of the entity

Parameters:

entityClass - The class of the entity

primaryKey - The primary key as Object

Returns:

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

Throws:

IllegalStateException - if this EntityManager has been closed.

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

getReference

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

Javax PersistenceUnitAdmin: "Get an instance, whose state may be lazily fetched". This implementation is just an alias for find() If the requested instance does not exist in the database, throws EntityNotFoundException when the instance state is first accessed. The application should not expect that the instance state will be available upon detachment, unless it was accessed by the application while the entity manager was open.

Specified by:

getReference in interface EntityManagerLite

Type Parameters:

T - the object type of the entity

Parameters:

entityClass - The class of the entity

primaryKey - The primary key as Object

Returns:

the found entity instance

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

javax.persistence.EntityNotFoundException - if the entity state cannot be accessed

IllegalStateException - if this EntityManager has been closed.

flush

public void flush()

Synchronize the persistence context to the underlying database.

Specified by:

flush in interface EntityManagerLite

Throws:

javax.persistence.PersistenceException - if the flush fails

IllegalStateException - if this EntityManager has been closed.

setFlushMode

public void setFlushMode(javax.persistence.FlushModeType flushMode)

Set the flush mode that applies to all objects contained in the persistence context.

Specified by:

setFlushMode in interface EntityManagerLite

Parameters:

flushMode - The flush mode

Throws:

IllegalStateException - if this EntityManager has been closed.

getFlushMode

public javax.persistence.FlushModeType getFlushMode()

Get the flush mode that applies to all objects contained in the persistence context.

Specified by:

getFlushMode in interface EntityManagerLite

Returns:

flush mode - always FlushModeType.COMMIT

Throws:

IllegalStateException - if this EntityManager has been closed.

lock

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

NOT SUPPORTED. Set the lock mode for an entity object contained in the persistence context.

Specified by:

lock in interface EntityManagerLite

Parameters:

entity -

lockMode -

Throws:

UnsupportedOperationException

clear

public void clear()

Clear the persistence context, causing all managed entities to become detached. Changes made to entities that have not been flushed to the database will not be persisted.

Specified by:

clear in interface EntityManagerLite

Throws:

IllegalStateException - if this EntityManager has been closed.

contains

public boolean contains(Object entity)

Check if the instance belongs to the current persistence context.

Specified by:

contains in interface EntityManagerLite

Parameters:

entity - The entity instance

Returns:

true if the instance belongs to the current persistence context.

Throws:

IllegalArgumentException - if not an entity

IllegalStateException - if this EntityManager has been closed.

createNamedQuery

public javax.persistence.Query createNamedQuery(String name)

Create an instance of Query for executing a named query (executed using OrmLite QueryBuilder or in native SQL).

Specified by:

createNamedQuery in interface EntityManagerLite

Parameters:

name - The name of a query

Returns:

the new query instance

Throws:

IllegalArgumentException - if a query has not been defined with the given name

IllegalStateException - if this EntityManager has been closed.

joinTransaction

public void joinTransaction()

NOT SUPPORTED Indicate to the EntityManager that a JTA transaction is active. This method should be called on a JTA application managed EntityManager that was created outside the scope of the active transaction to associate it with the current JTA transaction.

Specified by:

joinTransaction in interface EntityManagerLite

Throws:

UnsupportedOperationException

getDelegate

public Object getDelegate()

Returns EntityManagerDelegate object which provides access to OrmLite DAOs. Return type of Object complies with PersistenceUnitAdmin API. Use cast to access the returned object as EntityManagerDelegate type.

Specified by:

getDelegate in interface EntityManagerLite

Returns:

Object

Throws:

IllegalStateException - if this EntityManager has been closed.

close

public void close()

DO NOT CALL close() as the container will do this automatically. Close an application-managed EntityManager. After the close method has been invoked, all methods on the EntityManager instance and any Query objects obtained from it will throw the IllegalStateException except for getTransaction and isOpen (which will return false). If this method is called when the EntityManager is associated with an active transaction, the persistence context remains managed until the transaction completes.

Specified by:

close in interface EntityManagerLite

Throws:

IllegalStateException - if the EntityManager is container-managed or has been already closed.

isOpen

public boolean isOpen()

Determine whether the entity manager is open.

Specified by:

isOpen in interface EntityManagerLite

Returns:

true until the entity manager has been closed

getTransaction

public javax.persistence.EntityTransaction getTransaction()

Returns the resource-level transaction object, if User Transactions selected, otherwise proxy object returned for which only setRollbackOnly() is active. In User Transaction mode, the EntityTransaction instance may be used serially to begin and commit multiple transactions.

Specified by:

getTransaction in interface EntityManagerLite

Returns:

EntityTransaction instance if in User Transaction mode, otherwise null