Java Doc for SCXMLExecutor.java in » Library » Apache-commons-scxml-0.6-src » org » apache » commons » scxml » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Library » Apache commons scxml 0.6 src » org.apache.commons.scxml

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.apache.commons.scxml .SCXMLExecutor

SCXMLExecutor

public class SCXMLExecutor implements Serializable(Code)

The SCXML "engine" that executes SCXML documents. The particular semantics used by this engine for executing the SCXML are encapsulated in the SCXMLSemantics implementation that it uses.

The default implementation is org.apache.commons.scxml.semantics.SCXMLSemanticsImpl

See Also: SCXMLSemantics

Constructor Summary
public	SCXMLExecutor(Evaluator expEvaluator, EventDispatcher evtDisp, ErrorReporter errRep) Constructor.
public	SCXMLExecutor() Convenience constructor.
public	SCXMLExecutor(Evaluator expEvaluator, EventDispatcher evtDisp, ErrorReporter errRep, SCXMLSemantics semantics) Constructor.

Method Summary
public void	addListener(SCXML scxml, SCXMLListener listener) Add a listener to the document root.
public void	addListener(TransitionTarget transitionTarget, SCXMLListener listener) Add a listener to this transition target.
public void	addListener(Transition transition, SCXMLListener listener) Add a listener to this transition.
public synchronized Status	getCurrentStatus() Get the current status.
public ErrorReporter	getErrorReporter() Get the environment specific error reporter.
public Evaluator	getEvaluator() Get the expression evaluator in use.
public EventDispatcher	getEventdispatcher() Get the event dispatcher.
public Context	getRootContext() Get the root context for this execution.
SCInstance	getSCInstance() Get the state chart instance for this executor.
public SCXML	getStateMachine() Get the state machine that is being executed.
public void	go() Initiate state machine execution.
public boolean	isSuperStep() Use "super-step", default is `true` (that is, run-to-completion is default).
public void	registerInvokerClass(String targettype, Class invokerClass) Register an `Invoker` for this target type.
public void	removeListener(SCXML scxml, SCXMLListener listener) Remove this listener from the document root.
public void	removeListener(TransitionTarget transitionTarget, SCXMLListener listener) Remove this listener for this transition target.
public void	removeListener(Transition transition, SCXMLListener listener) Remove this listener for this transition.
public synchronized void	reset() Clear all state and begin from "initialstate" indicated on root SCXML element.
public void	setErrorReporter(ErrorReporter errorReporter) Set the environment specific error reporter.
public void	setEvaluator(Evaluator evaluator) Set the expression evaluator.
public void	setEventdispatcher(EventDispatcher eventdispatcher) Set the event dispatcher.
public void	setRootContext(Context rootContext) Set the root context for this execution.
public void	setStateMachine(SCXML stateMachine) Set the state machine to be executed.
public void	setSuperStep(boolean superStep) Set the super step.
public void	triggerEvent(TriggerEvent evt) Convenience method when only one event needs to be triggered.
public synchronized void	triggerEvents(TriggerEvent[] evts) The worker method.
public void	unregisterInvokerClass(String targettype) Remove the `Invoker` registered for this target type (if there is one registered).

Constructor Detail

SCXMLExecutor
public SCXMLExecutor(Evaluator expEvaluator, EventDispatcher evtDisp, ErrorReporter errRep)(Code)
	Constructor. Parameters: expEvaluator - The expression evaluator Parameters: evtDisp - The event dispatcher Parameters: errRep - The error reporter

SCXMLExecutor
public SCXMLExecutor()(Code)
	Convenience constructor.

SCXMLExecutor
public SCXMLExecutor(Evaluator expEvaluator, EventDispatcher evtDisp, ErrorReporter errRep, SCXMLSemantics semantics)(Code)
	Constructor. Parameters: expEvaluator - The expression evaluator Parameters: evtDisp - The event dispatcher Parameters: errRep - The error reporter Parameters: semantics - The SCXML semantics

Method Detail

addListener
public void addListener(SCXML scxml, SCXMLListener listener)(Code)
	Add a listener to the document root. Parameters: scxml - The document root to attach listener to. Parameters: listener - The SCXMLListener.

addListener
public void addListener(TransitionTarget transitionTarget, SCXMLListener listener)(Code)
	Add a listener to this transition target. Parameters: transitionTarget - The `TransitionTarget` toattach listener to. Parameters: listener - The SCXMLListener.

addListener
public void addListener(Transition transition, SCXMLListener listener)(Code)
	Add a listener to this transition. Parameters: transition - The `Transition` to attach listener to. Parameters: listener - The SCXMLListener.

getCurrentStatus
public synchronized Status getCurrentStatus()(Code)
	Get the current status. The current Status

getErrorReporter
public ErrorReporter getErrorReporter()(Code)
	Get the environment specific error reporter. Returns the errorReporter.

getEvaluator
public Evaluator getEvaluator()(Code)
	Get the expression evaluator in use. Evaluator The evaluator in use.

getEventdispatcher
public EventDispatcher getEventdispatcher()(Code)
	Get the event dispatcher. Returns the eventdispatcher.

getRootContext
public Context getRootContext()(Code)
	Get the root context for this execution. Context The root context.

getSCInstance
SCInstance getSCInstance()(Code)
	Get the state chart instance for this executor. The SCInstance for this executor.

getStateMachine
public SCXML getStateMachine()(Code)
	Get the state machine that is being executed. Returns the stateMachine.

go
public void go() throws ModelException(Code)
	Initiate state machine execution. throws: ModelException - in case there is a fatal SCXML objectmodel problem.

isSuperStep
public boolean isSuperStep()(Code)
	Use "super-step", default is `true` (that is, run-to-completion is default). Returns the superStep property. See Also: SCXMLExecutor.setSuperStep(boolean)

registerInvokerClass
public void registerInvokerClass(String targettype, Class invokerClass)(Code)
	Register an `Invoker` for this target type. Parameters: targettype - The target type (specified by "targettype"attribute of <invoke> tag). Parameters: invokerClass - The `Invoker` `Class`.

removeListener
public void removeListener(SCXML scxml, SCXMLListener listener)(Code)
	Remove this listener from the document root. Parameters: scxml - The document root. Parameters: listener - The SCXMLListener to be removed.

removeListener
public void removeListener(TransitionTarget transitionTarget, SCXMLListener listener)(Code)
	Remove this listener for this transition target. Parameters: transitionTarget - The `TransitionTarget`. Parameters: listener - The SCXMLListener to be removed.

removeListener
public void removeListener(Transition transition, SCXMLListener listener)(Code)
	Remove this listener for this transition. Parameters: transition - The `Transition`. Parameters: listener - The SCXMLListener to be removed.

reset
public synchronized void reset() throws ModelException(Code)
	Clear all state and begin from "initialstate" indicated on root SCXML element. throws: ModelException - in case there is a fatal SCXML objectmodel problem.

setErrorReporter
public void setErrorReporter(ErrorReporter errorReporter)(Code)
	Set the environment specific error reporter. Parameters: errorReporter - The errorReporter to set.

setEvaluator
public void setEvaluator(Evaluator evaluator)(Code)
	Set the expression evaluator. Parameters: evaluator - The evaluator to set.

setEventdispatcher
public void setEventdispatcher(EventDispatcher eventdispatcher)(Code)
	Set the event dispatcher. Parameters: eventdispatcher - The eventdispatcher to set.

setRootContext
public void setRootContext(Context rootContext)(Code)
	Set the root context for this execution. Parameters: rootContext - The Context that ties to the host environment.

setStateMachine
public void setStateMachine(SCXML stateMachine)(Code)
	Set the state machine to be executed. Parameters: stateMachine - The stateMachine to set.

setSuperStep
public void setSuperStep(boolean superStep)(Code)
	Set the super step. Parameters: superStep - if true, the internal derived events are also processed(run-to-completion);if false, the internal derived events are stored in theCurrentStatus property and processed within the nexttriggerEvents() invocation, also the immediate (empty event) transitionsare deferred until the next step

triggerEvent
public void triggerEvent(TriggerEvent evt) throws ModelException(Code)
	Convenience method when only one event needs to be triggered. Parameters: evt - the external events which triggered during the lasttime quantum throws: ModelException - in case there is a fatal SCXML objectmodel problem.

triggerEvents
public synchronized void triggerEvents(TriggerEvent[] evts) throws ModelException(Code)
	The worker method. Re-evaluates current status whenever any events are triggered. Parameters: evts - an array of external events which triggered during the lasttime quantum throws: ModelException - in case there is a fatal SCXML objectmodel problem.

unregisterInvokerClass
public void unregisterInvokerClass(String targettype)(Code)
	Remove the `Invoker` registered for this target type (if there is one registered). Parameters: targettype - The target type (specified by "targettype"attribute of <invoke> tag).

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.