metricapp.utility.stateTransitionUtils

Class AbstractStateTransitionFactory

java.lang.Object

metricapp.utility.stateTransitionUtils.AbstractStateTransitionFactory

Direct Known Subclasses:

MeasurementGoalStateTransitionFactory, MetricStateTransitionFactory, QuestionStateTransitionFactory

public abstract class AbstractStateTransitionFactory
extends java.lang.Object

This class is part of Abstract Factory Pattern Implementation. Every factory of this packages MUST be used like AbstractStateTransitionFactory type. the static method getFactory create a new instance of factory according to entity passed like parameter. transition method is the method that implementing Reflection, searches by name the class of the transtion required for two elements passed like parameters.

Field Summary

Fields

Modifier and Type	Field and Description
protected Entity	entity

Constructor Summary

Constructors

Constructor and Description
AbstractStateTransitionFactory(Entity entity) This constructor is needed by child classes, this class is abstract, cannot be instanced.

Method Summary

Methods

Modifier and Type	Method and Description
static AbstractStateTransitionFactory	getFactory(Entity entity) This function is static and final, is the function that returns the user desired factory.
StateTransitionCommand	transition(Element before, Element after) This method implements Reflection to retrieve single transition command.

Methods inherited from class java.lang.Object

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

Field Detail

entity

protected Entity entity

Constructor Detail

AbstractStateTransitionFactory

public AbstractStateTransitionFactory(Entity entity)

This constructor is needed by child classes, this class is abstract, cannot be instanced.

Parameters:

entity, - from Enumeration Entity, identifies the type of factory the user needs.

Method Detail

getFactory

public static final AbstractStateTransitionFactory getFactory(Entity entity)
                                                       throws NotFoundException

This function is static and final, is the function that returns the user desired factory. Not all the entities have their own StateTransitionFactory, due to some entities are external to our system and we cannot manage their status. Supported entities are: Metric, MeasurementGoal, Question

Parameters:

entity - from Enumeration Entity, identifies the type of factory the user needs.

Returns:

the factory required by the user

Throws:

NotFoundException - in case of bad input, entity is not supported

transition

public StateTransitionCommand transition(Element before,
                                Element after)
                                  throws IllegalStateTransitionException

This method implements Reflection to retrieve single transition command. User just needs to define the class of transition, calling it StateBeforeToStateAfter and put it on the right package. This function could be implement the call of a class with a predetermined map of classes, improving performances but making less flexible the structure. In that way a user needs to change the map after the introduction or the delete of a state transition class. In this way, user is not required in class grabbing process. User Must use the command at least one time

Parameters:

before - You can pass MeasurementGoal, Question, Metric. state cannot be null

after - same as before

Returns:

it returns an object command that the user can asynchronously execute, it is fully configurated.

Throws:

IllegalStateTransitionException