You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by al...@apache.org on 2007/06/27 16:31:30 UTC

svn commit: r551177 - /incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/annotator_analysis_engine_guide.xml

Author: alally
Date: Wed Jun 27 07:31:29 2007
New Revision: 551177

URL: http://svn.apache.org/viewvc?view=rev&rev=551177
Log:
doc update for UIMA-348

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

Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/annotator_analysis_engine_guide.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/annotator_analysis_engine_guide.xml?view=diff&rev=551177&r1=551176&r2=551177
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/annotator_analysis_engine_guide.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/annotator_analysis_engine_guide.xml Wed Jun 27 07:31:29 2007
@@ -1227,6 +1227,17 @@
         Analysis Engines. The UIMA Examples has an example of an Aggregate which contains
         both an analysis engine and a CAS consumer, in
         <literal>examples/descriptors/MixedAggregate.xml.</literal></para>
+      
+      <para>Analysis Engines support the <literal>collectionProcessComplete</literal>
+        method, which is particularly important for many CAS Consumers.  If
+        an application (or a Collection Processing Engine) calls 
+        <literal>collectionProcessComplete</literal> no an aggregate, the framework
+        will deliver that call to all of the components of the aggregate.  If you use
+        one of the built-in flow types (fixedFlow or capabilityLanguageFlow), then the
+        order specified in that flow will be the same order in which the
+        <literal>collectionProcessComplete</literal> calls are made to the components.
+        If a custom flow is used, then the calls will be made in arbitrary order.
+      </para>
     </section>
     
     <section id="ugr.tug.aae.reading_results_previous_annotators">