au.com.cybersearch2.classyjpa.entity

Class ObjectMonitor

java.lang.Object

au.com.cybersearch2.classyjpa.entity.ObjectMonitor

public class ObjectMonitor
extends Object

ObjectMonitor Delegated by ClassyEntityManager to manage entity objects. Note: This class is not thread safe. It assumes that the owning EntityManager runs in a single thread

Author:

Andrew Bowley 06/05/2014

Constructor Summary

Constructors

Constructor and Description
ObjectMonitor() Create ObjectMonitor object

Method Summary

Methods

Modifier and Type	Method and Description
List<Object>	getObjectsToUpdate() Returns a list of objects which need to be updated
void	markForRemoval(Class<? extends Object> clazz, Object primaryKey) Mark a managed object, identified by class and primaryKey, for removal
boolean	monitorNewEntity(Object entity, Object preCreateKey, Object postCreateKey) Update monitor state after database operation to persist a new entity
void	release() Remove references to all managed objects
<T> T	startManagingEntity(Object entity, Object primaryKey, PersistOp persistOp) Start Managing entity

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectMonitor

public ObjectMonitor()

Create ObjectMonitor object

Method Detail

startManagingEntity

public <T> T startManagingEntity(Object entity,
                        Object primaryKey,
                        PersistOp persistOp)

Start Managing entity

Parameters:

entity - Object to be managed

primaryKey - Entity primary key

persistOp - persist, merge, refresh or contains

Returns:

null if first time this method is called for this entity, otherwise, the existing managed object

Throws:

IllegalArgumentException - if any parameter is invalid

See Also:

monitorNewEntity(java.lang.Object, java.lang.Object, java.lang.Object)

monitorNewEntity

public boolean monitorNewEntity(Object entity,
                       Object preCreateKey,
                       Object postCreateKey)

Update monitor state after database operation to persist a new entity

Parameters:

entity - Object being managed

preCreateKey - Specified primary key or null

postCreateKey - Primary key returned by DAO after persisting entity

Returns:

true if preCreateKey and postCreateKey match or preCreateKey is null and postCreateKey does not match existing managed entity

markForRemoval

public void markForRemoval(Class<? extends Object> clazz,
                  Object primaryKey)

Mark a managed object, identified by class and primaryKey, for removal

Parameters:

clazz - Class of entity

primaryKey - Primary key of entity to remove

Throws:

IllegalArgumentException - if no managed object is matched to specified primary key

release

public void release()

Remove references to all managed objects

getObjectsToUpdate

public List<Object> getObjectsToUpdate()

Returns a list of objects which need to be updated

Returns:

List<Object>