uk.ac.ed.epcc.webapp.model.data.transition

Class AbstractTransitionFactory<T,K extends TransitionKey<T>>

java.lang.Object

uk.ac.ed.epcc.webapp.AbstractContexed

uk.ac.ed.epcc.webapp.model.data.transition.AbstractTransitionFactory<T,K>

Type Parameters:

T -

K -

All Implemented Interfaces:

Contexed, ContextCached, TransitionFactory<K,T>

Direct Known Subclasses:

AbstractPathTransitionProvider, AbstractTransitionProvider, AbstractViewTransitionFactory

public abstract class AbstractTransitionFactory<T,K extends TransitionKey<T>>
extends AbstractContexed
implements ContextCached, TransitionFactory<K,T>

Abstract superclass for building TransitionFactorys. This implementation stores the keys and transitions in maps generated when the class is constructed so dynamic transitions are not supported.

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

conn

Constructor Summary

Constructors

Constructor and Description
AbstractTransitionFactory(AppContext c)

Method Summary

Modifier and Type	Method and Description
void	addTransition(K key, Transition<T> t) Register a new transition with the provider.
Transition<T>	getTransition(K name)
Transition<T>	getTransition(T target, K name) Find a transition operator for this type by key.
java.util.Set<K>	getTransitions(T target) Get a list of all the transition keys supported by the target type to be presented to the user as a set of possible options in a view transition.
K	lookupTransition(T target, java.lang.String name) Lookup a transition key by String This has to be the same as the result of the toString method on the key as this is what is passed from transitions.jsp for a form transition.
protected boolean	sortByKey()

Methods inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

getContext, getLogger, resetLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.transition.TransitionFactory

accept, allowTransition, getSummaryContent, getTargetName

Methods inherited from interface uk.ac.ed.epcc.webapp.Contexed

getContext

Constructor Detail

AbstractTransitionFactory

public AbstractTransitionFactory(AppContext c)

Method Detail

sortByKey

protected boolean sortByKey()

addTransition

public final void addTransition(K key,
                                Transition<T> t)

Register a new transition with the provider. This is intended to be called from the constructor of the sub-class so that all transitions are registered by the time the constructor returns.

Parameters:

key -

t -

lookupTransition

public final K lookupTransition(T target,
                                java.lang.String name)

Description copied from interface: TransitionFactory

Lookup a transition key by String This has to be the same as the result of the toString method on the key as this is what is passed from transitions.jsp for a form transition.

Specified by:

lookupTransition in interface TransitionFactory<K extends TransitionKey<T>,T>

Parameters:

target - (may be null)

Returns:

Transition key

getTransition

public final Transition<T> getTransition(T target,
                                         K name)

Description copied from interface: TransitionFactory

Find a transition operator for this type by key. This method is permitted to return null for example if the current user is not permitted to perform the transition.

Specified by:

getTransition in interface TransitionFactory<K extends TransitionKey<T>,T>

Parameters:

target - target (may be null)

name - key

Returns:

Transition or null

getTransition

public final Transition<T> getTransition(K name)

getTransitions

public final java.util.Set<K> getTransitions(T target)

Description copied from interface: TransitionFactory

Get a list of all the transition keys supported by the target type to be presented to the user as a set of possible options in a view transition. Options in this list that are not allowed by TransitionFactory.allowTransition(AppContext, Object, Object) will not be presented. Additional hidden operations may also be supported but these will never be presented to the user as options and can only generated as a ChainedTransitionResult. In most cases the transition set will be the same for all null/non-null targets though in principal dynamic transitions could be generated based on the state of the target e.g. a parameterised transition with the parameter encoded in the key.

Specified by:

getTransitions in interface TransitionFactory<K extends TransitionKey<T>,T>

Returns:

Set of keys