com.breeze.save

Class SaveWorkState

java.lang.Object

com.breeze.save.SaveWorkState

public class SaveWorkState
extends java.lang.Object

This is the primary class for providing save interception logic; it it also the repository of all of the information regarding the entities and their statuses associated with a save operation. Typically this class will be subclassed so that the subclass can defined overriden versions of the before and after save interception methods. This class also provides a number of utility methods to allow entities to be found, added or removed from the current save pipeline.

Author:

IdeaBlade

Constructor Summary

Constructors

Constructor and Description
SaveWorkState(java.util.Map saveBundle) Constructs an instance of this class with the deserialized result of an Http save request.

Method Summary

Methods

Modifier and Type	Method and Description
EntityInfo	addEntity(java.lang.Object entity, EntityState entityState) Schedule an additional entity to be saved.
protected void	afterSave()
void	afterSaveEntities() Allow subclasses to process the saveMap after entities are saved (and temporary keys replaced)
void	beforeCommit(java.lang.Object context) Allow subclasses to process the entities just before they are ready to be committed
protected void	beforeSave() Build the saveMap, and call context.beforeSaveEntity/ies
void	beforeSaveEntities() Allow subclasses to process the entities after they have been hooked up to one another but before they have been added to the session.
protected boolean	beforeSaveEntity(EntityInfo entityInfo) Allow subclasses to process each entity before it gets included in the saveMap.
java.util.Set<java.util.Map.Entry<java.lang.Class,java.util.List<EntityInfo>>>	entrySet()
EntityInfo	findEntityInfo(java.lang.Object entity) Return the EntityInfo associated with a specific entity.
EntityInfo	findEntityInfoById(java.lang.Class clazz, java.lang.Object id)
java.util.List<java.lang.Object>	getEntities()
java.util.List<java.lang.Object>	getEntities(java.lang.Class clazz)
java.util.List<EntityInfo>	getEntityInfos(java.lang.Class clazz)
java.lang.Object	getIdentifier(java.lang.Object entity)
Metadata	getMetadata()
SaveOptions	getSaveOptions()
boolean	handleException(java.lang.Exception e) Allows subclasses to plug in their own exception handling.
boolean	removeEntity(java.lang.Object entity) Remove an entity from being scheduled to be saved.
void	setEntityErrors(EntityErrorsException exception)
protected void	setSaveProcessor(SaveProcessor saveProcessor)
SaveResult	toSaveResult() Populate a new SaveResult with the entities and keyMappings.

Methods inherited from class java.lang.Object

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

Constructor Detail

SaveWorkState

public SaveWorkState(java.util.Map saveBundle)

Constructs an instance of this class with the deserialized result of an Http save request.

Parameters:

saveBundle -

Method Detail

getSaveOptions

public SaveOptions getSaveOptions()

Returns:

The SaveOptions associated with this save operation.

setSaveProcessor

protected void setSaveProcessor(SaveProcessor saveProcessor)

getIdentifier

public java.lang.Object getIdentifier(java.lang.Object entity)

Parameters:

entity -

Returns:

The id of the specified entity.

getMetadata

public Metadata getMetadata()

Returns:

The complete Metadata model associated with this save.

setEntityErrors

public void setEntityErrors(EntityErrorsException exception)

beforeSave

protected void beforeSave()

Build the saveMap, and call context.beforeSaveEntity/ies

afterSave

protected void afterSave()

beforeSaveEntity

protected boolean beforeSaveEntity(EntityInfo entityInfo)

Allow subclasses to process each entity before it gets included in the saveMap. Called when each EntityInfo is materialized (before beforeSaveEntities is called). Base implementation always returns true.

Parameters:

entityInfo -

Returns:

true if the entity should be included in the saveMap, false if not.

beforeSaveEntities

public void beforeSaveEntities()

Allow subclasses to process the entities after they have been hooked up to one another but before they have been added to the session.

beforeCommit

public void beforeCommit(java.lang.Object context)

Allow subclasses to process the entities just before they are ready to be committed

afterSaveEntities

public void afterSaveEntities()

Allow subclasses to process the saveMap after entities are saved (and temporary keys replaced)

Parameters:

saveMap - all entities which have been saved

keyMappings - mapping of temporary keys to real keys

handleException

public boolean handleException(java.lang.Exception e)

Allows subclasses to plug in their own exception handling. This method is called when saveChangesCore throws an exception. Subclass implementations of this method should either: 1. Throw an exception 2. Return false (exception not handled) 3. Return true (exception handled) and modify the SaveWorkState accordingly. Base implementation returns false (exception not handled).

Parameters:

e - Exception that was thrown by saveChangesCore

Returns:

true (exception handled) or false (exception not handled)

getEntityInfos

public java.util.List<EntityInfo> getEntityInfos(java.lang.Class clazz)

Parameters:

clazz -

Returns:

A list of all of the EntityInfo instances associated with this class for this save operation.

getEntities

public java.util.List<java.lang.Object> getEntities(java.lang.Class clazz)

Parameters:

clazz -

Returns:

A list of all of the entities associated with this class for this save operation.

getEntities

public java.util.List<java.lang.Object> getEntities()

Returns:

A list of all of the entities to be saved for this save operation.

addEntity

public EntityInfo addEntity(java.lang.Object entity,
                   EntityState entityState)

Schedule an additional entity to be saved.

Parameters:

entity - The entity to be saved.

entityState - The EntityState of the newly added entity.

Returns:

The EntityInfo associated with the newly added entity.

removeEntity

public boolean removeEntity(java.lang.Object entity)

Remove an entity from being scheduled to be saved.

Parameters:

entity - The entity to be removed.

Returns:

Whether the entity was found.

findEntityInfo

public EntityInfo findEntityInfo(java.lang.Object entity)

Return the EntityInfo associated with a specific entity.

Parameters:

entity -

Returns:

findEntityInfoById

public EntityInfo findEntityInfoById(java.lang.Class clazz,
                            java.lang.Object id)

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.Class,java.util.List<EntityInfo>>> entrySet()

toSaveResult

public SaveResult toSaveResult()

Populate a new SaveResult with the entities and keyMappings. If there are entityErrors, populate it with those instead.