You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ra...@apache.org on 2007/12/07 05:53:49 UTC
svn commit: r601989 - in /commons/proper/scxml/trunk/xdocs/guide:
core-digester.xml core-engine.xml core-parser.xml custom-actions.xml
Author: rahul
Date: Thu Dec 6 20:53:49 2007
New Revision: 601989
URL: http://svn.apache.org/viewvc?rev=601989&view=rev
Log:
Update the user guide per changes coming in v0.7.
Added:
commons/proper/scxml/trunk/xdocs/guide/core-parser.xml
- copied, changed from r599530, commons/proper/scxml/trunk/xdocs/guide/core-digester.xml
Removed:
commons/proper/scxml/trunk/xdocs/guide/core-digester.xml
Modified:
commons/proper/scxml/trunk/xdocs/guide/core-engine.xml
commons/proper/scxml/trunk/xdocs/guide/custom-actions.xml
Modified: commons/proper/scxml/trunk/xdocs/guide/core-engine.xml
URL: http://svn.apache.org/viewvc/commons/proper/scxml/trunk/xdocs/guide/core-engine.xml?rev=601989&r1=601988&r2=601989&view=diff
==============================================================================
--- commons/proper/scxml/trunk/xdocs/guide/core-engine.xml (original)
+++ commons/proper/scxml/trunk/xdocs/guide/core-engine.xml Thu Dec 6 20:53:49 2007
@@ -111,7 +111,7 @@
<subsection name="API notes set">
<p>The previous note in this set describes the
- <a href="core-digester.html">SCXML digester</a>.<br/>
+ <a href="core-parser.html">SCXML parser</a>.<br/>
The next note in this set describes
<a href="core-events.html">triggering events</a>.</p>
</subsection>
Copied: commons/proper/scxml/trunk/xdocs/guide/core-parser.xml (from r599530, commons/proper/scxml/trunk/xdocs/guide/core-digester.xml)
URL: http://svn.apache.org/viewvc/commons/proper/scxml/trunk/xdocs/guide/core-parser.xml?p2=commons/proper/scxml/trunk/xdocs/guide/core-parser.xml&p1=commons/proper/scxml/trunk/xdocs/guide/core-digester.xml&r1=599530&r2=601989&rev=601989&view=diff
==============================================================================
--- commons/proper/scxml/trunk/xdocs/guide/core-digester.xml (original)
+++ commons/proper/scxml/trunk/xdocs/guide/core-parser.xml Thu Dec 6 20:53:49 2007
@@ -19,26 +19,26 @@
<document>
<properties>
- <title>Commons SCXML Usage - API notes - Digester</title>
+ <title>Commons SCXML Usage - API notes - Parser</title>
<author email="dev@commons.apache.org">Commons Documentation Team</author>
</properties>
<body>
- <section name="Commons SCXML - Digesting SCXML documents for Commons SCXML">
+ <section name="Commons SCXML - Parsing SCXML documents for Commons SCXML">
<p>Commons SCXML provides its own implementation of the
<a href="http://commons.apache.org/scxml/apidocs/org/apache/commons/scxml/model/package-summary.html">
Java object model for SCXML</a>
and a configured <a href="http://commons.apache.org/digester">
- Digester</a> that can digest SCXML documents into that object model.</p>
+ Digester</a> that can parse SCXML documents into that object model.</p>
<subsection name="Usage">
- <p>The primary convenience method exposed by the <code>SCXMLDigester</code>
+ <p>The primary convenience method exposed by the <code>SCXMLParser</code>
is:</p>
<pre>
//import java.io.IOException;
//import java.net.URL;
- //import org.apache.commons.scxml.io.SCXMLDigester;
+ //import org.apache.commons.scxml.io.SCXMLParser;
//import org.apache.commons.scxml.model.ModelException;
//import org.apache.commons.scxml.model.SCXML;
//import org.xml.sax.ErrorHandler;
@@ -47,7 +47,7 @@
SCXML scxml = null;
try {
- scxml = SCXMLDigester.digest(<URL>, <ErrorHandler>);
+ scxml = SCXMLParser.parse(<URL>, <ErrorHandler>);
} catch (IOException ioe) {
// IOException while parsing
} catch (SAXException se) {
@@ -58,7 +58,7 @@
if (scxml == null) {
- // Digestion failed
+ // Parsing failed
}
</pre>
@@ -71,7 +71,7 @@
<p>Commons SCXML provides convenience implementations of most of the
interfaces such as <code>ErrorHandler</code>.</p>
- <p>The SCXMLDigester exposes other convenience methods which can handle
+ <p>The SCXMLParser 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
@@ -79,8 +79,8 @@
<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/io/SCXMLDigester.html">
+ <p>The <code>SCXMLParser</code> Javadoc is available
+ <a href="../apidocs/org/apache/commons/scxml/io/SCXMLParser.html">
here</a>.
</p>
</subsection>
Modified: commons/proper/scxml/trunk/xdocs/guide/custom-actions.xml
URL: http://svn.apache.org/viewvc/commons/proper/scxml/trunk/xdocs/guide/custom-actions.xml?rev=601989&r1=601988&r2=601989&view=diff
==============================================================================
--- commons/proper/scxml/trunk/xdocs/guide/custom-actions.xml (original)
+++ commons/proper/scxml/trunk/xdocs/guide/custom-actions.xml Thu Dec 6 20:53:49 2007
@@ -136,8 +136,8 @@
// (2) Parse the SCXML document containing the custom action(s)
SCXML scxml = null;
try {
- scxml = SCXMLDigester.digest(url, errorHandler, customActions);
- // Also see other methods in SCXMLDigester API
+ scxml = SCXMLParser.parse(url, errorHandler, customActions);
+ // Also see other methods in SCXMLParser API
// "url" points to SCXML document
// "errorHandler" is SAX ErrorHandler
} catch (Exception e) {
@@ -154,7 +154,7 @@
can be added by directly by obtaining a Digester instance with the
"default" SCXML rules using the <code>newInstance()</code> methods
and further directly adding the necessary rules using the
- <a href="http://commons.apache.org/digester/commons-digester-1.7/docs/api/">digester API</a>
+ <a href="http://commons.apache.org/digester/commons-digester-1.8/docs/api/">digester API</a>
.</p>
</subsection>
@@ -162,9 +162,9 @@
<subsection name="Read in the 'custom' SCXML document">
<p>For documents without custom actions, the utility methods of the
- <a href="../apidocs/org/apache/commons/scxml/io/SCXMLDigester.html">SCXMLDigester</a>
+ <a href="../apidocs/org/apache/commons/scxml/io/SCXMLParser.html">SCXMLParser</a>
should be used. That section is
- <a href="core-digester.html">here</a>.</p>
+ <a href="core-parser.html">here</a>.</p>
</subsection>