A B C D E F G H I J L M N O P R S T U V W X

A

AbstractStateMachine - class org.apache.commons.scxml.env.AbstractStateMachine.

This class demonstrates one approach for providing the base functionality needed by classes representing stateful entities, whose behaviors are defined via SCXML documents.

AbstractStateMachine.EntryListener - class org.apache.commons.scxml.env.AbstractStateMachine.EntryListener.

A SCXMLListener that is only concerned about "onentry" notifications.

AbstractStateMachine.EntryListener() - Constructor for class org.apache.commons.scxml.env.AbstractStateMachine.EntryListener

AbstractStateMachine(URL) - Constructor for class org.apache.commons.scxml.env.AbstractStateMachine

Convenience constructor.

AbstractStateMachine(URL, Context, Evaluator) - Constructor for class org.apache.commons.scxml.env.AbstractStateMachine

Primary constructor.

Action - class org.apache.commons.scxml.model.Action.

An abstract base class for executable elements in SCXML, such as <assign>, <log> etc.

Action() - Constructor for class org.apache.commons.scxml.model.Action

Constructor.

addAction(Action) - Method in class org.apache.commons.scxml.model.If

Add an Action to the list of executable actions contained in this <if>.

addAction(Action) - Method in class org.apache.commons.scxml.model.Executable

Add an Action to the list of executable actions contained in this Executable.

addChild(State) - Method in class org.apache.commons.scxml.model.State

Add a child state.

addData(Data) - Method in class org.apache.commons.scxml.model.Datamodel

Add a Data.

addHistory(History) - Method in class org.apache.commons.scxml.model.State

This method is used by XML digester.

addListener(SCXML, SCXMLListener) - Method in class org.apache.commons.scxml.SCXMLExecutor

Add a listener to the document root.

addListener(Transition, SCXMLListener) - Method in class org.apache.commons.scxml.SCXMLExecutor

Add a listener to this transition.

addListener(TransitionTarget, SCXMLListener) - Method in class org.apache.commons.scxml.SCXMLExecutor

Add a listener to this transition target.

addParam(Param) - Method in class org.apache.commons.scxml.model.Invoke

Add this param to this invoke.

addState(State) - Method in class org.apache.commons.scxml.model.Parallel

Add a State to the list of parallel state machines contained in this Parallel.

addState(State) - Method in class org.apache.commons.scxml.model.SCXML

Add a child state.

addTarget(TransitionTarget) - Method in class org.apache.commons.scxml.model.SCXML

Add a target to this SCXML document.

addTransition(Transition) - Method in class org.apache.commons.scxml.model.State

Add a transition to the map of all outgoing transitions for this state.

Assign - class org.apache.commons.scxml.model.Assign.

The class in this SCXML object model that corresponds to the <assign> SCXML element.

Assign() - Constructor for class org.apache.commons.scxml.model.Assign

Constructor.

B

begin(String, String, Attributes) - Method in class org.apache.commons.scxml.io.SCXMLDigester.ParseDataRule

begin(String, String, Attributes) - Method in class org.apache.commons.scxml.io.SCXMLDigester.DigestSrcAttributeRule

begin(String, String, Attributes) - Method in class org.apache.commons.scxml.io.SCXMLDigester.SetPathResolverRule

begin(String, String, Attributes) - Method in class org.apache.commons.scxml.io.SCXMLDigester.UpdateFinalizeRule

Builtin - class org.apache.commons.scxml.Builtin.

Implementations of builtin functions defined by the SCXML specification.

Builtin() - Constructor for class org.apache.commons.scxml.Builtin

C

CALL_EVENT - Static variable in class org.apache.commons.scxml.TriggerEvent

CALL_EVENT.

Cancel - class org.apache.commons.scxml.model.Cancel.

The class in this SCXML object model that corresponds to the <cancel> SCXML element.

cancel() - Method in class org.apache.commons.scxml.invoke.SimpleSCXMLInvoker

Cancel this invocation..

cancel() - Method in interface org.apache.commons.scxml.invoke.Invoker

Cancel this invocation.

Cancel() - Constructor for class org.apache.commons.scxml.model.Cancel

Constructor.

cancel(String) - Method in interface org.apache.commons.scxml.EventDispatcher

Cancel the specified send message.

cancel(String) - Method in class org.apache.commons.scxml.env.SimpleDispatcher

CHANGE_EVENT - Static variable in class org.apache.commons.scxml.TriggerEvent

CHANGE_EVENT.

cloneDatamodel(Datamodel, Context, Evaluator, Log) - Static method in class org.apache.commons.scxml.SCXMLHelper

Clone data model.

Context - interface org.apache.commons.scxml.Context.

A Context or "scope" for storing variables; usually tied to a SCXML root or State object.

CustomAction - class org.apache.commons.scxml.model.CustomAction.

A custom action is simply a tuple consisting of a namespace URI, the local name for the custom action and the corresponding Action class.

CustomAction(String, String, Class) - Constructor for class org.apache.commons.scxml.model.CustomAction

Constructor, if the namespace or local name is null or empty, or if the implementation is not an Action, an IllegalArgumentException is thrown.

D

Data - class org.apache.commons.scxml.model.Data.

The class in this SCXML object model that corresponds to the SCXML <data> child element of the <datamodel> element.

Data() - Constructor for class org.apache.commons.scxml.model.Data

Constructor.

data(Object, String) - Static method in class org.apache.commons.scxml.Builtin

A variant of the Data() function for Commons SCXML documents, coerced to a Double, a Long or a String, whichever succeeds, in that order.

Datamodel - class org.apache.commons.scxml.model.Datamodel.

The class in this SCXML object model that corresponds to the SCXML <datamodel> element.

Datamodel() - Constructor for class org.apache.commons.scxml.model.Datamodel

Constructor.

dataNode(Object, String) - Static method in class org.apache.commons.scxml.Builtin

Implements the Data() function for Commons SCXML documents, that can be used to obtain a node from one of the XML data trees.

determineInitialStates(SCXML, Set, List, ErrorReporter, SCInstance) - Method in interface org.apache.commons.scxml.SCXMLSemantics

Determining the initial state(s) for this state machine.

determineInitialStates(SCXML, Set, List, ErrorReporter, SCInstance) - Method in class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

determineTargetStates(Set, ErrorReporter, SCInstance) - Method in class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

digest(InputSource, ErrorHandler) - Static method in class org.apache.commons.scxml.io.SCXMLDigester

API for standalone usage where the SCXML document is an InputSource.

digest(InputSource, ErrorHandler, List) - Static method in class org.apache.commons.scxml.io.SCXMLDigester

API for standalone usage where the SCXML document is an InputSource.

digest(String, ErrorHandler, PathResolver) - Static method in class org.apache.commons.scxml.io.SCXMLDigester

API for standalone usage where the SCXML document is a URI.

digest(String, ErrorHandler, PathResolver, List) - Static method in class org.apache.commons.scxml.io.SCXMLDigester

API for standalone usage where the SCXML document is a URI.

digest(URL, ErrorHandler) - Static method in class org.apache.commons.scxml.io.SCXMLDigester

API for standalone usage where the SCXML document is a URL.

digest(URL, ErrorHandler, List) - Static method in class org.apache.commons.scxml.io.SCXMLDigester

API for standalone usage where the SCXML document is a URL, and the document uses custom actions.

E

ELContext - class org.apache.commons.scxml.env.jsp.ELContext.

EL Context for SCXML interpreter.

ELContext() - Constructor for class org.apache.commons.scxml.env.jsp.ELContext

Constructor.

ELContext(Context) - Constructor for class org.apache.commons.scxml.env.jsp.ELContext

Constructor.

ELEvaluator - class org.apache.commons.scxml.env.jsp.ELEvaluator.

Evaluator implementation enabling use of EL expressions in SCXML documents.

ELEvaluator() - Constructor for class org.apache.commons.scxml.env.jsp.ELEvaluator

Constructor.

ELEvaluator(FunctionMapper) - Constructor for class org.apache.commons.scxml.env.jsp.ELEvaluator

Constructor for EL evaluator that supports user-defined functions.

Else - class org.apache.commons.scxml.model.Else.

The class in this SCXML object model that corresponds to the <else> SCXML element.

Else() - Constructor for class org.apache.commons.scxml.model.Else

<else/> is equivalent to <elseif cond="true" />.

ElseIf - class org.apache.commons.scxml.model.ElseIf.

The class in this SCXML object model that corresponds to the <elseif> SCXML element.

ElseIf() - Constructor for class org.apache.commons.scxml.model.ElseIf

Constructor.

end(String, String) - Method in class org.apache.commons.scxml.io.SCXMLDigester.UpdateModelRule

end(String, String) - Method in class org.apache.commons.scxml.io.SCXMLDigester.SetExecutableParentRule

end(String, String) - Method in class org.apache.commons.scxml.io.SCXMLDigester.ParseExternalContentRule

end(String, String) - Method in class org.apache.commons.scxml.io.SCXMLDigester.ParseDataRule

enumerateReachableTransitions(SCXML, Step, ErrorReporter) - Method in interface org.apache.commons.scxml.SCXMLSemantics

Enumerate all the reachable transitions.

enumerateReachableTransitions(SCXML, Step, ErrorReporter) - Method in class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

equals(Object) - Method in class org.apache.commons.scxml.TriggerEvent

Define an equals operator for TriggerEvent.

ERROR_EVENT - Static variable in class org.apache.commons.scxml.TriggerEvent

ERROR_EVENT.

error(SAXParseException) - Method in class org.apache.commons.scxml.env.SimpleErrorHandler

error(SAXParseException) - Method in class org.apache.commons.scxml.env.Tracer

ErrorReporter - interface org.apache.commons.scxml.ErrorReporter.

An interface for reporting SCXML errors to the host environment, containing the definition of commonly occuring errors while executing SCXML documents.

eval(Context, String) - Method in interface org.apache.commons.scxml.Evaluator

Evaluate an expression.

eval(Context, String) - Method in class org.apache.commons.scxml.env.jexl.JexlEvaluator

Evaluate an expression.

eval(Context, String) - Method in class org.apache.commons.scxml.env.jsp.ELEvaluator

Evaluate an expression.

evalCond(Context, String) - Method in interface org.apache.commons.scxml.Evaluator

Evaluate a condition.

evalCond(Context, String) - Method in class org.apache.commons.scxml.env.jexl.JexlEvaluator

evalCond(Context, String) - Method in class org.apache.commons.scxml.env.jsp.ELEvaluator

evalLocation(Context, String) - Method in interface org.apache.commons.scxml.Evaluator

Evaluate a location that returns a Node within an XML data tree.

evalLocation(Context, String) - Method in class org.apache.commons.scxml.env.jexl.JexlEvaluator

evalLocation(Context, String) - Method in class org.apache.commons.scxml.env.jsp.ELEvaluator

Evaluator - interface org.apache.commons.scxml.Evaluator.

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

EventDispatcher - interface org.apache.commons.scxml.EventDispatcher.

The event controller interface used to send messages containing events or other information directly to another SCXML Interpreter, other external systems using an Event I/O Processor or to raise events in the current SCXML session.

eventMatch(String, Set) - Method in class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

Implements prefix match, that is, if, for example, "mouse.click" is a member of eventOccurrences and a transition is triggered by "mouse", the method returns true.

Executable - class org.apache.commons.scxml.model.Executable.

An abstract base class for containers of executable elements in SCXML, such as <onentry> and <onexit>.

Executable() - Constructor for class org.apache.commons.scxml.model.Executable

Constructor.

execute(EventDispatcher, ErrorReporter, SCInstance, Log, Collection) - Method in class org.apache.commons.scxml.model.If

Execute this action instance.

execute(EventDispatcher, ErrorReporter, SCInstance, Log, Collection) - Method in class org.apache.commons.scxml.model.Send

Execute this action instance.

execute(EventDispatcher, ErrorReporter, SCInstance, Log, Collection) - Method in class org.apache.commons.scxml.model.Assign

Execute this action instance.

execute(EventDispatcher, ErrorReporter, SCInstance, Log, Collection) - Method in class org.apache.commons.scxml.model.Exit

Execute this action instance.

execute(EventDispatcher, ErrorReporter, SCInstance, Log, Collection) - Method in class org.apache.commons.scxml.model.ElseIf

Execute this action instance.

execute(EventDispatcher, ErrorReporter, SCInstance, Log, Collection) - Method in class org.apache.commons.scxml.model.Var

Execute this action instance.

execute(EventDispatcher, ErrorReporter, SCInstance, Log, Collection) - Method in class org.apache.commons.scxml.model.Log

Execute this action instance.

execute(EventDispatcher, ErrorReporter, SCInstance, Log, Collection) - Method in class org.apache.commons.scxml.model.Cancel

Execute this action instance.

execute(EventDispatcher, ErrorReporter, SCInstance, Log, Collection) - Method in class org.apache.commons.scxml.model.Action

Execute this action instance.

execute(String, Evaluator) - Static method in class org.apache.commons.scxml.test.StandaloneUtils

Command line utility method for executing the state machine defined using the SCXML document described by the specified URI and using the specified expression evaluator.

executeActions(Step, SCXML, EventDispatcher, ErrorReporter, SCInstance) - Method in interface org.apache.commons.scxml.SCXMLSemantics

Executes all OnExit/Transition/OnEntry transitional actions.

executeActions(Step, SCXML, EventDispatcher, ErrorReporter, SCInstance) - Method in class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

Executes all OnExit/Transition/OnEntry transitional actions.

Exit - class org.apache.commons.scxml.model.Exit.

The class in this SCXML object model that corresponds to the <exit> SCXML element, which is a shorthand notation for an empty anonymous final state.

Exit() - Constructor for class org.apache.commons.scxml.model.Exit

Constructor.

EXPRESSION_ERROR - Static variable in interface org.apache.commons.scxml.ErrorReporter

An expression language error.

ExternalContent - interface org.apache.commons.scxml.model.ExternalContent.

An ExternalContent implementation represents an element in the SCXML document that may contain "body content", which means an arbitrary number of child nodes belonging to external namespaces.

F

fatalError(SAXParseException) - Method in class org.apache.commons.scxml.env.SimpleErrorHandler

fatalError(SAXParseException) - Method in class org.apache.commons.scxml.env.Tracer

filterTransitionsSet(Step, EventDispatcher, ErrorReporter, SCInstance) - Method in interface org.apache.commons.scxml.SCXMLSemantics

Filter the transitions set, eliminate those whose guard conditions are not satisfied.

filterTransitionsSet(Step, EventDispatcher, ErrorReporter, SCInstance) - Method in class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

Finalize - class org.apache.commons.scxml.model.Finalize.

The class in this SCXML object model that corresponds to the <finalize> SCXML element.

Finalize() - Constructor for class org.apache.commons.scxml.model.Finalize

Default no-args constructor for Digester.

finalizeMatch(String, Set) - Method in class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

Implements event prefix match to ascertain <finalize> execution.

fireEvent(String) - Method in class org.apache.commons.scxml.env.AbstractStateMachine

Fire an event on the SCXML engine.

fireOnEntry(SCXML, TransitionTarget) - Method in class org.apache.commons.scxml.NotificationRegistry

Inform all relevant listeners that a TransitionTarget has been entered.

fireOnEntry(TransitionTarget, TransitionTarget) - Method in class org.apache.commons.scxml.NotificationRegistry

Inform all relevant listeners that a TransitionTarget has been entered.

fireOnExit(SCXML, TransitionTarget) - Method in class org.apache.commons.scxml.NotificationRegistry

Inform all relevant listeners that a TransitionTarget has been exited.

fireOnExit(TransitionTarget, TransitionTarget) - Method in class org.apache.commons.scxml.NotificationRegistry

Inform all relevant listeners that a TransitionTarget has been exited.

fireOnTransition(SCXML, TransitionTarget, TransitionTarget, Transition) - Method in class org.apache.commons.scxml.NotificationRegistry

Inform all relevant listeners of a transition that has occured.

fireOnTransition(Transition, TransitionTarget, TransitionTarget, Transition) - Method in class org.apache.commons.scxml.NotificationRegistry

Inform all relevant listeners of a transition that has occured.

followTransitions(Step, ErrorReporter, SCInstance) - Method in interface org.apache.commons.scxml.SCXMLSemantics

Follow the candidate transitions for this execution Step, and update the lists of entered and exited states accordingly.

followTransitions(Step, ErrorReporter, SCInstance) - Method in class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

Follow the candidate transitions for this execution Step, and update the lists of entered and exited states accordingly.

G

get(String) - Method in interface org.apache.commons.scxml.Context

Get the value of this variable; delegating to parent.

get(String) - Method in class org.apache.commons.scxml.env.SimpleContext

Get the value of this variable; delegating to parent.

get(String) - Method in class org.apache.commons.scxml.env.faces.SessionContext

Get the value of the given variable in this Context.

get(String) - Method in class org.apache.commons.scxml.env.jsp.RootContext

Get the value of the given variable in this Context.

getActionClass() - Method in class org.apache.commons.scxml.model.CustomAction

Get this custom action's implementation.

getActions() - Method in class org.apache.commons.scxml.model.If

Get the executable actions contained in this <if>.

getActions() - Method in class org.apache.commons.scxml.model.Executable

Get the executable actions contained in this Executable.

getAfterStatus() - Method in class org.apache.commons.scxml.Step

getAllStates() - Method in class org.apache.commons.scxml.Status

Get the complete states configuration.

getAncestorClosure(Set, Set) - Static method in class org.apache.commons.scxml.SCXMLHelper

Creates a set which contains given states and all their ancestors recursively up to the upper bound.

getBeforeStatus() - Method in class org.apache.commons.scxml.Step

getBodyContent(ExternalContent) - Static method in class org.apache.commons.scxml.io.SCXMLSerializer

Return serialized body of ExternalContent.

getBuiltinFnMapper() - Method in class org.apache.commons.scxml.env.jsp.ELEvaluator

Get the FunctionMapper for builtin SCXML/Commons SCXML functions.

getChildren() - Method in class org.apache.commons.scxml.model.State

Get the map of child states (may be empty).

getCond() - Method in class org.apache.commons.scxml.model.If

Get the conditional expression.

getCond() - Method in class org.apache.commons.scxml.model.ElseIf

Get the conditional expression.

getCond() - Method in class org.apache.commons.scxml.model.Transition

Get the guard condition (may be null).

getContext(TransitionTarget) - Method in class org.apache.commons.scxml.SCInstance

Get the Context for this TransitionTarget.

getCurrentStatus() - Method in class org.apache.commons.scxml.SCXMLExecutor

Get the current status.

getData() - Method in class org.apache.commons.scxml.model.Datamodel

Get all the data children of this datamodel.

getDatamodel() - Method in class org.apache.commons.scxml.model.TransitionTarget

Get the data model for this transition target.

getDatamodel() - Method in class org.apache.commons.scxml.model.SCXML

Get the data model placed at document root.

getDelay() - Method in class org.apache.commons.scxml.model.Send

Get the delay.

getDownwardSegment() - Method in class org.apache.commons.scxml.model.Path

Get the downward segment.

getEngine() - Method in class org.apache.commons.scxml.env.AbstractStateMachine

Get the SCXML engine driving the "lifecycle" of the instances of this class.

getEntryList() - Method in class org.apache.commons.scxml.Step

getErrorReporter() - Method in class org.apache.commons.scxml.SCXMLExecutor

Get the environment specific error reporter.

getEvaluator() - Method in class org.apache.commons.scxml.SCXMLExecutor

Get the expression evaluator in use.

getEvaluator() - Method in class org.apache.commons.scxml.SCInstance

Get the Evaluator.

getEvent() - Method in class org.apache.commons.scxml.model.Send

Set the event to send.

getEvent() - Method in class org.apache.commons.scxml.model.Transition

Get the event that will trigger this transition (pending evaluation of the guard condition in favor).

getEventdispatcher() - Method in class org.apache.commons.scxml.SCXMLExecutor

Get the event dispatcher.

getEvents() - Method in class org.apache.commons.scxml.Status

Get the events that are currently queued.

getExecutor() - Method in class org.apache.commons.scxml.SCInstance

Get the SCXMLExecutor this instance is attached to.

getExitList() - Method in class org.apache.commons.scxml.Step

getExpr() - Method in class org.apache.commons.scxml.model.Assign

Get the expr that will evaluate to the new value.

getExpr() - Method in class org.apache.commons.scxml.model.Exit

Get the expression.

getExpr() - Method in class org.apache.commons.scxml.model.Var

Get the expression that evaluates to the initial value of the variable.

getExpr() - Method in class org.apache.commons.scxml.model.Log

Get the log expression.

getExpr() - Method in class org.apache.commons.scxml.model.Param

Get the expression for this param value.

getExpr() - Method in class org.apache.commons.scxml.model.Data

Get the expression that evaluates to the value of this data instance.

getExternalEvents() - Method in class org.apache.commons.scxml.Step

getExternalNodes() - Method in class org.apache.commons.scxml.model.Send

Get the list of external namespaced child nodes.

getExternalNodes() - Method in interface org.apache.commons.scxml.model.ExternalContent

Return the list of external namespaced children as DOM node instances.

getFinalize() - Method in class org.apache.commons.scxml.model.Invoke

Get the Finalize for this Invoke.

getHints() - Method in class org.apache.commons.scxml.model.Send

Get the hints for this <send> element.

getHistory() - Method in class org.apache.commons.scxml.model.State

Get the list of history pseudo states for this state.

getId() - Method in class org.apache.commons.scxml.model.TransitionTarget

Get the identifier for this transition target (may be null).

getInitial() - Method in class org.apache.commons.scxml.model.State

Get the initial state.

getInitialstate() - Method in class org.apache.commons.scxml.model.SCXML

Get the ID of the initial state.

getInitialState() - Method in class org.apache.commons.scxml.model.SCXML

Get the initial State.

getInvoke() - Method in class org.apache.commons.scxml.model.State

Get the Invoke child (may be null).

getInvoker(TransitionTarget) - Method in class org.apache.commons.scxml.SCInstance

Get the Invoker for this TransitionTarget.

getInvokers() - Method in class org.apache.commons.scxml.SCInstance

Return the Map of Invokers currently "active".

getIsFinal() - Method in class org.apache.commons.scxml.model.State

Is this state a "final" state.

getLabel() - Method in class org.apache.commons.scxml.model.Log

Get the log label.

getLastConfiguration(History) - Method in class org.apache.commons.scxml.SCInstance

Get the last configuration for this history.

getLCA(TransitionTarget, TransitionTarget) - Static method in class org.apache.commons.scxml.SCXMLHelper

Finds the least common ancestor of transition targets tt1 and tt2 if one exists.

getLocalName() - Method in class org.apache.commons.scxml.model.CustomAction

Get the local name for this custom action.

getLocation() - Method in class org.apache.commons.scxml.model.Assign

Get the location for a previously defined XML data tree.

getLog() - Method in class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

Get the log used by this SCXMLSemantics instance.

getLog() - Method in class org.apache.commons.scxml.env.AbstractStateMachine

Get the log for this class.

getLog() - Method in class org.apache.commons.scxml.env.SimpleContext

Get the log used by this Context instance.

getLog() - Method in class org.apache.commons.scxml.env.jsp.ELEvaluator

Get the log used by this Evaluator instance.

getName() - Method in class org.apache.commons.scxml.TriggerEvent

getName() - Method in class org.apache.commons.scxml.model.Assign

Get the variable to be assigned a new value.

getName() - Method in class org.apache.commons.scxml.model.Var

Get the name of the (new) variable.

getName() - Method in class org.apache.commons.scxml.model.Param

Get the name for this param.

getName() - Method in class org.apache.commons.scxml.model.Data

Get the name.

getNamelist() - Method in class org.apache.commons.scxml.model.Send

Get the namelist.

getNamelist() - Method in class org.apache.commons.scxml.model.Exit

Get the namelist.

getNamespaceURI() - Method in class org.apache.commons.scxml.model.CustomAction

Get the namespace URI for this custom action.

getNext() - Method in class org.apache.commons.scxml.model.Transition

Get the ID of the transition target (may be null, if, for example, the target is specified inline).

getNode() - Method in class org.apache.commons.scxml.model.Data

Get the XML data tree.

getNodeValue(Node) - Static method in class org.apache.commons.scxml.SCXMLHelper

Retrieve a DOM node value as a string depending on its type.

getNotificationRegistry() - Method in class org.apache.commons.scxml.SCInstance

Get the notification registry.

getOnEntry() - Method in class org.apache.commons.scxml.model.TransitionTarget

Get the onentry property.

getOnExit() - Method in class org.apache.commons.scxml.model.TransitionTarget

Get the onexit property.

getParallel() - Method in class org.apache.commons.scxml.model.State

Get the Parallel child (may be null).

getParams() - Method in class org.apache.commons.scxml.model.Invoke

Get the params Map.

getParent() - Method in interface org.apache.commons.scxml.Context

Get the parent Context, may be null.

getParent() - Method in class org.apache.commons.scxml.env.SimpleContext

Get the parent Context, may be null.

getParent() - Method in class org.apache.commons.scxml.model.Action

Get the Executable parent.

getParent() - Method in class org.apache.commons.scxml.model.Executable

Get the TransitionTarget parent.

getParent() - Method in class org.apache.commons.scxml.model.TransitionTarget

Get the parent TransitionTarget.

getParentState() - Method in class org.apache.commons.scxml.model.Action

Return the parent state.

getParentState() - Method in class org.apache.commons.scxml.model.TransitionTarget

Get the parent State.

getPath() - Method in class org.apache.commons.scxml.model.Transition

Get the path of this transiton.

getPathResolver() - Method in class org.apache.commons.scxml.model.Assign

Get the PathResolver.

getPathResolver() - Method in interface org.apache.commons.scxml.model.PathResolverHolder

Get the PathResolver.

getPathResolver() - Method in class org.apache.commons.scxml.model.Invoke

Get the PathResolver.

getPayload() - Method in class org.apache.commons.scxml.TriggerEvent

getRegionsEntered() - Method in class org.apache.commons.scxml.model.Path

Get the list of regions entered.

getRegionsExited() - Method in class org.apache.commons.scxml.model.Path

Get the list of regions exited.

getResolver(String) - Method in interface org.apache.commons.scxml.PathResolver

Get a PathResolver rooted at this context sensitive path.

getResolver(String) - Method in class org.apache.commons.scxml.env.URLResolver

getResolver(String) - Method in class org.apache.commons.scxml.env.servlet.ServletContextResolver

Retrieve the PathResolver rooted at the given path.

getRootContext() - Method in class org.apache.commons.scxml.SCXMLExecutor

Get the root context for this execution.

getRootContext() - Method in class org.apache.commons.scxml.SCInstance

Get the root context.

getRuntimeTarget() - Method in class org.apache.commons.scxml.model.Transition

Get the runtime transition target, which always resolves to a TransitionTarget instance.

getScope() - Method in class org.apache.commons.scxml.model.Path

Get the farthest state from root which is not being exited nor entered by the transition (null if scope is document root).

getSendid() - Method in class org.apache.commons.scxml.model.Send

Get the identifier for this <send> element.

getSendid() - Method in class org.apache.commons.scxml.model.Cancel

Get the ID of the send message that should be cancelled.

getSrc() - Method in class org.apache.commons.scxml.model.Assign

Get the source where the new XML instance for this location exists.

getSrc() - Method in class org.apache.commons.scxml.model.Data

Get the URL where the XML data tree resides.

getSrc() - Method in class org.apache.commons.scxml.model.Invoke

Get the URL for the external service.

getSrcexpr() - Method in class org.apache.commons.scxml.model.Invoke

Get the expression that evaluates to the source URL for the external service.

getStateMachine() - Method in class org.apache.commons.scxml.SCXMLExecutor

Get the state machine that is being executed.

getStateMachine() - Static method in class org.apache.commons.scxml.env.AbstractStateMachine

Get the SCXML object representing this state machine.

getStates() - Method in class org.apache.commons.scxml.Status

Get the states configuration (leaf only).

getStates() - Method in class org.apache.commons.scxml.model.Parallel

Get the set of parallel state machines contained in this Parallel.

getStates() - Method in class org.apache.commons.scxml.model.SCXML

Get the children states.

getStatesExited(Transition, Set) - Static method in class org.apache.commons.scxml.SCXMLHelper

Returns the set of all states (and parallels) which are exited if a given transition t is going to be taken.

getTarget() - Method in class org.apache.commons.scxml.model.Send

Get the target for this <send> element.

getTarget() - Method in class org.apache.commons.scxml.model.Transition

Get the transition target (may be null).

getTargets() - Method in class org.apache.commons.scxml.model.SCXML

Get the targets map, whichis a Map of all States and Parallels associated with this state machine, keyed by their id.

getTargettype() - Method in class org.apache.commons.scxml.model.Send

Get the target type for this <send> element.

getTargettype() - Method in class org.apache.commons.scxml.model.Invoke

Get the target type for this <invoke> element.

getTransition() - Method in class org.apache.commons.scxml.model.Initial

Get the initial transition.

getTransition() - Method in class org.apache.commons.scxml.model.History

Get the transition.

getTransitions() - Method in class org.apache.commons.scxml.model.State

Get the map of all outgoing transitions from this state.

getTransitionsList() - Method in class org.apache.commons.scxml.model.State

Get the outgoing transitions for this state as a java.util.List.

getTransitionsList(String) - Method in class org.apache.commons.scxml.model.State

Get the list of all outgoing transitions from this state, that will be candidates for being fired on the given event.

getTransitList() - Method in class org.apache.commons.scxml.Step

getTTComparator() - Method in class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

TransitionTargetComparator factory method.

getTTPath(TransitionTarget) - Static method in class org.apache.commons.scxml.env.LogUtils

Write out this TransitionTarget location in a XPath style format.

getType() - Method in class org.apache.commons.scxml.TriggerEvent

getUpwardSegment() - Method in class org.apache.commons.scxml.model.Path

Get the upward segment.

getVariableResolver() - Method in class org.apache.commons.scxml.env.jsp.RootContext

Get the VariableResolver associated with this root context.

getVars() - Method in interface org.apache.commons.scxml.Context

Get the Map of all variables in this Context.

getVars() - Method in class org.apache.commons.scxml.env.SimpleContext

Get the Map of all local variables in this Context.

getVars() - Method in class org.apache.commons.scxml.env.jexl.JexlContext

Get the variables map.

getVersion() - Method in class org.apache.commons.scxml.model.SCXML

Get the SCXML document version.

getXmlns() - Method in class org.apache.commons.scxml.model.SCXML

Get the xmlns of this SCXML document.

go() - Method in class org.apache.commons.scxml.SCXMLExecutor

Initiate state machine execution.

H

has(String) - Method in interface org.apache.commons.scxml.Context

Check if this variable exists, delegating to parent.

has(String) - Method in class org.apache.commons.scxml.env.SimpleContext

Check if this variable exists, delegating to parent.

has(String) - Method in class org.apache.commons.scxml.env.faces.SessionContext

Does the given variable exist in this Context.

has(String) - Method in class org.apache.commons.scxml.env.jsp.RootContext

Does the given variable exist in this Context.

hashCode() - Method in class org.apache.commons.scxml.TriggerEvent

Returns the hash code for this TriggerEvent object.

hasHistory() - Method in class org.apache.commons.scxml.model.State

Does this state have a history pseudo state.

History - class org.apache.commons.scxml.model.History.

The class in this SCXML object model that corresponds to the <history> SCXML pseudo state element.

History() - Constructor for class org.apache.commons.scxml.model.History

Default no-args constructor for XML Digester.

I

If - class org.apache.commons.scxml.model.If.

The class in this SCXML object model that corresponds to the <if> SCXML element, which serves as a container for conditionally executed elements.

If() - Constructor for class org.apache.commons.scxml.model.If

Constructor.

ILLEGAL_CONFIG - Static variable in interface org.apache.commons.scxml.ErrorReporter

Illegal state machine configuration.

ILLEGAL_INITIAL - Static variable in interface org.apache.commons.scxml.ErrorReporter

An initial state for a composite state whose Transition does not.

implementationOf(Class, Class) - Static method in class org.apache.commons.scxml.SCXMLHelper

Whether the class implements the interface.

inConflict(Transition, Transition, Set) - Static method in class org.apache.commons.scxml.SCXMLHelper

According to the UML definition, two transitions are conflicting if the sets of states they exit overlap.

Initial - class org.apache.commons.scxml.model.Initial.

The class in this SCXML object model that corresponds to the <initial> SCXML pseudo state element.

Initial() - Constructor for class org.apache.commons.scxml.model.Initial

Constructor.

initiateInvokes(Step, ErrorReporter, SCInstance) - Method in interface org.apache.commons.scxml.SCXMLSemantics

Initiate any new invoked activities.

initiateInvokes(Step, ErrorReporter, SCInstance) - Method in class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

Initiate any new invokes.

Invoke - class org.apache.commons.scxml.model.Invoke.

The class in this SCXML object model that corresponds to the <invoke> SCXML element.

Invoke() - Constructor for class org.apache.commons.scxml.model.Invoke

Default no-args constructor for Digester.

invoke(String) - Method in class org.apache.commons.scxml.env.AbstractStateMachine

Invoke the no argument method with the following name.

invoke(String, Map) - Method in class org.apache.commons.scxml.invoke.SimpleSCXMLInvoker

Begin this invocation..

invoke(String, Map) - Method in interface org.apache.commons.scxml.invoke.Invoker

Begin this invocation.

Invoker - interface org.apache.commons.scxml.invoke.Invoker.

The Invoker interface is used to define the possible interactions between the parent state machine (executor) and the types of invocable activities.

InvokerException - exception org.apache.commons.scxml.invoke.InvokerException.

Exception thrown when a process specified by an <invoke> cannot be initiated.

InvokerException() - Constructor for class org.apache.commons.scxml.invoke.InvokerException

InvokerException(String) - Constructor for class org.apache.commons.scxml.invoke.InvokerException

InvokerException(String, Throwable) - Constructor for class org.apache.commons.scxml.invoke.InvokerException

InvokerException(Throwable) - Constructor for class org.apache.commons.scxml.invoke.InvokerException

isComposite() - Method in class org.apache.commons.scxml.model.State

Check whether this is a composite state (UML terminology).

isCrossRegion() - Method in class org.apache.commons.scxml.model.Path

Does this "path" cross regions.

isDeep() - Method in class org.apache.commons.scxml.model.History

Is this history "deep" (as against "shallow").

isDescendant(TransitionTarget, TransitionTarget) - Static method in class org.apache.commons.scxml.SCXMLHelper

Checks whether a transition target tt (State or Parallel) is a descendant of the transition target context.

isDone() - Method in class org.apache.commons.scxml.model.State

In case this is a parallel state, check if one its final states is active.

isEmpty(History) - Method in class org.apache.commons.scxml.SCInstance

Check whether we have prior history.

isFinal() - Method in class org.apache.commons.scxml.Status

Have we reached a final configuration for this state machine.

isLegalConfig(Set, ErrorReporter) - Static method in class org.apache.commons.scxml.SCXMLHelper

Checks whether a given set of states is a legal Harel State Table configuration (with the respect to the definition of the OR and AND states).

isMember(Set, String) - Static method in class org.apache.commons.scxml.Builtin

Implements the In() predicate for SCXML documents.

isOrthogonal() - Method in class org.apache.commons.scxml.model.State

Checks whether it is a orthogonal state, that is, it owns a parallel (UML terminology).

isRegion() - Method in class org.apache.commons.scxml.model.State

Checks whether it is a region state (directly nested to parallel - UML terminology).

isSimple() - Method in class org.apache.commons.scxml.model.State

Check whether this is a simple (leaf) state (UML terminology).

isStringEmpty(String) - Static method in class org.apache.commons.scxml.SCXMLHelper

Return true if the string is empty.

isSuperStep() - Method in class org.apache.commons.scxml.SCXMLExecutor

Use "super-step", default is true (that is, run-to-completion is default).

J

JexlContext - class org.apache.commons.scxml.env.jexl.JexlContext.

JEXL Context implementation for Commons SCXML.

JexlContext() - Constructor for class org.apache.commons.scxml.env.jexl.JexlContext

Constructor.

JexlContext(Context) - Constructor for class org.apache.commons.scxml.env.jexl.JexlContext

Constructor with parent context.

JexlContext(Map) - Constructor for class org.apache.commons.scxml.env.jexl.JexlContext

Constructor with initial vars.

JexlEvaluator - class org.apache.commons.scxml.env.jexl.JexlEvaluator.

Evaluator implementation enabling use of JEXL expressions in SCXML documents.

JexlEvaluator() - Constructor for class org.apache.commons.scxml.env.jexl.JexlEvaluator

Constructor.

L

Log - class org.apache.commons.scxml.model.Log.

The class in this SCXML object model that corresponds to the <log> SCXML element.

Log() - Constructor for class org.apache.commons.scxml.model.Log

Constructor.

logError(Exception) - Method in class org.apache.commons.scxml.env.AbstractStateMachine

Utility method for logging error.

LogUtils - class org.apache.commons.scxml.env.LogUtils.

Helper methods for Commons SCXML logging.

M

main(String[]) - Static method in class org.apache.commons.scxml.test.StandaloneElExpressions

Launcher.

main(String[]) - Static method in class org.apache.commons.scxml.test.StandaloneJexlExpressions

Launcher.

ModelException - exception org.apache.commons.scxml.model.ModelException.

Exception that is thrown when the SCXML model supplied to the executor has a fatal flaw that prevents the executor from further interpreting the the model.

ModelException() - Constructor for class org.apache.commons.scxml.model.ModelException

ModelException(String) - Constructor for class org.apache.commons.scxml.model.ModelException

ModelException(String, Throwable) - Constructor for class org.apache.commons.scxml.model.ModelException

ModelException(Throwable) - Constructor for class org.apache.commons.scxml.model.ModelException

N

newContext(Context) - Method in interface org.apache.commons.scxml.Evaluator

Create a new child context.

newContext(Context) - Method in class org.apache.commons.scxml.env.jexl.JexlEvaluator

Create a new child context.

newContext(Context) - Method in class org.apache.commons.scxml.env.jsp.ELEvaluator

Create a new child context.

newInstance() - Static method in class org.apache.commons.scxml.io.SCXMLDigester

Obtain a SCXML digester instance for further customization.

newInstance(PathResolver) - Static method in class org.apache.commons.scxml.io.SCXMLDigester

Obtain a SCXML digester instance for further customization.

newInstance(SCXML, PathResolver) - Static method in class org.apache.commons.scxml.io.SCXMLDigester

Obtain a SCXML digester instance for further customization.

newInstance(SCXML, PathResolver, List) - Static method in class org.apache.commons.scxml.io.SCXMLDigester

Obtain a SCXML digester instance for further customization.

newInvoker(String) - Method in class org.apache.commons.scxml.SCInstance

Get the Invoker for this TransitionTarget.

NO_INITIAL - Static variable in interface org.apache.commons.scxml.ErrorReporter

Missing initial state for a composite state or for the smxml root.

NON_DETERMINISTIC - Static variable in interface org.apache.commons.scxml.ErrorReporter

Non-deterministic situation has occured - there are more than one enabled transitions in conflict.

normalizeStateMachine(SCXML, ErrorReporter) - Method in interface org.apache.commons.scxml.SCXMLSemantics

Optional post processing immediately following Digester.

normalizeStateMachine(SCXML, ErrorReporter) - Method in class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

NotificationRegistry - class org.apache.commons.scxml.NotificationRegistry.

The registry where SCXML listeners are recorded for nodes of interest such as the SCXML root, TransitionTargets and Transitions.

NotificationRegistry() - Constructor for class org.apache.commons.scxml.NotificationRegistry

Constructor.

O

OnEntry - class org.apache.commons.scxml.model.OnEntry.

The class in this SCXML object model that corresponds to the <onentry> SCXML element, which is an optional property holding executable content to be run upon entering the parent State or Parallel.

OnEntry() - Constructor for class org.apache.commons.scxml.model.OnEntry

Constructor.

onEntry(TransitionTarget) - Method in interface org.apache.commons.scxml.SCXMLListener

Handle the entry into a TransitionTarget.

onEntry(TransitionTarget) - Method in class org.apache.commons.scxml.env.SimpleSCXMLListener

onEntry(TransitionTarget) - Method in class org.apache.commons.scxml.env.AbstractStateMachine.EntryListener

Handle the entry into a TransitionTarget.

onEntry(TransitionTarget) - Method in class org.apache.commons.scxml.env.Tracer

onError(String, String, Object) - Method in interface org.apache.commons.scxml.ErrorReporter

Handler for reporting an error.

onError(String, String, Object) - Method in class org.apache.commons.scxml.env.SimpleErrorReporter

onError(String, String, Object) - Method in class org.apache.commons.scxml.env.Tracer

OnExit - class org.apache.commons.scxml.model.OnExit.

The class in this SCXML object model that corresponds to the <onexit> SCXML element, which is an optional property holding executable content to be run upon exiting the parent State or Parallel.

OnExit() - Constructor for class org.apache.commons.scxml.model.OnExit

Constructor.

onExit(TransitionTarget) - Method in interface org.apache.commons.scxml.SCXMLListener

Handle the exit out of a TransitionTarget.

onExit(TransitionTarget) - Method in class org.apache.commons.scxml.env.SimpleSCXMLListener

onExit(TransitionTarget) - Method in class org.apache.commons.scxml.env.AbstractStateMachine.EntryListener

No-op.

onExit(TransitionTarget) - Method in class org.apache.commons.scxml.env.Tracer

onTransition(TransitionTarget, TransitionTarget, Transition) - Method in interface org.apache.commons.scxml.SCXMLListener

Handle the transition.

onTransition(TransitionTarget, TransitionTarget, Transition) - Method in class org.apache.commons.scxml.env.SimpleSCXMLListener

onTransition(TransitionTarget, TransitionTarget, Transition) - Method in class org.apache.commons.scxml.env.AbstractStateMachine.EntryListener

No-op.

onTransition(TransitionTarget, TransitionTarget, Transition) - Method in class org.apache.commons.scxml.env.Tracer

org.apache.commons.scxml - package org.apache.commons.scxml

The Commons SCXML executor and core concepts.

org.apache.commons.scxml.env - package org.apache.commons.scxml.env

A collection of classes that may be commonly used to bridge the SCXML executor to the runtime environment.

org.apache.commons.scxml.env.faces - package org.apache.commons.scxml.env.faces

A collection of classes bridging the SCXML executor to the JSF-based environments.

org.apache.commons.scxml.env.jexl - package org.apache.commons.scxml.env.jexl

A collection of classes that allow JEXL to be used in expressions within SCXML documents.

org.apache.commons.scxml.env.jsp - package org.apache.commons.scxml.env.jsp

A collection of classes bridging the SCXML executor to the JSP environment.

org.apache.commons.scxml.env.servlet - package org.apache.commons.scxml.env.servlet

A collection of classes useful in the servlet container environment.

org.apache.commons.scxml.invoke - package org.apache.commons.scxml.invoke

A collection of classes related to the SCXML <invoke> element and its children, dealing with the invocation of activities associated with a particular state in the state machine.

org.apache.commons.scxml.io - package org.apache.commons.scxml.io

A collection of classes for reading in and writing out SCXML documents, to and from the Commons SCXML Java object model.

org.apache.commons.scxml.model - package org.apache.commons.scxml.model

A collection of classes needed to model SCXML documents.

org.apache.commons.scxml.semantics - package org.apache.commons.scxml.semantics

A collection of classes responsible for implementations of the org.apache.commons.scxml.SCXMLSemantics interface.

org.apache.commons.scxml.test - package org.apache.commons.scxml.test

A collection of classes useful for command line testing.

P

Parallel - class org.apache.commons.scxml.model.Parallel.

The class in this SCXML object model that corresponds to the <parallel> SCXML element, which is a wrapper element to encapsulate parallel state machines.

Parallel() - Constructor for class org.apache.commons.scxml.model.Parallel

Constructor.

Param - class org.apache.commons.scxml.model.Param.

The class in this SCXML object model that corresponds to the <param> SCXML element.

Param() - Constructor for class org.apache.commons.scxml.model.Param

Default no-args constructor for Digester.

parentEvents(TriggerEvent[]) - Method in class org.apache.commons.scxml.invoke.SimpleSCXMLInvoker

Forwards the events triggered on the parent state machine on to the invoked activity..

parentEvents(TriggerEvent[]) - Method in interface org.apache.commons.scxml.invoke.Invoker

Forwards the events triggered on the parent state machine on to the invoked activity.

Path - class org.apache.commons.scxml.model.Path.

A helper class for this SCXML implementation that represents the path taken to transition from one TransitionTarget to another in the SCXML document.

PathResolver - interface org.apache.commons.scxml.PathResolver.

Interface for a component that may be used by the SCXML engines to resolve context sensitive paths.

PathResolverHolder - interface org.apache.commons.scxml.model.PathResolverHolder.

A PathResolverHolder is an entity that holds a PathResolver.

processInvokes(TriggerEvent[], ErrorReporter, SCInstance) - Method in interface org.apache.commons.scxml.SCXMLSemantics

Forward events to invoked activities, execute finalize handlers.

processInvokes(TriggerEvent[], ErrorReporter, SCInstance) - Method in class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

Process any existing invokes, includes forwarding external events, and executing any finalize handlers.

R

registerInvokerClass(String, Class) - Method in class org.apache.commons.scxml.SCXMLExecutor

Register an Invoker for this target type.

removeListener(SCXML, SCXMLListener) - Method in class org.apache.commons.scxml.SCXMLExecutor

Remove this listener from the document root.

removeListener(Transition, SCXMLListener) - Method in class org.apache.commons.scxml.SCXMLExecutor

Remove this listener for this transition.

removeListener(TransitionTarget, SCXMLListener) - Method in class org.apache.commons.scxml.SCXMLExecutor

Remove this listener for this transition target.

reset() - Method in class org.apache.commons.scxml.SCXMLExecutor

Clear all state and begin from "initialstate" indicated on root SCXML element.

reset() - Method in interface org.apache.commons.scxml.Context

Clear this Context.

reset() - Method in class org.apache.commons.scxml.env.SimpleContext

Clear this Context.

reset() - Method in class org.apache.commons.scxml.env.jexl.JexlContext

Clear this Context.

reset(History) - Method in class org.apache.commons.scxml.SCInstance

Resets the history state.

resetMachine() - Method in class org.apache.commons.scxml.env.AbstractStateMachine

Reset the state machine.

resolvePath(String) - Method in interface org.apache.commons.scxml.PathResolver

Resolve this context sensitive path to an absolute URL.

resolvePath(String) - Method in class org.apache.commons.scxml.env.URLResolver

Uses URL(URL, String) constructor to combine URL's.

resolvePath(String) - Method in class org.apache.commons.scxml.env.servlet.ServletContextResolver

Delegates to the underlying ServletContext's getRealPath(String).

resolveVariable(String) - Method in class org.apache.commons.scxml.env.jsp.ELContext

Resolves the specified variable.

RootContext - class org.apache.commons.scxml.env.jsp.RootContext.

EL Context for root SCXML element.

RootContext(JspContext) - Constructor for class org.apache.commons.scxml.env.jsp.RootContext

Constructor.

S

SCInstance - class org.apache.commons.scxml.SCInstance.

The SCInstance performs book-keeping functions for a particular execution of a state chart represented by a SCXML object.

SCXML - class org.apache.commons.scxml.model.SCXML.

The class in this SCXML object model that corresponds to the <scxml> root element, and serves as the "document root".

SCXML() - Constructor for class org.apache.commons.scxml.model.SCXML

Constructor.

SCXMLDigester - class org.apache.commons.scxml.io.SCXMLDigester.

The SCXMLDigester provides the ability to digest a SCXML document into the Java object model provided in the model package.

SCXMLDigester.DigestSrcAttributeRule - class org.apache.commons.scxml.io.SCXMLDigester.DigestSrcAttributeRule.

Custom digestion rule for external sources, that is, the src attribute of the <state> element.

SCXMLDigester.DigestSrcAttributeRule(List, PathResolver) - Constructor for class org.apache.commons.scxml.io.SCXMLDigester.DigestSrcAttributeRule

Constructor.

SCXMLDigester.ParseDataRule - class org.apache.commons.scxml.io.SCXMLDigester.ParseDataRule.

Custom digestion rule for parsing bodies of <data> elements.

SCXMLDigester.ParseDataRule(PathResolver) - Constructor for class org.apache.commons.scxml.io.SCXMLDigester.ParseDataRule

Constructor.

SCXMLDigester.ParseExternalContentRule - class org.apache.commons.scxml.io.SCXMLDigester.ParseExternalContentRule.

Custom digestion rule for parsing bodies of ExternalContent elements.

SCXMLDigester.ParseExternalContentRule() - Constructor for class org.apache.commons.scxml.io.SCXMLDigester.ParseExternalContentRule

Constructor.

SCXMLDigester.SetExecutableParentRule - class org.apache.commons.scxml.io.SCXMLDigester.SetExecutableParentRule.

Custom digestion rule for setting Executable parent of Action elements.

SCXMLDigester.SetExecutableParentRule() - Constructor for class org.apache.commons.scxml.io.SCXMLDigester.SetExecutableParentRule

Constructor.

SCXMLDigester.SetPathResolverRule - class org.apache.commons.scxml.io.SCXMLDigester.SetPathResolverRule.

Custom digestion rule for setting PathResolver for runtime retrieval.

SCXMLDigester.SetPathResolverRule(PathResolver) - Constructor for class org.apache.commons.scxml.io.SCXMLDigester.SetPathResolverRule

Constructor.

SCXMLDigester.UpdateFinalizeRule - class org.apache.commons.scxml.io.SCXMLDigester.UpdateFinalizeRule.

Custom digestion rule for setting state parent of finalize.

SCXMLDigester.UpdateFinalizeRule() - Constructor for class org.apache.commons.scxml.io.SCXMLDigester.UpdateFinalizeRule

SCXMLDigester.UpdateModelRule - class org.apache.commons.scxml.io.SCXMLDigester.UpdateModelRule.

Custom digestion rule for establishing necessary associations of this TransitionTarget with the root SCXML object.

SCXMLDigester.UpdateModelRule(SCXML) - Constructor for class org.apache.commons.scxml.io.SCXMLDigester.UpdateModelRule

Constructor.

SCXMLExecutor - class org.apache.commons.scxml.SCXMLExecutor.

The SCXML "engine" that executes SCXML documents.

SCXMLExecutor() - Constructor for class org.apache.commons.scxml.SCXMLExecutor

Convenience constructor.

SCXMLExecutor(Evaluator, EventDispatcher, ErrorReporter) - Constructor for class org.apache.commons.scxml.SCXMLExecutor

Constructor.

SCXMLExecutor(Evaluator, EventDispatcher, ErrorReporter, SCXMLSemantics) - Constructor for class org.apache.commons.scxml.SCXMLExecutor

Constructor.

SCXMLExpressionException - exception org.apache.commons.scxml.SCXMLExpressionException.

Exception thrown when a malformed expression is encountered during evaluation of an expression in a SCXML document.

SCXMLExpressionException() - Constructor for class org.apache.commons.scxml.SCXMLExpressionException

SCXMLExpressionException(String) - Constructor for class org.apache.commons.scxml.SCXMLExpressionException

SCXMLExpressionException(String, Throwable) - Constructor for class org.apache.commons.scxml.SCXMLExpressionException

SCXMLExpressionException(Throwable) - Constructor for class org.apache.commons.scxml.SCXMLExpressionException

SCXMLHelper - class org.apache.commons.scxml.SCXMLHelper.

Helper class, all methods static final.

SCXMLListener - interface org.apache.commons.scxml.SCXMLListener.

Listener interface for observable entities in the SCXML model.

SCXMLSemantics - interface org.apache.commons.scxml.SCXMLSemantics.

The purpose of this interface is to separate the interpretation algorithm from the SCXMLExecutor and therefore make it pluggable.

SCXMLSemanticsImpl - class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl.

This class encapsulates a particular SCXML semantics, that is, a particular semantic interpretation of Harel Statecharts, which aligns mostly with W3C SCXML July 5 public draft (that is, UML 1.5).

SCXMLSemanticsImpl() - Constructor for class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

SCXMLSerializer - class org.apache.commons.scxml.io.SCXMLSerializer.

Utility class for serializing the Commons SCXML Java object model.

seedTargetSet(Set, List, ErrorReporter) - Method in class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

Populate the target set.

Send - class org.apache.commons.scxml.model.Send.

The class in this SCXML object model that corresponds to the <send> SCXML element.

Send() - Constructor for class org.apache.commons.scxml.model.Send

Constructor.

send(String, String, String, String, Map, Object, long, List) - Method in interface org.apache.commons.scxml.EventDispatcher

Send this message to the target.

send(String, String, String, String, Map, Object, long, List) - Method in class org.apache.commons.scxml.env.SimpleDispatcher

serialize(SCXML) - Static method in class org.apache.commons.scxml.io.SCXMLSerializer

Serialize this SCXML object (primarily for debugging).

serializeActions(StringBuffer, List, String) - Static method in class org.apache.commons.scxml.io.SCXMLSerializer

Serialize this List of actions.

serializeDatamodel(StringBuffer, Datamodel, String) - Static method in class org.apache.commons.scxml.io.SCXMLSerializer

Serialize this Datamodel object.

serializeHistory(StringBuffer, List, String) - Static method in class org.apache.commons.scxml.io.SCXMLSerializer

Serialize the History.

serializeIf(StringBuffer, If, String) - Static method in class org.apache.commons.scxml.io.SCXMLSerializer

Serialize this If object.

serializeInitial(StringBuffer, Initial, String) - Static method in class org.apache.commons.scxml.io.SCXMLSerializer

Serialize this Initial object.

serializeInvoke(StringBuffer, Invoke, String) - Static method in class org.apache.commons.scxml.io.SCXMLSerializer

Serialize this Invoke object.

serializeOnEntry(StringBuffer, TransitionTarget, String) - Static method in class org.apache.commons.scxml.io.SCXMLSerializer

Serialize this OnEntry object.

serializeOnExit(StringBuffer, TransitionTarget, String) - Static method in class org.apache.commons.scxml.io.SCXMLSerializer

Serialize this OnExit object.

serializeParallel(StringBuffer, Parallel, String) - Static method in class org.apache.commons.scxml.io.SCXMLSerializer

Serialize this Parallel object.

serializeSend(StringBuffer, Send, String) - Static method in class org.apache.commons.scxml.io.SCXMLSerializer

Serialize this Send object.

serializeState(StringBuffer, State, String) - Static method in class org.apache.commons.scxml.io.SCXMLSerializer

Serialize this State object.

serializeTarget(StringBuffer, Transition, String) - Static method in class org.apache.commons.scxml.io.SCXMLSerializer

Serialize this Transition's Target.

serializeTransition(StringBuffer, Transition, String) - Static method in class org.apache.commons.scxml.io.SCXMLSerializer

Serialize this Transition object.

ServletContextResolver - class org.apache.commons.scxml.env.servlet.ServletContextResolver.

A wrapper around ServletContext that implements PathResolver.

ServletContextResolver(ServletContext) - Constructor for class org.apache.commons.scxml.env.servlet.ServletContextResolver

Constructor.

SessionContext - class org.apache.commons.scxml.env.faces.SessionContext.

A Faces Session Context.

SessionContext(FacesContext) - Constructor for class org.apache.commons.scxml.env.faces.SessionContext

Constructor.

SessionContext(FacesContext, Context) - Constructor for class org.apache.commons.scxml.env.faces.SessionContext

Constructor.

set(String, Object) - Method in interface org.apache.commons.scxml.Context

Assigns a new value to an existing variable or creates a new one.

set(String, Object) - Method in class org.apache.commons.scxml.env.SimpleContext

Assigns a new value to an existing variable or creates a new one.

setAfterStatus(Status) - Method in class org.apache.commons.scxml.Step

setBeforeStatus(Status) - Method in class org.apache.commons.scxml.Step

setCond(String) - Method in class org.apache.commons.scxml.model.If

Set the conditional expression.

setCond(String) - Method in class org.apache.commons.scxml.model.ElseIf

Set the conditional expression.

setCond(String) - Method in class org.apache.commons.scxml.model.Transition

Set the guard condition.

setDatamodel(Datamodel) - Method in class org.apache.commons.scxml.model.TransitionTarget

Set the data model for this transition target.

setDatamodel(Datamodel) - Method in class org.apache.commons.scxml.model.SCXML

Set the data model at document root.

setDelay(String) - Method in class org.apache.commons.scxml.model.Send

Set the delay.

setDone(boolean) - Method in class org.apache.commons.scxml.model.State

Update the done property, which is set if this is a parallel state, and one its final states is active.

setErrorReporter(ErrorReporter) - Method in class org.apache.commons.scxml.SCXMLExecutor

Set the environment specific error reporter.

setEvaluator(Evaluator) - Method in class org.apache.commons.scxml.SCXMLExecutor

Set the expression evaluator.

setEvent(String) - Method in class org.apache.commons.scxml.model.Send

Get the event to send.

setEvent(String) - Method in class org.apache.commons.scxml.model.Transition

Set the event that will trigger this transition (pending evaluation of the guard condition in favor).

setEventdispatcher(EventDispatcher) - Method in class org.apache.commons.scxml.SCXMLExecutor

Set the event dispatcher.

setExpr(String) - Method in class org.apache.commons.scxml.model.Assign

Set the expr that will evaluate to the new value.

setExpr(String) - Method in class org.apache.commons.scxml.model.Exit

Set the expression.

setExpr(String) - Method in class org.apache.commons.scxml.model.Var

Set the expression that evaluates to the initial value of the variable.

setExpr(String) - Method in class org.apache.commons.scxml.model.Log

Set the log expression.

setExpr(String) - Method in class org.apache.commons.scxml.model.Param

Set the expression for this param value.

setExpr(String) - Method in class org.apache.commons.scxml.model.Data

Set the expression that evaluates to the value of this data instance.

setExternalNodes(List) - Method in class org.apache.commons.scxml.model.Send

Set the list of external namespaced child nodes.

setFinalize(Finalize) - Method in class org.apache.commons.scxml.model.Invoke

Set the Finalize for this Invoke.

setHints(String) - Method in class org.apache.commons.scxml.model.Send

Set the hints for this <send> element.

setId(String) - Method in class org.apache.commons.scxml.model.TransitionTarget

Set the identifier for this transition target.

setInitial(Initial) - Method in class org.apache.commons.scxml.model.State

Set the initial state.

setInitialState(State) - Method in class org.apache.commons.scxml.model.SCXML

Set the initial State.

setInitialstate(String) - Method in class org.apache.commons.scxml.model.SCXML

Set the ID of the initial state.

setInvoke(Invoke) - Method in class org.apache.commons.scxml.model.State

Set the Invoke child.

setInvoker(TransitionTarget, Invoker) - Method in class org.apache.commons.scxml.SCInstance

Set the Invoker for this TransitionTarget.

setIsFinal(boolean) - Method in class org.apache.commons.scxml.model.State

Set whether this is a "final" state.

setLabel(String) - Method in class org.apache.commons.scxml.model.Log

Set the log label.

setLastConfiguration(History, Set) - Method in class org.apache.commons.scxml.SCInstance

Set the last configuration for this history.

setLocal(String, Object) - Method in interface org.apache.commons.scxml.Context

Assigns a new value to an existing variable or creates a new one.

setLocal(String, Object) - Method in class org.apache.commons.scxml.env.SimpleContext

Assigns a new value to an existing variable or creates a new one.

setLocation(String) - Method in class org.apache.commons.scxml.model.Assign

Set the location for a previously defined XML data tree.

setLog(Log) - Method in class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

Set the log used by this SCXMLSemantics instance.

setLog(Log) - Method in class org.apache.commons.scxml.env.AbstractStateMachine

Set the log for this class.

setLog(Log) - Method in class org.apache.commons.scxml.env.SimpleContext

Set the log used by this Context instance.

setLog(Log) - Method in class org.apache.commons.scxml.env.jsp.ELEvaluator

Set the log used by this Evaluator instance.

setName(String) - Method in class org.apache.commons.scxml.model.Assign

Get the variable to be assigned a new value.

setName(String) - Method in class org.apache.commons.scxml.model.Var

Set the name of the (new) variable.

setName(String) - Method in class org.apache.commons.scxml.model.Param

Set the name for this param.

setName(String) - Method in class org.apache.commons.scxml.model.Data

Set the name.

setNamelist(String) - Method in class org.apache.commons.scxml.model.Send

Set the namelist.

setNamelist(String) - Method in class org.apache.commons.scxml.model.Exit

Set the namelist.

setNext(String) - Method in class org.apache.commons.scxml.model.Transition

Set the transition target by specifying its ID.

setNode(Node) - Method in class org.apache.commons.scxml.model.Data

Set the XML data tree.

setNodeValue(Node, String) - Static method in class org.apache.commons.scxml.SCXMLHelper

Set node value, depending on its type, from a String.

setOnEntry(OnEntry) - Method in class org.apache.commons.scxml.model.TransitionTarget

Set the onentry property.

setOnExit(OnExit) - Method in class org.apache.commons.scxml.model.TransitionTarget

Set the onexit property.

setParallel(Parallel) - Method in class org.apache.commons.scxml.model.State

Set the Parallel child.

setParent(Executable) - Method in class org.apache.commons.scxml.model.Action

Set the Executable parent.

setParent(TransitionTarget) - Method in class org.apache.commons.scxml.model.Executable

Set the TransitionTarget parent.

setParent(TransitionTarget) - Method in class org.apache.commons.scxml.model.TransitionTarget

Set the parent TransitionTarget.

setParentStateId(String) - Method in class org.apache.commons.scxml.invoke.SimpleSCXMLInvoker

Set the state ID of the owning state for the <invoke>. Implementations must use this ID for constructing the event name for the special "done" event (and optionally, for other event names as well)..

setParentStateId(String) - Method in interface org.apache.commons.scxml.invoke.Invoker

Set the state ID of the owning state for the <invoke>.

setPathResolver(PathResolver) - Method in class org.apache.commons.scxml.model.Assign

Set the PathResolver.

setPathResolver(PathResolver) - Method in interface org.apache.commons.scxml.model.PathResolverHolder

Set the PathResolver to use.

setPathResolver(PathResolver) - Method in class org.apache.commons.scxml.model.Invoke

Set the PathResolver.

setRootContext(Context) - Method in class org.apache.commons.scxml.SCXMLExecutor

Set the root context for this execution.

setSCInstance(SCInstance) - Method in class org.apache.commons.scxml.invoke.SimpleSCXMLInvoker

Set the "context" of the parent state machine, which provides the channel..

setSCInstance(SCInstance) - Method in interface org.apache.commons.scxml.invoke.Invoker

Set the "context" of the parent state machine, which provides the channel.

setSendid(String) - Method in class org.apache.commons.scxml.model.Send

Set the identifier for this <send> element.

setSendid(String) - Method in class org.apache.commons.scxml.model.Cancel

Set the ID of the send message that should be cancelled.

setSrc(String) - Method in class org.apache.commons.scxml.model.Assign

Set the source where the new XML instance for this location exists.

setSrc(String) - Method in class org.apache.commons.scxml.model.Data

Set the URL where the XML data tree resides.

setSrc(String) - Method in class org.apache.commons.scxml.model.Invoke

Set the URL for the external service.

setSrcexpr(String) - Method in class org.apache.commons.scxml.model.Invoke

Set the expression that evaluates to the source URL for the external service.

setStateMachine(SCXML) - Method in class org.apache.commons.scxml.SCXMLExecutor

Set the state machine to be executed.

setSuperStep(boolean) - Method in class org.apache.commons.scxml.SCXMLExecutor

Set the super step.

setTarget(String) - Method in class org.apache.commons.scxml.model.Send

Set the target for this <send> element.

setTarget(TransitionTarget) - Method in class org.apache.commons.scxml.model.Transition

Set the transition target.

setTargettype(String) - Method in class org.apache.commons.scxml.model.Send

Set the target type for this <send> element.

setTargettype(String) - Method in class org.apache.commons.scxml.model.Invoke

Set the target type for this <invoke> element.

setTransition(Transition) - Method in class org.apache.commons.scxml.model.Initial

Set the initial transition.

setTransition(Transition) - Method in class org.apache.commons.scxml.model.History

Set the transition.

setType(String) - Method in class org.apache.commons.scxml.model.History

This method is invoked by XML digester when parsing SCXML markup.

setVariableResolver(VariableResolver) - Method in class org.apache.commons.scxml.env.jsp.RootContext

Set the VariableResolver associated with this root context.

setVars(Map) - Method in class org.apache.commons.scxml.env.SimpleContext

Set the variables map.

setVars(Map) - Method in class org.apache.commons.scxml.env.jexl.JexlContext

Set the variables map.

setVersion(String) - Method in class org.apache.commons.scxml.model.SCXML

Set the SCXML document version.

setXmlns(String) - Method in class org.apache.commons.scxml.model.SCXML

Set the xmlns of this SCXML document.

SIGNAL_EVENT - Static variable in class org.apache.commons.scxml.TriggerEvent

SIGNAL_EVENT.

SimpleContext - class org.apache.commons.scxml.env.SimpleContext.

Simple Context wrapping a map of variables.

SimpleContext() - Constructor for class org.apache.commons.scxml.env.SimpleContext

Constructor.

SimpleContext(Context) - Constructor for class org.apache.commons.scxml.env.SimpleContext

Constructor.

SimpleContext(Context, Map) - Constructor for class org.apache.commons.scxml.env.SimpleContext

Constructor.

SimpleContext(Map) - Constructor for class org.apache.commons.scxml.env.SimpleContext

Constructor.

SimpleDispatcher - class org.apache.commons.scxml.env.SimpleDispatcher.

Trivial EventDispatcher implementation.

SimpleDispatcher() - Constructor for class org.apache.commons.scxml.env.SimpleDispatcher

Constructor.

SimpleErrorHandler - class org.apache.commons.scxml.env.SimpleErrorHandler.

Custom error handler that logs the parsing errors in the SCXML document.

SimpleErrorHandler() - Constructor for class org.apache.commons.scxml.env.SimpleErrorHandler

Constructor.

SimpleErrorReporter - class org.apache.commons.scxml.env.SimpleErrorReporter.

Custom error reporter that log execution errors.

SimpleErrorReporter() - Constructor for class org.apache.commons.scxml.env.SimpleErrorReporter

Constructor.

SimpleSCXMLInvoker - class org.apache.commons.scxml.invoke.SimpleSCXMLInvoker.

A simple Invoker for SCXML documents.

SimpleSCXMLInvoker() - Constructor for class org.apache.commons.scxml.invoke.SimpleSCXMLInvoker

SimpleSCXMLListener - class org.apache.commons.scxml.env.SimpleSCXMLListener.

Simple SCXML Listener that logs execution.

SimpleSCXMLListener() - Constructor for class org.apache.commons.scxml.env.SimpleSCXMLListener

StandaloneElExpressions - class org.apache.commons.scxml.test.StandaloneElExpressions.

Standalone SCXML interpreter, useful for command-line testing and debugging, where expressions are JSP 2.0 EL expressions.

StandaloneJexlExpressions - class org.apache.commons.scxml.test.StandaloneJexlExpressions.

Standalone SCXML interpreter, useful for command-line testing and debugging, where expressions are JEXL expressions.

StandaloneUtils - class org.apache.commons.scxml.test.StandaloneUtils.

Utility methods used by command line SCXML execution, useful for debugging.

State - class org.apache.commons.scxml.model.State.

The class in this SCXML object model that corresponds to the <state> SCXML element.

State() - Constructor for class org.apache.commons.scxml.model.State

Constructor.

Status - class org.apache.commons.scxml.Status.

The encapsulation of the current state of a state machine.

Status() - Constructor for class org.apache.commons.scxml.Status

Constructor.

Step - class org.apache.commons.scxml.Step.

A logical unit of progression in the execution of a SCXML model.

Step() - Constructor for class org.apache.commons.scxml.Step

Constructor.

Step(Collection, Status) - Constructor for class org.apache.commons.scxml.Step

subtypeOf(Class, Class) - Static method in class org.apache.commons.scxml.SCXMLHelper

Whether the first argument is a subtype of the second.

T

TIME_EVENT - Static variable in class org.apache.commons.scxml.TriggerEvent

TIME_EVENT.

toString() - Method in class org.apache.commons.scxml.TriggerEvent

Returns a string representation of this TriggerEvent object.

Tracer - class org.apache.commons.scxml.env.Tracer.

A simple tracer connected to Apache Commons Logging.

Tracer() - Constructor for class org.apache.commons.scxml.env.Tracer

Constructor.

Transition - class org.apache.commons.scxml.model.Transition.

The class in this SCXML object model that corresponds to the <transition> SCXML element.

Transition() - Constructor for class org.apache.commons.scxml.model.Transition

Constructor.

TransitionTarget - class org.apache.commons.scxml.model.TransitionTarget.

An abstract base class for elements in SCXML that can serve as a <target> for a <transition>, such as State or Parallel.

TransitionTarget() - Constructor for class org.apache.commons.scxml.model.TransitionTarget

Constructor.

transToString(TransitionTarget, TransitionTarget, Transition) - Static method in class org.apache.commons.scxml.env.LogUtils

Create a human readable log view of this transition.

TriggerEvent - class org.apache.commons.scxml.TriggerEvent.

A class representing an event.

TriggerEvent(String, int) - Constructor for class org.apache.commons.scxml.TriggerEvent

Constructor.

TriggerEvent(String, int, Object) - Constructor for class org.apache.commons.scxml.TriggerEvent

Constructor.

triggerEvent(TriggerEvent) - Method in class org.apache.commons.scxml.SCXMLExecutor

Convenience method when only one event needs to be triggered.

triggerEvents(TriggerEvent[]) - Method in class org.apache.commons.scxml.SCXMLExecutor

The worker method.

U

UNDEFINED_VARIABLE - Static variable in interface org.apache.commons.scxml.ErrorReporter

A variable referred to by assign name attribute is undefined.

UNKNOWN_ACTION - Static variable in interface org.apache.commons.scxml.ErrorReporter

Unknown action - unsupported executable content.

unregisterInvokerClass(String) - Method in class org.apache.commons.scxml.SCXMLExecutor

Remove the Invoker registered for this target type (if there is one registered).

updateHistoryStates(Step, ErrorReporter, SCInstance) - Method in interface org.apache.commons.scxml.SCXMLSemantics

Go over the exit list and update history information for relevant states.

updateHistoryStates(Step, ErrorReporter, SCInstance) - Method in class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

Go over the exit list and update history information for relevant states.

updateSCXML(SCXML) - Static method in class org.apache.commons.scxml.io.SCXMLDigester

Update the SCXML object model and make it SCXMLExecutor ready.

URLResolver - class org.apache.commons.scxml.env.URLResolver.

A PathResolver implementation that resolves against a base URL.

URLResolver(URL) - Constructor for class org.apache.commons.scxml.env.URLResolver

Constructor.

V

Var - class org.apache.commons.scxml.model.Var.

The class in this SCXML object model that corresponds to the <var> SCXML element.

Var() - Constructor for class org.apache.commons.scxml.model.Var

Constructor.

W

warning(SAXParseException) - Method in class org.apache.commons.scxml.env.SimpleErrorHandler

warning(SAXParseException) - Method in class org.apache.commons.scxml.env.Tracer

X

XMLNS - Static variable in class org.apache.commons.scxml.model.SCXML

The SCXML XMLNS.

A B C D E F G H I J L M N O P R S T U V W X