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 Description

static Comparator<Triggerable> triggerablesRootOrdering

Constructor Summary

Constructors
Constructor	Description
`Triggerable()`
`Triggerable(IConditionExpr expr, TreeReference contextRef)`
`Triggerable(IConditionExpr expr, TreeReference contextRef, ArrayList<TreeReference> targets)`

Method Summary

Modifier and Type	Method	Description
`void`	`addTarget(TreeReference target)`
`List<EvaluationResult>`	`apply(FormInstance mainInstance, EvaluationContext parentContext, TreeReference context)`	Not for re-implementation, dispatches all of the evaluation
`protected abstract void`	`apply(TreeReference ref, Object result, FormInstance mainInstance)`
`abstract boolean`	`canCascade()`
`void`	`changeContextRefToIntersectWithTriggerable(Triggerable t)`
`TreeReference`	`contextualizeContextRef(TreeReference anchorRef)`
`boolean`	`equals(Object o)`
`protected abstract Object`	`eval(FormInstance instance, EvaluationContext ec)`
`List<TreeReference>`	`findAffectedTriggers(Map<TreeReference,List<TreeReference>> firedAnchorsMap)`	Searches in the triggers of this Triggerable, trying to find the ones that are contained in the given list of contextualized refs.
`IConditionExpr`	`getExpr()`
`HashSet<QuickTriggerable>`	`getImmediateCascades()`
`List<TreeReference>`	`getTargets()`
`Set<TreeReference>`	`getTriggers()`
`boolean`	`isCascadingToChildren()`	This should return true if this triggerable's targets will implicity modify the value of their children.
`void`	`print(OutputStreamWriter w)`
`void`	`readExternal(DataInputStream in, PrototypeFactory pf)`
`void`	`setImmediateCascades(HashSet<QuickTriggerable> cascades)`
`void`	`setWaveCount(int waveCount)`
`String`	`toString()`
`void`	`writeExternal(DataOutputStream out)`

Methods inherited from class java.lang.Object

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

Field Details
- triggerablesRootOrdering
  
  public static final Comparator<Triggerable> triggerablesRootOrdering
Constructor Details
- Triggerable
  
  public Triggerable()
- Triggerable
  
  public Triggerable(IConditionExpr expr, TreeReference contextRef, ArrayList<TreeReference> targets)
- Triggerable
  
  public Triggerable(IConditionExpr expr, TreeReference contextRef)
Method Details
- setImmediateCascades
  
  public void setImmediateCascades(HashSet<QuickTriggerable> cascades)
- getImmediateCascades
  
  public HashSet<QuickTriggerable> getImmediateCascades()
- eval
  
  protected abstract Object eval(FormInstance instance, EvaluationContext ec)
- apply
  
  protected abstract void apply(TreeReference ref, Object result, FormInstance mainInstance)
- canCascade
  
  public abstract boolean canCascade()
- apply
  
  public final List<EvaluationResult> apply(FormInstance mainInstance, EvaluationContext parentContext, TreeReference context)
  
  Not for re-implementation, dispatches all of the evaluation
  
  Parameters:
  
  mainInstance -
  
  parentContext -
  
  context -
- getExpr
  
  public IConditionExpr getExpr()
- addTarget
  
  public void addTarget(TreeReference target)
- getTargets
  
  public List<TreeReference> getTargets()
- setWaveCount
  
  public void setWaveCount(int waveCount)
- isCascadingToChildren
  
  public boolean isCascadingToChildren()
  
  This should return true if this triggerable's targets will implicity modify the value of their children. IE: if this triggerable makes a node relevant/irrelevant, expressions which care about the value of this node's children should be triggered.
  
  Returns:
  
  True if this condition should trigger expressions whose targets include nodes which are the children of this node's targets.
- getTriggers
  
  public Set<TreeReference> getTriggers()
- changeContextRefToIntersectWithTriggerable
  
  public void changeContextRefToIntersectWithTriggerable(Triggerable t)
- contextualizeContextRef
  
  public TreeReference contextualizeContextRef(TreeReference anchorRef)
- 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
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- print
  
  public void print(OutputStreamWriter w) throws IOException
  
  Throws:
  
  IOException
- findAffectedTriggers
  
  public List<TreeReference> findAffectedTriggers(Map<TreeReference,List<TreeReference>> firedAnchorsMap)
  
  Searches in the triggers of this Triggerable, trying to find the ones that are contained in the given list of contextualized refs.
  
  Parameters:
  
  firedAnchorsMap - a map of absolute refs
  
  Returns:
  
  a list of affected nodes.

Class Triggerable

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details