com.edorasware.cmmn.model

Class StateModel

java.lang.Object

com.edorasware.cmmn.model.StateModel

public class StateModel
extends Object

<p>Represents the internal case engine model.</p> <p>It is built using the static case model (from the CMMN XML) as a template.

Constructor Summary

Constructors

Constructor and Description
StateModel(String clientId, Map<String,String> clientProperties, PersistenceListeners persistenceListeners) Constructor used to restore an existing state model.
StateModel(String clientId, PersistenceListeners persistenceListeners) Convenience constructor used in unit tests.
StateModel(String clientId, String parentCaseId, Map<String,String> clientProperties, TransitionData transitionData, PersistenceListeners persistenceListeners) Create a new state model for a new case, consisting of a casePlanModel and its caseFile.

Method Summary

Modifier and Type	Method and Description
void	applyVisitor(CaseFileItemInstanceVisitor visitor)
void	applyVisitor(PlanItemVisitor visitor, TransitionData transitionData) Apply a PlanItemVisitor to the state model (@link this#casePlanModel}).
void	applyVisitor(PlannableItemVisitor visitor, TransitionData transitionData) Apply a PlannableItemVisitor to the state model (@link this#casePlanModel}).
static StreamSource	createStreamSourceFromXml(String cmmnXml) Helper to create a JAX stream source for XML unmarshalling.
static Unmarshaller	createUnmarshaller() Helper to crate a JAX XML unmarshaller
PlanItem	findPlanItem(String planItemId) See JavaDoc of Stage.findPlanItem(String)
List<AvailableAction>	getAvailableActions(TransitionData transitionData, EngineListeners engineListeners) Get a sorted list of the currently available actions of this state model.
CaseFile	getCaseFile()
CaseFileItem	getCaseFileItemById(String caseFileItemId)
HashMap<String,CaseFileItemInstance>	getCaseFileItemInstances()
List<CaseFileItem>	getCaseFileItems(String definitionType)
CasePlanModel	getCasePlanModel()
Map<String,String>	getClientProperties()
List<CurrentState>	getCurrentStates(TransitionData transitionData, EngineListeners engineListeners) Get a sorted list of the current states (milestones and stages) of this state model.
HashMap<String,PlanItem>	getLatestPlanItemInstances()
HashMap<String,PlanItem>	getPlanItemInstances()
List<PlanItem>	getPlanItemInstances(Class<? extends PlanItem> planItemType, boolean singleInstanceMode, TransitionData transitionData)
List<Map<String,Object>>	getPlanItemProperties(Class<? extends PlanItem> planItemType, boolean singleInstanceMode, String[] properties, TransitionData transitionData, EvaluationListeners evaluationListeners) Create a list of maps containing information about the plan items selected by this method.
Map<String,Object>	getPlanItemProperties(String planItemId, String[] properties, TransitionData transitionData, EvaluationListeners evaluationListeners) Create a map containing information about the plan item selected by this method.
PlannableItemPool	getPlannableItemPool()
TransitionDataCache	getTransitionDataCache(PersistenceListeners persistenceListeners)
void	handleCaseFileItemTransition(String sourceCaseFileItemId, CaseFileItemTransition caseFileItemTransition, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners)
void	handleCaseMigration(String oldCmmnXml, String newCmmnXml, Map<String,String> clientProperties, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners) Migrate this state model in place from an old CMMN model (XML) to a new model.
void	handleDiscretionaryItemPlanning(String sourcePlanItemId, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners)
void	handlePlanItemTransition(String sourcePlanItemId, PlanItemTransition planItemTransition, EngineListeners engineListeners, PersistenceListeners persistenceListeners) Strictly used for unit testing only.
void	handlePlanItemTransition(String sourcePlanItemId, PlanItemTransition planItemTransition, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners) Trigger a state transition in the state model.
void	handleStateUpdate(TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners) Re-evaluate the model upon an external state update.
void	log(String suffix)
void	registerNewInstance(PlanItem planItem) Register a particular plan item instance as created.
void	restore(PersistenceListeners persistenceListeners) Restore a state model from storage.
void	startCase(TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners) Start the case.
void	storeState(PersistenceListeners persistenceListeners) Store the current state of the model if dirty.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StateModel

public StateModel(String clientId,
                  String parentCaseId,
                  Map<String,String> clientProperties,
                  TransitionData transitionData,
                  PersistenceListeners persistenceListeners)
           throws JAXBException,
                  IOException

Create a new state model for a new case, consisting of a casePlanModel and its caseFile.

Parameters:

clientId - client id.

parentCaseId - parent case id. Only set for cases created as case tasks

clientProperties - client properties.

transitionData - transition data.

persistenceListeners - persistence listeners.

Throws:

JAXBException - if the case XML received via the persistenceListeners could not be un-marshaled.

IOException - if the case XML received via the persistenceListeners could not be un-marshaled.

StateModel

public StateModel(String clientId,
                  Map<String,String> clientProperties,
                  PersistenceListeners persistenceListeners)
           throws JAXBException,
                  IOException

Constructor used to restore an existing state model.

Parameters:

clientId - client id.

persistenceListeners - persistence listeners.

Throws:

JAXBException - if the case XML received via the persistenceListeners could not be un-marshaled.

IOException - if the case XML received via the persistenceListeners could not be un-marshaled.

StateModel

public StateModel(String clientId,
                  PersistenceListeners persistenceListeners)
           throws JAXBException,
                  IOException

Convenience constructor used in unit tests.

Parameters:

clientId - client id.

persistenceListeners - persistence listeners.

Throws:

JAXBException - if the case XML received via the persistenceListeners could not be un-marshaled.

IOException - if the case XML received via the persistenceListeners could not be un-marshaled.

Method Detail

startCase

public void startCase(TransitionData transitionData,
                      EngineListeners engineListeners,
                      PersistenceListeners persistenceListeners)

Start the case.

Parameters:

transitionData - transition data

engineListeners - engine listeners

restore

public void restore(PersistenceListeners persistenceListeners)
             throws IOException

Restore a state model from storage.

Parameters:

persistenceListeners - the object providing the PersistenceListeners.storeCaseState(String, Map, String) method which serves the JSON string containing the state data.

Throws:

IOException - if the state model could not be restored via the passed persistenceListeners.

getTransitionDataCache

public TransitionDataCache getTransitionDataCache(PersistenceListeners persistenceListeners)

registerNewInstance

public void registerNewInstance(PlanItem planItem)

Register a particular plan item instance as created.

handlePlanItemTransition

public void handlePlanItemTransition(String sourcePlanItemId,
                                     PlanItemTransition planItemTransition,
                                     TransitionData transitionData,
                                     EngineListeners engineListeners,
                                     PersistenceListeners persistenceListeners)

Trigger a state transition in the state model.

Parameters:

sourcePlanItemId - identifies the plan item upon which to apply the transition.

planItemTransition - the transition to be applied.

transitionData - transition data.

engineListeners - a callback object allowing the state engine to trigger actions in the calling client based on results (if any) from the executed transition.

persistenceListeners - the interface providing the hook to store the state JSON string in the client system.

handlePlanItemTransition

public void handlePlanItemTransition(String sourcePlanItemId,
                                     PlanItemTransition planItemTransition,
                                     EngineListeners engineListeners,
                                     PersistenceListeners persistenceListeners)

Strictly used for unit testing only.

handleCaseFileItemTransition

public void handleCaseFileItemTransition(String sourceCaseFileItemId,
                                         CaseFileItemTransition caseFileItemTransition,
                                         TransitionData transitionData,
                                         EngineListeners engineListeners,
                                         PersistenceListeners persistenceListeners)

handleDiscretionaryItemPlanning

public void handleDiscretionaryItemPlanning(String sourcePlanItemId,
                                            TransitionData transitionData,
                                            EngineListeners engineListeners,
                                            PersistenceListeners persistenceListeners)

handleStateUpdate

public void handleStateUpdate(TransitionData transitionData,
                              EngineListeners engineListeners,
                              PersistenceListeners persistenceListeners)

Re-evaluate the model upon an external state update.

Parameters:

transitionData - transition data.

engineListeners - a callback object allowing the state engine to trigger actions in the calling client based on results (if any) from the executed transition.

handleCaseMigration

public void handleCaseMigration(String oldCmmnXml,
                                String newCmmnXml,
                                Map<String,String> clientProperties,
                                TransitionData transitionData,
                                EngineListeners engineListeners,
                                PersistenceListeners persistenceListeners)

Migrate this state model in place from an old CMMN model (XML) to a new model. There are two main steps in such a migration:

<ol> <li>The old state information is re-mapped to the new model. This is done by re-mapping model IDs as necessary (they may have changed in the new model) and making the structure of the old state information compatible to the structure of the new state information. The result is a pre-liminary version of the state that’s compatible with the new model but needs more work</li> <li>In this second step, the case represented by this state model is then effectively re-started, using the new model to dictate the structure and the run-time state prepared in the above step to initialize plan item state from the old case. Some key code of this second step is executed in Stage.createChild(PlannableItem, TransitionData, EventSources, EngineListeners, PersistenceListeners) </li> </ol>

getCurrentStates

public List<CurrentState> getCurrentStates(TransitionData transitionData,
                                           EngineListeners engineListeners)

Get a sorted list of the current states (milestones and stages) of this state model.

Parameters:

transitionData - optional evaluation context.

engineListeners - client code implementation callbacks.

Returns:

the list of current states of this state model (at the time of the call).

getAvailableActions

public List<AvailableAction> getAvailableActions(TransitionData transitionData,
                                                 EngineListeners engineListeners)

Get a sorted list of the currently available actions of this state model.

Parameters:

transitionData - optional evaluation context.

engineListeners - client code implementation callbacks.

Returns:

the list of available actions of this state model (at the time of the call).

getPlanItemInstances

public List<PlanItem> getPlanItemInstances(Class<? extends PlanItem> planItemType,
                                           boolean singleInstanceMode,
                                           TransitionData transitionData)

getPlanItemProperties

public Map<String,Object> getPlanItemProperties(String planItemId,
                                                String[] properties,
                                                TransitionData transitionData,
                                                EvaluationListeners evaluationListeners)

Create a map containing information about the plan item selected by this method.

Parameters:

planItemId - the plan item Id.

properties - the properties to get from the selected plan item.

transitionData - the transition data.

evaluationListeners - provides the call-back method used to extract a property from a plan item by name.

Returns:

a map containing the data for the selected plan item instance. For each string in the properties parameter, the map will contain a key/value entry, the key being the property name as passed in, the value being the object resulting from reading the property on the plan item. Returns null if there is no plan item for the passed planItemId.

getPlanItemProperties

public List<Map<String,Object>> getPlanItemProperties(Class<? extends PlanItem> planItemType,
                                                      boolean singleInstanceMode,
                                                      String[] properties,
                                                      TransitionData transitionData,
                                                      EvaluationListeners evaluationListeners)

Create a list of maps containing information about the plan items selected by this method.

Parameters:

planItemType - used to select/filter the plan items by type.

singleInstanceMode - determines whether to only return the highest instance of a given plan item model element or all instances.

properties - the properties to get from each selected plan item.

transitionData - the transition data.

evaluationListeners - provides the call-back method used to extract a property from a plan item by name.

Returns:

a list of maps. Each map represents the data for one plan item instance. For each string in the properties parameter, the map will contain a key/value entry, the key being the property name as passed in, the value being the object resulting from reading the property on the plan item.

getCaseFileItems

public List<CaseFileItem> getCaseFileItems(String definitionType)

log

public void log(String suffix)

storeState

public void storeState(PersistenceListeners persistenceListeners)
                throws IOException

Store the current state of the model if dirty.

Parameters:

persistenceListeners - the interface providing the hooks to store the state JSON string to persistent storage.

Throws:

IOException - if the store operation fails.

findPlanItem

public PlanItem findPlanItem(String planItemId)

See JavaDoc of Stage.findPlanItem(String)

Parameters:

planItemId - plan item id

Returns:

PlanItem

getCaseFileItemById

public CaseFileItem getCaseFileItemById(String caseFileItemId)

getPlanItemInstances

public HashMap<String,PlanItem> getPlanItemInstances()

Returns:

plan item instances by instance Id.

getLatestPlanItemInstances

public HashMap<String,PlanItem> getLatestPlanItemInstances()

Returns:

the map of currently existing plan item instances (keyed by id). 0 or 1 per model element. If 1, it will be the most recent one (the one with the highest instanceIntId property).

getCaseFileItemInstances

public HashMap<String,CaseFileItemInstance> getCaseFileItemInstances()

Returns:

case file item instances by instance Id.

getCasePlanModel

public CasePlanModel getCasePlanModel()

Returns:

CasePlanModel

getClientProperties

public Map<String,String> getClientProperties()

getCaseFile

public CaseFile getCaseFile()

applyVisitor

public void applyVisitor(PlanItemVisitor visitor,
                         TransitionData transitionData)

Apply a PlanItemVisitor to the state model (@link this#casePlanModel}).

Parameters:

visitor - the visitor to be applied. E.g. a logging visitor or a visitor to extract the state model’s state.

transitionData - optional evaluation context.

applyVisitor

public void applyVisitor(PlannableItemVisitor visitor,
                         TransitionData transitionData)

Apply a PlannableItemVisitor to the state model (@link this#casePlanModel}).

Parameters:

visitor - the visitor to be applied. E.g. a visitor for discretionary item planning.

transitionData - optional evaluation context.

applyVisitor

public void applyVisitor(CaseFileItemInstanceVisitor visitor)

getPlannableItemPool

public PlannableItemPool getPlannableItemPool()

createUnmarshaller

public static Unmarshaller createUnmarshaller()

Helper to crate a JAX XML unmarshaller

Returns:

Unmarshaller

Throws:

RuntimeException - if the unmarshaller could not be created.

createStreamSourceFromXml

public static StreamSource createStreamSourceFromXml(String cmmnXml)

Helper to create a JAX stream source for XML unmarshalling.

Parameters:

cmmnXml - CMMN XML.

Returns:

StreamSource

toString

public String toString()

Overrides:

toString in class Object