You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by ra...@apache.org on 2006/01/29 19:18:07 UTC
svn commit: r373334 - in
/jakarta/commons/sandbox/scxml/branches/STATELESS_MODEL/xdocs/api-notes:
core-digester.xml core-engine.xml
Author: rahul
Date: Sun Jan 29 10:18:03 2006
New Revision: 373334
URL: http://svn.apache.org/viewcvs?rev=373334&view=rev
Log:
Update API docs to match changes to the branch.
Modified:
jakarta/commons/sandbox/scxml/branches/STATELESS_MODEL/xdocs/api-notes/core-digester.xml
jakarta/commons/sandbox/scxml/branches/STATELESS_MODEL/xdocs/api-notes/core-engine.xml
Modified: jakarta/commons/sandbox/scxml/branches/STATELESS_MODEL/xdocs/api-notes/core-digester.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/scxml/branches/STATELESS_MODEL/xdocs/api-notes/core-digester.xml?rev=373334&r1=373333&r2=373334&view=diff
==============================================================================
--- jakarta/commons/sandbox/scxml/branches/STATELESS_MODEL/xdocs/api-notes/core-digester.xml (original)
+++ jakarta/commons/sandbox/scxml/branches/STATELESS_MODEL/xdocs/api-notes/core-digester.xml Sun Jan 29 10:18:03 2006
@@ -37,8 +37,6 @@
<pre>
//import java.io.IOException;
//import java.net.URL;
- //import org.apache.commons.scxml.Context;
- //import org.apache.commons.scxml.Evaluator;
//import org.apache.commons.scxml.io.SCXMLDigester;
//import org.apache.commons.scxml.model.SCXML;
//import org.xml.sax.ErrorHandler;
@@ -47,8 +45,7 @@
SCXML scxml = null;
try {
- scxml = SCXMLDigester.digest(<URL>, <ErroHandler>,
- <Context>, <Evaluator>);
+ scxml = SCXMLDigester.digest(<URL>, <ErroHandler>);
} catch (IOException ioe) {
// IOException while parsing
} catch (SAXException se) {
@@ -68,19 +65,15 @@
attributes of <code>State</code> SCXML elements.</p>
<p>Commons SCXML provides convenience implementations of most of the
- interfaces such as <code>ErrorHandler</code>. The SCXML specification
- allows implementations to support multiple expression languages so SCXML
- documents can be used in varying environments. The <code>Context</code>
- and <code>Evaluator</code> interfaces serve as adapters to the
- particular expression language APIs. Commons SCXML currently supports
- JEXL and JSP 2.0 EL expressions.</p>
+ interfaces such as <code>ErrorHandler</code>.</p>
- <p>The SCXMLDigester exposes another convenience method which can handle
+ <p>The SCXMLDigester exposes other convenience methods which can handle
a SCXML document specified using its "real path" on the local
system, in which case an additional
<code>org.apache.commons.SCXML.PathResolver</code>parameter needs to be
- supplied for resolving relative document references. A serialization
- method is also available, primarily for debugging.</p>
+ supplied for resolving relative document references or as an
+ <code>InputSource</code>, in which case there is no path resolution,
+ so the document must be a standalone document.</p>
<p>The <code>SCXMLDigester</code> Javadoc is available
<a href="../apidocs/org/apache/commons/scxml/SCXMLDigester.html">
Modified: jakarta/commons/sandbox/scxml/branches/STATELESS_MODEL/xdocs/api-notes/core-engine.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/scxml/branches/STATELESS_MODEL/xdocs/api-notes/core-engine.xml?rev=373334&r1=373333&r2=373334&view=diff
==============================================================================
--- jakarta/commons/sandbox/scxml/branches/STATELESS_MODEL/xdocs/api-notes/core-engine.xml (original)
+++ jakarta/commons/sandbox/scxml/branches/STATELESS_MODEL/xdocs/api-notes/core-engine.xml Sun Jan 29 10:18:03 2006
@@ -36,10 +36,11 @@
<subsection name="Usage">
<p>The <code>SCXMLExecutor</code> is usually initialized as follows:</p>
<pre>
- //import org.apache.commons.scxml.SCXMLExecutor;
+ //import org.apache.commons.scxml.Context;
+ //import org.apache.commons.scxml.ErrorReporter;
//import org.apache.commons.scxml.Evaluator;
//import org.apache.commons.scxml.EventDispatcher;
- //import org.apache.commons.scxml.ErrorReporter;
+ //import org.apache.commons.scxml.SCXMLExecutor;
//import org.apache.commons.scxml.SCXMLListener;
//import org.apache.commons.scxml.model.SCXML;
//import org.apache.commons.scxml.model.ModelException;
@@ -48,11 +49,13 @@
try {
exec = new SCXMLExecutor(<Evaluator>,
<EventDispatcher>, <ErrorReporter>);
- scxml.addListener(<SCXMLListener>);
- exec.setSuperStep(true);
exec.setStateMachine(<SCXML>);
+ exec.addListener(<SCXML>, <SCXMLListener>);
+ exec.setRootContext(<Context>);
+ exec.setSuperStep(true);
+ exec.go();
} catch (ModelException me) {
- // Executor initialization failed, because the
+ // Executor initialization failed, because the
// state machine specified has inconsistencies
}
</pre>
@@ -62,10 +65,12 @@
<code>SCXMLListener</code> interfaces, which simply log
all the events received. Commons SCXML uses Commons Logging.</p>
- <p>An engine, once initialized,
- should be cached till the state machine reaches a terminal or
- "final" state, and no more.
- </p>
+ <p>The SCXML specification allows implementations to support multiple
+ expression languages so SCXML documents can be used in varying
+ environments. The <code>Context</code> and <code>Evaluator</code>
+ interfaces serve as adapters to the particular expression language
+ APIs. Commons SCXML currently supports JEXL and JSP 2.0 EL
+ expressions.</p>
<p>The <code>SCXMLExecutor</code> Javadoc is available
<a href="../apidocs/org/apache/commons/scxml/SCXMLExecutor.html">
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org