org.statefulj.persistence.common

Class AbstractPersister<T,ID>

java.lang.Object

org.statefulj.persistence.common.AbstractPersister<T,ID>

All Implemented Interfaces:

Persister<T>

Direct Known Subclasses:

JPAPerister, MongoPersister

public abstract class AbstractPersister<T,ID>
extends Object
implements Persister<T>

Constructor Summary

Constructors

Constructor and Description
AbstractPersister(List<State<T>> states, String stateFieldName, State<T> startState, Class<T> clazz)

Method Summary

Modifier and Type	Method and Description
protected FieldAccessor<T,ID>	buildIdFieldAccessor(Field idField, Class<T> clazz)
protected StateFieldAccessor<T>	buildStateFieldAccessor(Field stateField, Class<T> clazz)
protected abstract Field	findIdField(Class<?> clazz)
protected Field	findStateField(String stateFieldName, Class<?> clazz)
protected Class<T>	getClazz()
State<T>	getCurrent(T stateful) Returns the current state.
protected Object	getId(T obj)
Field	getIdField()
protected FieldAccessor<T,ID>	getIdFieldAccessor()
protected State<T>	getStartState()
protected Serializable	getState(T obj)
Field	getStateField()
protected StateFieldAccessor<T>	getStateFieldAccessor()
protected abstract Class<?>	getStateFieldType()
abstract void	setCurrent(T stateful, State<T> current, State<T> next) Set the current State.
void	setStartState(State<T> startState) Set the Start State
protected void	setState(T obj, String state)
void	setStates(Collection<State<T>> states) Set the Collection of States to be managed by the Persister
protected void	throwStaleState(State<T> current, State<T> next)
protected abstract boolean	validStateField(Field stateField)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPersister

public AbstractPersister(List<State<T>> states,
                         String stateFieldName,
                         State<T> startState,
                         Class<T> clazz)

Method Detail

getCurrent

public State<T> getCurrent(T stateful)

Description copied from interface: Persister

Returns the current state. This will not call into the underlying database

Specified by:

getCurrent in interface Persister<T>

Parameters:

stateful - Stateful Entity

Returns:

current State of the Stateful Entity

setCurrent

public abstract void setCurrent(T stateful,
                                State<T> current,
                                State<T> next)
                         throws StaleStateException

Set the current State. This method will ensure that the state in the db matches the expected current state. If not, it will throw a StateStateException

Specified by:

setCurrent in interface Persister<T>

Parameters:

stateful - Stateful Entity

current - Expected current State

next - The value of the next State

Throws:

StaleStateException - thrown if the value of the State does not equal to the provided current State

setStates

public void setStates(Collection<State<T>> states)

Description copied from interface: Persister

Set the Collection of States to be managed by the Persister

Specified by:

setStates in interface Persister<T>

Parameters:

states - Collection of States

setStartState

public void setStartState(State<T> startState)

Description copied from interface: Persister

Set the Start State

Specified by:

setStartState in interface Persister<T>

Parameters:

startState - Start State

getIdField

public Field getIdField()

getStateField

public Field getStateField()

validStateField

protected abstract boolean validStateField(Field stateField)

findIdField

protected abstract Field findIdField(Class<?> clazz)

findStateField

protected Field findStateField(String stateFieldName,
                               Class<?> clazz)

buildIdFieldAccessor

protected FieldAccessor<T,ID> buildIdFieldAccessor(Field idField,
                                                   Class<T> clazz)

buildStateFieldAccessor

protected StateFieldAccessor<T> buildStateFieldAccessor(Field stateField,
                                                        Class<T> clazz)

getStateFieldType

protected abstract Class<?> getStateFieldType()

getStartState

protected State<T> getStartState()

getClazz

protected Class<T> getClazz()

getId

protected Object getId(T obj)
                throws NoSuchFieldException,
                       SecurityException,
                       IllegalArgumentException,
                       IllegalAccessException

Throws:

NoSuchFieldException

SecurityException

IllegalArgumentException

IllegalAccessException

getState

protected Serializable getState(T obj)
                         throws NoSuchFieldException,
                                SecurityException,
                                IllegalArgumentException,
                                IllegalAccessException

Throws:

NoSuchFieldException

SecurityException

IllegalArgumentException

IllegalAccessException

setState

protected void setState(T obj,
                        String state)
                 throws IllegalArgumentException,
                        IllegalAccessException,
                        NoSuchFieldException,
                        SecurityException

Throws:

IllegalArgumentException

IllegalAccessException

NoSuchFieldException

SecurityException

throwStaleState

protected void throwStaleState(State<T> current,
                               State<T> next)
                        throws StaleStateException

Throws:

StaleStateException

getStateFieldAccessor

protected StateFieldAccessor<T> getStateFieldAccessor()

getIdFieldAccessor

protected FieldAccessor<T,ID> getIdFieldAccessor()