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

A

AbstractSCXMLListener - Class in org.apache.commons.scxml.env

An abstract adapter class for the SXCMLListener interface.

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

AbstractStateMachine - Class in org.apache.commons.scxml.env

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

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

Convenience constructor, object instantiation incurs parsing cost.

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

Primary constructor, object instantiation incurs parsing cost.

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

Convenience constructor.

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

Primary constructor.

AbstractStateMachine.EntryListener - Class in org.apache.commons.scxml.env

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

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

Action - Class in org.apache.commons.scxml.model

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.Executable

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

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

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

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

Add a child.

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

Add an immediate child target of the SCXML root.

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

Deprecated. Use State.addChild(TransitionTarget) instead.

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

Add a child transition target.

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

Add a Data.

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

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(TransitionTarget, SCXMLListener) - Method in class org.apache.commons.scxml.SCXMLExecutor

Add a listener to this transition target.

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

Add a listener to this transition.

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

Deprecated. Use addChild(TransitionTarget) instead.

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

Deprecated. Use addChild(TransitionTarget) instead.

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 in org.apache.commons.scxml.model

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.DigestSrcAttributeRule

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

Builtin - Class in org.apache.commons.scxml

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(String) - Method in class org.apache.commons.scxml.env.SimpleDispatcher

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

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

Cancel the specified send message.

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

Cancel this invocation.

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

Cancel this invocation..

Cancel - Class in org.apache.commons.scxml.model

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

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

Constructor.

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 in org.apache.commons.scxml

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

CustomAction - Class in org.apache.commons.scxml.model

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(Map, 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.

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

Deprecated. Use Builtin.data(Map,Object,String) instead

Data - Class in org.apache.commons.scxml.model

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.

Datamodel - Class in org.apache.commons.scxml.model

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(Map, 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.

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

Deprecated. Use Builtin.dataNode(Map,Object,String) instead

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(URL, ErrorHandler) - Static method in class org.apache.commons.scxml.io.SCXMLDigester

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

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

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

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

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

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

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

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

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

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

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

E

ELContext - Class in org.apache.commons.scxml.env.jsp

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 in org.apache.commons.scxml.env.jsp

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 in org.apache.commons.scxml.model

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 in org.apache.commons.scxml.model

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.ParseDataRule

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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(SAXParseException) - Method in class org.apache.commons.scxml.env.SimpleErrorHandler

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

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

ERROR_EVENT.

ErrorConstants - Class in org.apache.commons.scxml.semantics

Errors reported by the default SCXMLSemantics implementation.

ErrorReporter - Interface in org.apache.commons.scxml

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 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.

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

Evaluate an expression.

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

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

Evaluate a condition.

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

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

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

Evaluator - Interface in org.apache.commons.scxml

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

Event - Class in org.apache.commons.scxml.model

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

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

Constructor.

EventDispatcher - Interface in org.apache.commons.scxml

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 in org.apache.commons.scxml.model

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.Action

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.Cancel

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.Event

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.If

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.Send

Execute this action instance.

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

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 in org.apache.commons.scxml.model

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

Deprecated. Use ErrorConstants.EXPRESSION_ERROR instead.

EXPRESSION_ERROR - Static variable in class org.apache.commons.scxml.semantics.ErrorConstants

An expression language error.

ExternalContent - Interface in org.apache.commons.scxml.model

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

Final - Class in org.apache.commons.scxml.model

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

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

Default no-args constructor for Digester.

Finalize - Class in org.apache.commons.scxml.model

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(TransitionTarget, TransitionTarget) - Method in class org.apache.commons.scxml.NotificationRegistry

Inform all relevant listeners that a TransitionTarget has been entered.

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

Inform all relevant listeners that a TransitionTarget has been entered.

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

Inform all relevant listeners that a TransitionTarget has been exited.

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

Inform all relevant listeners that a TransitionTarget has been exited.

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

Inform all relevant listeners of a transition that has occured.

fireOnTransition(SCXML, 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.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.

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

Get the value of this variable; delegating to parent.

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.Executable

Get the executable actions contained in this Executable.

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

Get the executable actions contained in this <if>.

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.Parallel

Get the set of child transition targets (may be empty).

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

Get the immediate child targets of the SCXML root.

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.ElseIf

Get the conditional expression.

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

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.SCXML

Get the data model placed at document root.

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

Get the data model for this transition target.

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.SCInstance

Get the Evaluator.

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

Get the expression evaluator in use.

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.env.SimpleScheduler

Get the executor we're attached to.

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.Data

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

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

Get the expression.

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.Var

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

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

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

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

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

Get the list of external namespaced child nodes.

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.TransitionTarget

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

Deprecated. Use getInitialTarget() instead. Returns null if the initial target is a Parallel.

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

Get the ID of the initial state.

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

Get the initial TransitionTarget.

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

Deprecated. Use State.isFinal() instead

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.env.AbstractStateMachine

Get the log for this class.

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

Get the log used by this Evaluator instance.

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.SimpleScheduler

Get the log instance.

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

Get the log used by this SCXMLSemantics instance.

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.Data

Get the name.

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

Get the event name.

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.Var

Get the name of the (new) variable.

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

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

Get the namelist.

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

Get the namelist.

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

Get the XML namespaces at this action node in the SCXML document.

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

Get the XML namespaces at this action node in the SCXML document.

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

Get the XML namespaces at this action node in the SCXML document.

getNamespaces() - Method in interface org.apache.commons.scxml.model.NamespacePrefixesHolder

Get the map of namespaces, with keys as prefixes and values as URIs.

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

Get the XML namespaces at this action node in the SCXML document.

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

Get the XML namespaces at this action node in the SCXML document.

getNamespacesKey() - Static method in class org.apache.commons.scxml.model.Action

Return the key under which the current document namespaces are saved in the parent state's context.

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

Deprecated. <parallel> no longer needs an enclosing <state> element.

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

Deprecated. Remove in v1.0, use params() instead

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

Deprecated. Use getPaths() instead.

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

Get the PathResolver.

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

Get the PathResolver.

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

Get the PathResolver.

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

Get the path(s) of this transiton.

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 class org.apache.commons.scxml.env.servlet.ServletContextResolver

Retrieve the PathResolver rooted at the given path.

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

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

Get a PathResolver rooted at this context sensitive path.

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

Get the root context.

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

Get the root context for this execution.

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

Deprecated. A transition may have multiple targets, use getRuntimeTargets() instead.

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

Get the list of runtime transition target, which always contains atleast one 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.Cancel

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

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

Get the identifier for this <send> element.

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() - Static method in class org.apache.commons.scxml.env.AbstractStateMachine

Deprecated. Returns null, use getEngine().getStateMachine() instead

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

Get the state machine that is being executed.

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

Deprecated. Use getChildren() instead.

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

Deprecated. Use getChildren() instead.

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

Get the states configuration (leaf only).

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

Deprecated. A transition may have multiple targets, use getTargets() instead.

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

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

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

Get the list of transition targets (may be an empty list).

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

Get the target type for this <invoke> element.

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

Get the target type for this <send> element.

getTimers() - Method in class org.apache.commons.scxml.env.SimpleScheduler

Get the current timers.

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

Get the transition.

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

Get the initial transition.

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

Deprecated. Use State.getTransitionsList() instead

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.

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

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

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.jexl.JexlContext

Get the variables map.

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

Get the Map of all local variables in this Context.

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.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.

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

Check if this variable exists, delegating to parent.

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.TransitionTarget

Does this state have a history pseudo state.

History - Class in org.apache.commons.scxml.model

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 in org.apache.commons.scxml.model

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

Deprecated. Use ErrorConstants.ILLEGAL_CONFIG instead.

ILLEGAL_CONFIG - Static variable in class org.apache.commons.scxml.semantics.ErrorConstants

Illegal state machine configuration.

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

Deprecated. Use ErrorConstants.ILLEGAL_INITIAL instead.

ILLEGAL_INITIAL - Static variable in class org.apache.commons.scxml.semantics.ErrorConstants

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 in org.apache.commons.scxml.model

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(String) - Method in class org.apache.commons.scxml.env.AbstractStateMachine

Invoke the no argument method with the following name.

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

Begin this invocation.

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

Begin this invocation..

Invoke - Class in org.apache.commons.scxml.model

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.

Invoker - Interface in org.apache.commons.scxml.invoke

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

InvokerException - Exception in org.apache.commons.scxml.invoke

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

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

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

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

InvokerException(String, Throwable) - Constructor for exception 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

Deprecated. Will be removed in v1.0, in favor of SCInstance#isDone(TransitionTarget)

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

Get the completion status for this composite TransitionTarget.

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

Check whether we have prior history.

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

Is this state a "final" state.

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

Deprecated. <parallel> now represents an orthogonal state, rather than denoting that the enclosing state is orthogonal, as it did in previous SCXML WDs.

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 in org.apache.commons.scxml.env.jexl

JEXL Context implementation for Commons SCXML.

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

Constructor.

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

Constructor with initial vars.

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

Constructor with parent context.

JexlEvaluator - Class in org.apache.commons.scxml.env.jexl

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 in org.apache.commons.scxml.model

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 in org.apache.commons.scxml.env

Helper methods for Common