Serialized Form

Package org.apache.commons.scxml

Class org.apache.commons.scxml.Builtin extends java.lang.Object implements Serializable

serialVersionUID: 1L

Class org.apache.commons.scxml.NotificationRegistry extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

regs

java.util.Map regs

The Map of all listeners keyed by Observable.

Class org.apache.commons.scxml.SCInstance extends java.lang.Object implements Serializable

serialVersionUID: 2L

Serialized Fields

notificationRegistry

NotificationRegistry notificationRegistry

The notification registry.

contexts

java.util.Map contexts

The Map of Contexts per TransitionTarget.

histories

java.util.Map histories

The Map of last known configurations per History.

completions

java.util.Map completions

Map for recording the run to completion status of composite states.

invokerClasses

java.util.Map invokerClasses

The Invoker classes Map, keyed by <invoke> target types (specified using "targettype" attribute).

invokers

java.util.Map invokers

The Map of active Invokers, keyed by (leaf) States.

evaluator

Evaluator evaluator

The evaluator for expressions.

rootContext

Context rootContext

The root context.

executor

SCXMLExecutor executor

The owning state machine executor.

Class org.apache.commons.scxml.SCXMLExecutor extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

log

org.apache.commons.logging.Log log

The Logger for the SCXMLExecutor.

stateMachine

SCXML stateMachine

The stateMachine being executed.

currentStatus

Status currentStatus

The current status of the stateMachine.

eventdispatcher

EventDispatcher eventdispatcher

The event dispatcher to interface with external documents etc.

errorReporter

ErrorReporter errorReporter

The environment specific error reporter.

superStep

boolean superStep

Run-to-completion.

semantics

SCXMLSemantics semantics

Interpretation semantics.

scInstance

SCInstance scInstance

The SCInstance.

Class org.apache.commons.scxml.SCXMLExpressionException extends java.lang.Exception implements Serializable

serialVersionUID: 1L

Class org.apache.commons.scxml.Status extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

states

java.util.Set states

The states that are currently active.

events

java.util.Collection events

The events that are currently queued.

Package org.apache.commons.scxml.env

Class org.apache.commons.scxml.env.SimpleContext extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

log

org.apache.commons.logging.Log log

Implementation independent log category.

parent

Context parent

The parent Context to this Context.

vars

java.util.Map vars

The Map of variables and their values in this Context.

Class org.apache.commons.scxml.env.SimpleDispatcher extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

log

org.apache.commons.logging.Log log

Implementation independent log category.

Class org.apache.commons.scxml.env.SimpleErrorHandler extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

log

org.apache.commons.logging.Log log

Log.

Class org.apache.commons.scxml.env.SimpleErrorReporter extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

log

org.apache.commons.logging.Log log

Log.

Class org.apache.commons.scxml.env.SimpleScheduler extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

log

org.apache.commons.logging.Log log

Log instance.

timers

java.util.Map timers

The Map of active Timers, keyed by <send> element ids.

executor

SCXMLExecutor executor

The state chart execution instance we schedule events for.

Class org.apache.commons.scxml.env.SimpleSCXMLListener extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

log

org.apache.commons.logging.Log log

Log.

Class org.apache.commons.scxml.env.Tracer extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

errHandler

org.xml.sax.ErrorHandler errHandler

ErrorHandler delegate.

errReporter

ErrorReporter errReporter

ErrorReporter delegate.

scxmlListener

SCXMLListener scxmlListener

SCXMLListener delegate.

Class org.apache.commons.scxml.env.URLResolver extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

log

org.apache.commons.logging.Log log

Implementation independent log category.

baseURL

java.net.URL baseURL

The base URL to resolve against.

Package org.apache.commons.scxml.env.faces

Class org.apache.commons.scxml.env.faces.SessionContext extends SimpleContext implements Serializable

serialVersionUID: 1L

Serialized Fields

sessionMap

java.util.Map sessionMap

The map of session scoped variables.

Package org.apache.commons.scxml.env.jexl

Class org.apache.commons.scxml.env.jexl.JexlContext extends SimpleContext implements Serializable

serialVersionUID: 1L

Class org.apache.commons.scxml.env.jexl.JexlEvaluator extends java.lang.Object implements Serializable

serialVersionUID: 1L

Package org.apache.commons.scxml.env.jsp

Class org.apache.commons.scxml.env.jsp.ELContext extends SimpleContext implements Serializable

serialVersionUID: 1L

Class org.apache.commons.scxml.env.jsp.ELEvaluator extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

log

org.apache.commons.logging.Log log

Implementation independent log category.

builtinFnMapper

javax.servlet.jsp.el.FunctionMapper builtinFnMapper

Function Mapper for SCXML builtin functions.

fnMapper

javax.servlet.jsp.el.FunctionMapper fnMapper

User provided function mapper, we delegate to this mapper if we encounter a function that is not built into SCXML.

Class org.apache.commons.scxml.env.jsp.RootContext extends ELContext implements Serializable

Serialization Methods

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException

Instances of this class are not serializable.

Throws:

java.io.IOException - Guaranteed to throw a NotSerializableException

writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException

Instances of this class are not serializable.

Throws:

java.io.IOException - Guaranteed to throw a NotSerializableException

Serialized Fields

variableResolver

javax.servlet.jsp.el.VariableResolver variableResolver

Host JSP's VariableResolver.

Package org.apache.commons.scxml.invoke

Class org.apache.commons.scxml.invoke.InvokerException extends java.lang.Exception implements Serializable

serialVersionUID: 1L

Class org.apache.commons.scxml.invoke.SimpleSCXMLInvoker extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

parentStateId

java.lang.String parentStateId

Parent state ID.

eventPrefix

java.lang.String eventPrefix

Event prefix, all events sent to the parent executor must begin with this prefix.

parentSCInstance

SCInstance parentSCInstance

Invoking document's SCInstance.

executor

SCXMLExecutor executor

The invoked state machine executor.

cancelled

boolean cancelled

Cancellation status.

Package org.apache.commons.scxml.model

Class org.apache.commons.scxml.model.Action extends java.lang.Object implements Serializable

Serialized Fields

parent

Executable parent

Link to its parent or container.

namespaces

java.util.Map namespaces

The current XML namespaces in the SCXML document for this action node, preserved for deferred XPath evaluation.

Class org.apache.commons.scxml.model.Assign extends Action implements Serializable

serialVersionUID: 1L

Serialized Fields

name

java.lang.String name

Left hand side expression evaluating to a previously defined variable.

location

java.lang.String location

Left hand side expression evaluating to a location within a previously defined XML data tree.

src

java.lang.String src

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

expr

java.lang.String expr

Expression evaluating to the new value of the variable.

pathResolver

PathResolver pathResolver

PathResolver for resolving the "src" result.

Class org.apache.commons.scxml.model.Cancel extends Action implements Serializable

serialVersionUID: 1L

Serialized Fields

sendid

java.lang.String sendid

The ID of the send message that should be cancelled.

Class org.apache.commons.scxml.model.Data extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

name

java.lang.String name

The name of this data instance, that is used as its identifier.

src

java.lang.String src

The URL to get the XML data tree from.

expr

java.lang.String expr

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

node

org.w3c.dom.Node node

The child XML data tree, parsed as a Node, cloned per execution instance.

namespaces

java.util.Map namespaces

The current XML namespaces in the SCXML document for this action node, preserved for deferred XPath evaluation. Easier than to scrape node above, given the Builtin API.

Class org.apache.commons.scxml.model.Datamodel extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

data

java.util.List data

The set of <data> elements, parsed as Elements, that are children of this <datamodel> element.

Class org.apache.commons.scxml.model.Else extends ElseIf implements Serializable

serialVersionUID: 1L

Class org.apache.commons.scxml.model.ElseIf extends Action implements Serializable

serialVersionUID: 1L

Serialized Fields

cond

java.lang.String cond

An conditional expression which can be evaluated to true or false.

Class org.apache.commons.scxml.model.Event extends Action implements Serializable

serialVersionUID: 1L

Serialized Fields

name

java.lang.String name

The name of the derived event to be generated.

Class org.apache.commons.scxml.model.Executable extends java.lang.Object implements Serializable

Serialized Fields

actions

java.util.List actions

The set of executable elements (those that inheriting from Action) that are contained in this Executable.

parent

TransitionTarget parent

The parent container, for traceability.

Class org.apache.commons.scxml.model.Exit extends Action implements Serializable

serialVersionUID: 1L

Serialized Fields

expr

java.lang.String expr

The optional expression.

namelist

java.lang.String namelist

The optional namelist.

Class org.apache.commons.scxml.model.Final extends State implements Serializable

serialVersionUID: 1L

Class org.apache.commons.scxml.model.Finalize extends Executable implements Serializable

serialVersionUID: 1L

Class org.apache.commons.scxml.model.History extends TransitionTarget implements Serializable

serialVersionUID: 1L

Serialized Fields

isDeep

boolean isDeep

Whether this is a shallow or deep history, the default is shallow.

transition

Transition transition

A conditionless transition representing the default history state and indicates the state to transition to if the parent state has never been entered before.

Class org.apache.commons.scxml.model.If extends Action implements Serializable

serialVersionUID: 1L

Serialized Fields

cond

java.lang.String cond

An conditional expression which can be evaluated to true or false.

actions

java.util.List actions

The set of executable elements (those that inheriting from Action) that are contained in this <if> element.

execute

boolean execute

The boolean value that dictates whether the particular child action should be executed.

Class org.apache.commons.scxml.model.Initial extends TransitionTarget implements Serializable

serialVersionUID: 1L

Serialized Fields

transition

Transition transition

A conditionless transition that is always enabled and will be taken as soon as the state is entered. The target of the transition must be a descendant of the parent state of initial.

Class org.apache.commons.scxml.model.Invoke extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

targettype

java.lang.String targettype

The type of target to be invoked.

src

java.lang.String src

The source URL for the external service.

srcexpr

java.lang.String srcexpr

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

params

java.util.Map params

The Map of the params to be sent to the invoked process. Remove with deprecated getParams() in 1.0

paramsList

java.util.List paramsList

The List of the params to be sent to the invoked process.

finalize

Finalize finalize

The <finalize> child, may be null.

pathResolver

PathResolver pathResolver

PathResolver for resolving the "src" or "srcexpr" result.

namespaces

java.util.Map namespaces

The current XML namespaces in the SCXML document for this action node, preserved for deferred XPath evaluation.

Class org.apache.commons.scxml.model.Log extends Action implements Serializable

serialVersionUID: 1L

Serialized Fields

expr

java.lang.String expr

An expression evaluating to a string to be logged.

label

java.lang.String label

An expression which returns string which may be used, for example, to indicate the purpose of the log.

Class org.apache.commons.scxml.model.ModelException extends java.lang.Exception implements Serializable

serialVersionUID: 1L

Class org.apache.commons.scxml.model.OnEntry extends Executable implements Serializable

serialVersionUID: 1L

Class org.apache.commons.scxml.model.OnExit extends Executable implements Serializable

serialVersionUID: 1L

Class org.apache.commons.scxml.model.Parallel extends TransitionTarget implements Serializable

serialVersionUID: 2L

Serialized Fields

children

java.util.Set children

The set of parallel state machines contained in this <parallel>.

Class org.apache.commons.scxml.model.Param extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

name

java.lang.String name

The param name.

expr

java.lang.String expr

The param expression, may be null.

namespaces

java.util.Map namespaces

The current XML namespaces in the SCXML document for this action node, preserved for deferred XPath evaluation.

Class org.apache.commons.scxml.model.Path extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

upSeg

java.util.List upSeg

The list of TransitionTargets in the "up segment".

downSeg

java.util.List downSeg

The list of TransitionTargets in the "down segment".

scope

State scope

"Lowest" state which is not being exited nor entered by the transition.

crossRegion

boolean crossRegion

Whether the path crosses region border(s).

Class org.apache.commons.scxml.model.SCXML extends java.lang.Object implements Serializable

serialVersionUID: 2L

Serialized Fields

xmlns

java.lang.String xmlns

The xmlns attribute on the root <smxml> element. This must match XMLNS above.

version

java.lang.String version

The SCXML version of this document.

initialTarget

TransitionTarget initialTarget

The initial TransitionTarget for the SCXML executor.

initialstate

java.lang.String initialstate

The initial transition target ID (used by XML Digester only).

datamodel

Datamodel datamodel

Optional property holding the data model for this SCXML document. This gets merged with the root context and potentially hides any (namesake) variables in the root context.

children

java.util.Map children

The immediate child targets of this SCXML document root.

targets

java.util.Map targets

A global map of all States and Parallels associated with this state machine, keyed by their id.

Class org.apache.commons.scxml.model.Send extends Action implements Serializable

serialVersionUID: 1L

Serialized Fields

sendid

java.lang.String sendid

The ID of the send message.

target

java.lang.String target

An expression returning the target location of the event.

targettype

java.lang.String targettype

The type of the Event I/O Processor that the event. should be dispatched to

delay

java.lang.String delay

The event is dispatched after the delay interval elapses.

hints

java.lang.String hints

The data containing information which may be used by the implementing platform to configure the event processor.

namelist

java.lang.String namelist

The namelist to the sent.

externalNodes

java.util.List externalNodes

The list of external nodes associated with this <send> element.

event

java.lang.String event

The type of event being generated.

Class org.apache.commons.scxml.model.State extends TransitionTarget implements Serializable

serialVersionUID: 2L

Serialized Fields

children

java.util.Map children

The Map containing immediate children of this State, keyed by their IDs. Incompatible with the parallel or invoke property.

parallel

Parallel parallel

The Parallel child, which defines a set of parallel substates. May occur 0 or 1 times. Incompatible with the state or invoke property.

invoke

Invoke invoke

The Invoke child, which defines an external process that should be invoked, immediately after the onentry executable content, and the transitions become candidates after the invoked process has completed its execution. May occur 0 or 1 times. Incompatible with the state or parallel property.

isFinal

boolean isFinal

Boolean property indicating whether this is a final state or not. Default value is false . Final states may not have substates or outgoing transitions.

initial

Initial initial

A child which identifies initial state for state machines that have substates.

transitions

java.util.List transitions

A list of outgoing Transitions from this state, by document order.

done

boolean done

Deprecated. Will be removed in v1.0

Applies to composite states only. If one of its final children is active, its parent is marked done. This property is reset upon re-entry.

Class org.apache.commons.scxml.model.Transition extends Executable implements Serializable

serialVersionUID: 2L

Serialized Fields

event

java.lang.String event

Property that specifies the trigger for this transition.

cond

java.lang.String cond

Optional guard condition.

targets

java.util.List targets

Optional property that specifies the new state(s) or parallel element to transition to. May be specified by reference or in-line. If multiple state(s) are specified, they must belong to the regions of the same parallel.

next

java.lang.String next

The transition target ID (used by XML Digester only).

paths

java.util.List paths

The path(s) for this transition, one per target, in the same order as targets.

See Also:

Path

namespaces

java.util.Map namespaces

The current XML namespaces in the SCXML document for this action node, preserved for deferred XPath evaluation.

Class org.apache.commons.scxml.model.TransitionTarget extends java.lang.Object implements Serializable

Serialized Fields

id

java.lang.String id

Identifier for this transition target. Other parts of the SCXML document may refer to this <state> using this ID.

onEntry

OnEntry onEntry

Optional property holding executable content to be run upon entering this transition target.

onExit

OnExit onExit

Optional property holding executable content to be run upon exiting this transition target.

datamodel

Datamodel datamodel

Optional property holding the data model for this transition target.

parent

TransitionTarget parent

The parent of this transition target (may be null, if the parent is the SCXML document root).

history

java.util.List history

List of history states owned by a given state (applies to non-leaf states).

Class org.apache.commons.scxml.model.Var extends Action implements Serializable

serialVersionUID: 1L

Serialized Fields

name

java.lang.String name

The name of the variable to be created.

expr

java.lang.String expr

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

Package org.apache.commons.scxml.semantics

Class org.apache.commons.scxml.semantics.SCXMLSemanticsImpl extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

appLog

org.apache.commons.logging.Log appLog

SCXML Logger for the application.

targetComparator

org.apache.commons.scxml.semantics.TransitionTargetComparator targetComparator

The TransitionTarget comparator.