com.edorasware.cmmn.model.rulesandsentries

Class Sentry

java.lang.Object

com.edorasware.cmmn.model.rulesandsentries.Sentry

public class Sentry
extends Object

This class wraps a TSentry. It contains code to evaluate the sentry’s "onPart".

Constructor Summary

Constructors

Constructor and Description
Sentry(TSentry tSentry, PlannableItem owner, boolean exitSentry) Construct a Sentry.

Method Summary

Modifier and Type	Method and Description
static ArrayList<Sentry>	createSentries(List<TSentry> xmlSentries, PlannableItem owningStage, boolean exitSentry) A helper method to create a list of sentries given a list of TSentry objects.
boolean	evaluateIfPartBestEffort(PlanItem sentryOwner, TransitionData transitionData, EvaluationListeners evaluationListeners)
TriggerResult	evaluateOnParts(EventSources eventSources, PlanItem sentryOwner)
List<OnPart>	getOnParts()
PlannableItem	getOwner()
TriggerMode	getTriggerMode()
TSentry	getTSentry()
boolean	isExitSentry()
TriggerResult	isTriggered(EventSources eventSources, PlanItem sentryOwner, TransitionData transitionData, EvaluationListeners evaluationListeners) Evaluate the "onParts" of this sentry.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Sentry

public Sentry(TSentry tSentry,
              PlannableItem owner,
              boolean exitSentry)

Construct a Sentry. Assign parameters to members. For convenience, set up a list of OnPart's based on the on-parts provided by the tSentry parameter.

Parameters:

tSentry - the sentry

owner - the owner

Method Detail

isTriggered

public TriggerResult isTriggered(EventSources eventSources,
                                 PlanItem sentryOwner,
                                 TransitionData transitionData,
                                 EvaluationListeners evaluationListeners)

Evaluate the "onParts" of this sentry. In order for the sentry to trigger, all onParts must trigger. See TriggerResult.

Parameters:

eventSources - the event sources

sentryOwner - the sentry owner

evaluationListeners - the evaluation listeners

Returns:

the trigger result

evaluateIfPartBestEffort

public boolean evaluateIfPartBestEffort(PlanItem sentryOwner,
                                        TransitionData transitionData,
                                        EvaluationListeners evaluationListeners)

Returns:

true if the sentry’s if-part is considered triggered (either empty or evaluating to true). The method never throws an exception. Any exception occurring during the evaluation of the condition results in a false return value.

evaluateOnParts

public TriggerResult evaluateOnParts(EventSources eventSources,
                                     PlanItem sentryOwner)

getTSentry

public TSentry getTSentry()

getOwner

public PlannableItem getOwner()

Returns:

the owner

isExitSentry

public boolean isExitSentry()

getOnParts

public List<OnPart> getOnParts()

getTriggerMode

public TriggerMode getTriggerMode()

createSentries

public static ArrayList<Sentry> createSentries(List<TSentry> xmlSentries,
                                               PlannableItem owningStage,
                                               boolean exitSentry)

A helper method to create a list of sentries given a list of TSentry objects.

Parameters:

xmlSentries - the sentries

owningStage - the owning stage

Returns:

An ArrayList of Sentries.

toString

public String toString()

Overrides:

toString in class Object