org.apache.commons.scxml
Interface Evaluator

All Known Implementing Classes:

ELEvaluator, JexlEvaluator

public interface Evaluator

Interface for a component that may be used by the SCXML engines to evaluate the expressions within the SCXML document.

Method Summary

java.lang.Object	eval(Context ctx, java.lang.String expr) Evaluate an expression.
java.lang.Boolean	evalCond(Context ctx, java.lang.String expr) Evaluate a condition.
org.w3c.dom.Node	evalLocation(Context ctx, java.lang.String expr) Evaluate a location that returns a Node within an XML data tree.
Context	newContext(Context parent) Create a new child context.

Method Detail

eval

public java.lang.Object eval(Context ctx,
                             java.lang.String expr)
                      throws SCXMLExpressionException

Evaluate an expression.

Parameters:

ctx - variable context

expr - expression

Returns:

a result of the evaluation

Throws:

SCXMLExpressionException - A malformed exception

evalCond

public java.lang.Boolean evalCond(Context ctx,
                                  java.lang.String expr)
                           throws SCXMLExpressionException

Evaluate a condition. Manifests as "cond" attributes of <transition>, <if> and <elseif> elements.

Parameters:

ctx - variable context

expr - expression

Returns:

true/false

Throws:

SCXMLExpressionException - A malformed exception

evalLocation

public org.w3c.dom.Node evalLocation(Context ctx,
                                     java.lang.String expr)
                              throws SCXMLExpressionException

Evaluate a location that returns a Node within an XML data tree. Manifests as "location" attributes of <assign> element.

Parameters:

ctx - variable context

expr - expression

Returns:

The location node.

Throws:

SCXMLExpressionException - A malformed exception

newContext

public Context newContext(Context parent)

Create a new child context.

Parameters:

parent - parent context

Returns:

new child context