com.edorasware.cmmn.model.visitor

Class CurrentStateCollector

java.lang.Object

com.edorasware.cmmn.model.visitor.CurrentStateCollector

All Implemented Interfaces:

PlanItemVisitor

public class CurrentStateCollector
extends Object
implements PlanItemVisitor

<p>A Visitor implementation used to extract the current display states from the state model.</p>

<p>Handling of states within completed stages: Completed sub-stages and occurred milestones are shown. Sub-stages and milestones in any other state will not be collected.</p>

<p>Handling of states within terminated stages: no sub-items (stages or milestones) will be collected.</p>

Constructor Summary

Constructors

Constructor and Description
CurrentStateCollector(EngineListeners engineListeners)

Method Summary

Modifier and Type	Method and Description
void	cleanup(PlanItem planItem, TransitionData transitionData) Called once after all structure objects have been visited.
boolean	enter(PlanItem planItem, TransitionData transitionData) Called for each plan item just before the plan item is visited.
void	exit(PlanItem planItem, TransitionData transitionData) Called for each plan item just after the plan item has been visited.
ArrayList<CurrentState>	getStates()
void	init(PlanItem planItem, TransitionData transitionData) Called once before any other calls in this interface.

Methods inherited from class java.lang.Object

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

Constructor Detail

CurrentStateCollector

public CurrentStateCollector(EngineListeners engineListeners)

Method Detail

init

public void init(PlanItem planItem,
                 TransitionData transitionData)

Description copied from interface: PlanItemVisitor

Called once before any other calls in this interface.

Specified by:

init in interface PlanItemVisitor

Parameters:

planItem - the case plan model (the root).

enter

public boolean enter(PlanItem planItem,
                     TransitionData transitionData)

Description copied from interface: PlanItemVisitor

Called for each plan item just before the plan item is visited.

Specified by:

enter in interface PlanItemVisitor

Parameters:

planItem - the plan item of interest.

transitionData - optional evaluation context.

Returns:

true to recurse into a stage’s children.

exit

public void exit(PlanItem planItem,
                 TransitionData transitionData)

Description copied from interface: PlanItemVisitor

Called for each plan item just after the plan item has been visited.

Specified by:

exit in interface PlanItemVisitor

Parameters:

planItem - the plan item of interest.

cleanup

public void cleanup(PlanItem planItem,
                    TransitionData transitionData)

Description copied from interface: PlanItemVisitor

Called once after all structure objects have been visited.

Specified by:

cleanup in interface PlanItemVisitor

Parameters:

planItem - the case plan item (the root).

getStates

public ArrayList<CurrentState> getStates()