org.javarosa.core.model.condition

Class Triggerable

java.lang.Object

org.javarosa.core.model.condition.Triggerable

All Implemented Interfaces:

Externalizable

Direct Known Subclasses:

Condition, Recalculate

public abstract class Triggerable
extends Object
implements Externalizable

A triggerable represents an action that should be processed based on a value updating in a model. Trigerrables are comprised of two basic components: An expression to be evaluated, and a reference which represents where the resultant value will be stored.

A triggerable will dispatch the action it's performing out to all relevant nodes referenced by the context against thes current models.

Author:

ctsims

Field Summary

Fields

Modifier and Type	Field and Description
protected XPathConditional	expr The expression which will be evaluated to produce a result

Method Summary

Modifier and Type	Method and Description
void	addTarget(TreeReference target)
List<EvaluationResult>	apply(FormInstance mainInstance, EvaluationContext parentContext, TreeReference context) Dispatches all of the evaluation
protected abstract void	apply(TreeReference ref, Object result, FormInstance mainInstance)
abstract boolean	canCascade()
static Triggerable	condition(XPathConditional expr, ConditionAction trueAction, ConditionAction falseAction, TreeReference contextRef)
boolean	equals(Object o)
abstract Object	eval(FormInstance instance, EvaluationContext ec)
TreeReference	getContext()
IConditionExpr	getExpr()
Set<QuickTriggerable>	getImmediateCascades()
TreeReference	getOriginalContext()
Set<TreeReference>	getTargets()
Set<TreeReference>	getTriggers()
void	intersectContextWith(Triggerable other)
abstract boolean	isCascadingToChildren()
void	readExternal(DataInputStream in, PrototypeFactory pf)
static Triggerable	recalculate(XPathConditional expr, TreeReference contextRef)
void	setImmediateCascades(Set<QuickTriggerable> cascades)
void	writeExternal(DataOutputStream out)

Methods inherited from class java.lang.Object

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

Field Detail

expr

protected XPathConditional expr

The expression which will be evaluated to produce a result

Method Detail

condition

public static Triggerable condition(XPathConditional expr,
                                    ConditionAction trueAction,
                                    ConditionAction falseAction,
                                    TreeReference contextRef)

recalculate

public static Triggerable recalculate(XPathConditional expr,
                                      TreeReference contextRef)

eval

public abstract Object eval(FormInstance instance,
                            EvaluationContext ec)

apply

protected abstract void apply(TreeReference ref,
                              Object result,
                              FormInstance mainInstance)

canCascade

public abstract boolean canCascade()

isCascadingToChildren

public abstract boolean isCascadingToChildren()

getTriggers

public Set<TreeReference> getTriggers()

apply

public final List<EvaluationResult> apply(FormInstance mainInstance,
                                          EvaluationContext parentContext,
                                          TreeReference context)

Dispatches all of the evaluation

getTargets

public Set<TreeReference> getTargets()

intersectContextWith

public void intersectContextWith(Triggerable other)

getContext

public TreeReference getContext()

getOriginalContext

public TreeReference getOriginalContext()

setImmediateCascades

public void setImmediateCascades(Set<QuickTriggerable> cascades)

getImmediateCascades

public Set<QuickTriggerable> getImmediateCascades()

getExpr

public IConditionExpr getExpr()

addTarget

public void addTarget(TreeReference target)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

readExternal

public void readExternal(DataInputStream in,
                         PrototypeFactory pf)
                  throws IOException,
                         DeserializationException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

DeserializationException

writeExternal

public void writeExternal(DataOutputStream out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException