You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2007/02/03 02:45:03 UTC
svn commit: r502838 - in
/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook:
overview_and_setup/project_overview.xml
tutorials_and_users_guides/tug.cpe.xml
Author: schor
Date: Fri Feb 2 17:45:02 2007
New Revision: 502838
URL: http://svn.apache.org/viewvc?view=rev&rev=502838
Log:
No Jira - add documentation about new AE API having all the
CAS Consumer methods (like collectionProcessingComplete)
to overview and also to CPE tutorial.
Modified:
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/project_overview.xml
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cpe.xml
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/project_overview.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/project_overview.xml?view=diff&rev=502838&r1=502837&r2=502838
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/project_overview.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/project_overview.xml Fri Feb 2 17:45:02 2007
@@ -704,7 +704,8 @@
</formalpara>
<para>
The new Annotator interfaces support the changed approaches for ResultSpecifications
- and the changed exception names (see below).</para>
+ and the changed exception names (see below), and have all the methods that CAS Consumers
+ have, including CollectionProcessComplete and BatchProcessComplete.</para>
<formalpara id="ugr.ovv.exceptions_rationalized">
<title>UIMA Exceptions rationalized</title>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cpe.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cpe.xml?view=diff&rev=502838&r1=502837&r2=502838
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cpe.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cpe.xml Fri Feb 2 17:45:02 2007
@@ -802,11 +802,17 @@
</section>
<section id="ugr.tug.cpe.cas_consumer.developing"><title>Developing CAS
- Consumers</title> <note><para>In version 2, there is no difference in capability
+ Consumers</title>
+
+ <note><para>In version 2, there is no difference in capability
between CAS Consumers and ordinary Analysis Engines, except for the default setting of
the XML parameters for <literal>multipleDeploymentAllowed</literal> and
<literal>modifiesCas</literal>. We recommend for future work that users implement
- and use Analysis Engine components instead of CAS Consumers</para></note>
+ and use Analysis Engine components instead of CAS Consumers.</para>
+ <para>The rest of this section is written using the version 1 style of CAS Consumer;
+ the methods described are also available for Analysis Engines. Note that the
+ CAS Consumer <literal>processCAS</literal> method is equivalent to the Analysis Engine
+ <literal>process</literal> method.</para></note>
<para>A CAS Consumer receives each CAS after it has been analyzed by the Analysis
Engine. CAS Consumers typically do not update the CAS; they typically extract data
@@ -828,10 +834,13 @@
<literal>processCas(CAS)</literal>, which is where the CAS Consumer does the bulk
of its work (i.e., consume the CAS).</para>
- <para>The <literal>CasConsumer</literal> interface additionally defines batch
- and collection level processing methods. The CAS Consumer can implement the
+ <para>The <literal>CasConsumer</literal> interface (as well as the version 2
+ Analysis Engine interfac) additionally defines batch
+ and collection level processing methods. The CAS Consumer or Analysis Engine
+ can implement the
<literal>batchProcessComplete()</literal> method to perform processing that
- should occur at the end of each batch of CASes. Similarly, the CAS Consumer can
+ should occur at the end of each batch of CASes. Similarly, the CAS Consumer
+ or Analysis Engine can
implement the <literal>collectionProcessComplete()</literal> method to
perform any collection level processing at the end of the collection.</para>
@@ -945,7 +954,8 @@
<title>batchProcessComplete()</title>
<para>The framework calls the batchProcessComplete() method at the end of each
- batch of CASes. This gives the CAS Consumer an opportunity to perform any batch
+ batch of CASes. This gives the CAS Consumer or Analysis Engine
+ an opportunity to perform any batch
level processing. Our simple XMI Writer CAS Consumer does not perform any
batch level processing, so this method is empty. Batch size is set in the
Collection Processing Engine descriptor.</para>
@@ -957,7 +967,7 @@
<para>The framework calls the collectionProcessComplete() method at the end
of the collection (i.e., when all objects in the collection have been
processed). At this point in time, no CAS is passed in as a parameter. This gives
- the CAS Consumer an opportunity to perform collection processing over the
+ the CAS Consumer or Analysis Engine an opportunity to perform collection processing over the
entire set of objects in the collection. Our simple XMI Writer CAS Consumer
does not perform any collection level processing, so this method is
empty.</para>