svn commit: r513014 - /incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.fc.xml

[al...@apache.org]

Author: alally
Date: Wed Feb 28 14:25:44 2007
New Revision: 513014

URL: http://svn.apache.org/viewvc?view=rev&rev=513014
Log:
Documentation update for ParallelStep.
UIMA-327: https://issues.apache.org/jira/browse/UIMA-327

Modified:
    incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.fc.xml

Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.fc.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.fc.xml?view=diff&rev=513014&r1=513013&r2=513014
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.fc.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.fc.xml Wed Feb 28 14:25:44 2007
@@ -60,21 +60,25 @@
       
       <para>The framework then uses the Flow object and calls its <literal>next()</literal> method, which returns
         a <literal>Step</literal> object (implemented by the UIMA Framework) that indicates what to do next with
-        this CAS next. There are two common types of steps:</para>
+        this CAS next. There are three types of steps currently supported:</para>
       
       <itemizedlist>
         <listitem>
           <para><literal>SimpleStep</literal>, which specifies a single Analysis Engine that should receive
             the CAS next.</para>
         </listitem>
+
+        <listitem>
+          <para><literal>ParallelStep</literal>, which specifies that multiple Analysis Engines should receive
+            the CAS next, and that the relative order in which these Analysis Engines execute does not matter.
+            Logically, they can run in parallel. The runtime is not obligated to actually execute them in parallel, 
+            however, and the current implementation will execute them serially in an arbitrary order.</para>
+        </listitem>        
         
         <listitem>
           <para><literal>FinalStep</literal>, which indicates that the flow is completed. </para>
         </listitem>
       </itemizedlist>
-      
-      <para>There may be additional types of steps added in future versions; for example to invoke multiple Analysis
-        Engines in parallel on the same CAS.</para>
       
       <para>After executing the step, the framework will call the Flow object&apos;s <literal>next()</literal>
         method again to determine the next destination, and this will be repeated until the Flow Object indicates