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 2006/12/05 21:39:52 UTC
svn commit: r482771 [5/9] - in /incubator/uima/uimaj/trunk/uima-docbooks: ./
src/docbook/ src/docbook/overview_and_setup/ src/docbook/references/
src/docbook/references/images/ref.cas/
src/docbook/references/images/ref.pear/ src/docbook/references/imag...
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.packager.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.packager.xml?view=diff&rev=482771&r1=482770&r2=482771
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.packager.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.packager.xml Tue Dec 5 12:39:49 2006
@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"[
-<!ENTITY imgroot "images/annotator_analysis_engine_files/" >
-<!ENTITY % uimaents SYSTEM "entities.ent" >
+<!ENTITY imgroot "../images/tools/tools.pear.packager/" >
+<!ENTITY % uimaents SYSTEM "../entities.ent" >
%uimaents;
]>
<!--
@@ -23,242 +23,259 @@
specific language governing permissions and limitations
under the License.
-->
-<chapter id="ugr.tool.pear.packager">
- <title></title>
- <section name="PEAR Packager User's Guide"><a id="_crossRef251"> </a>
-
-
-
-<para>A PEAR (Processing Engine ARchive) file is a standard
-package for UIMA (Unstructured Information Management Architecture) components.
-The PEAR package can be used for distribution and reuse by other components or
-applications. It also allows applications and tools to manage UIMA components
-automatically for verification, deployment, invocation, testing, etc. Please
-refer to the PEAR Reference chapter for more information about the internal
-structure of a PEAR file.</para>
-
-<para>This chapter describes how to use the PEAR Eclipse Plugin
-to create PEAR files for standard UIMA components. This plugin is installed if you followed the
-directions in <a class="crossrefText" href="UIMA_SDK_Installation_and_Setup.htm#_crossRef372">Chapter
-3, <b><emphasis>UIMA
-SDK Setup for Eclipse</emphasis></b></a> <a class="crossrefPage" href="UIMA_SDK_Installation_and_Setup.htm#_crossRef372"></a>.</para>
-
-
-
-<subsection name="Using the PEAR Eclipse Plugin"><a id="_crossRef252"> </a>
-
-
-
-<para>Using
-the PEAR Eclipse Plugin involves the following two steps:</para>
-
-<itemizedlist spacing="compact"><listitem>Add the UIMA nature to your
-project </listitem>
-
-
-<listitem>Create a PEAR file using the PEAR
-generation wizard
-</listitem></itemizedlist>
-
-<h3><a id="_crossRef253">Add UIMA Nature to your project</a></h3>
-
-<para>First, create a project for your UIMA component:</para>
-
-<itemizedlist spacing="compact"><listitem>Create a Java project, which would contain all the files
-and folders needed for your UIMA component.</listitem>
-
-
-<listitem>Create a source folder called <quote>src</quote>
-in your project, and make it the only source folder, by clicking on <quote>Properties</quote>
-in your project's context menu (right-click), then select <quote>Java Build Path</quote>,
-then add the <quote>src</quote> folder to the source folders list, and remove any
-other folder from the list.</listitem>
-
-
-<listitem>Specify an output folder for your
-project called bin, by clicking on <quote>Properties</quote> in your project's
-context menu (right-click), then select <quote>Java Build Path</quote>, and
-specify <quote><emphasis>your_project_name</emphasis>/bin</quote> as the default output folder.
-</listitem></itemizedlist>
-
-<para>Then,
-add the UIMA nature to your project by clicking on <quote>Add UIMA Nature</quote>
-in the context menu (right-click) of your project. Click <quote>Yes</quote>
-on the <quote>Adding UIMA custom Nature</quote> dialog box. Click <quote>OK</quote>
-on the confirmation dialog box.</para>
-
-<para><img alt="" width="612" height="474"
-src="../UIMA_SDK_Guide_Ref/PEAR_Packager_files/image002.jpg"/> <span class="figCaption">17. Adding the UIMA Nature</span></para>
-
-<para>Adding the UIMA nature to your project creates the PEAR structure
-in your project. The PEAR structure is a structured tree of folders and files,
-including the following elements:</para>
-
-<itemizedlist><listitem><b>Required Elements:</b>
-
-
-<itemizedlist><listitem>The <b>metadata</b> folder which contains the PEAR installation descriptor and
-properties files.</listitem>
-
-
-<listitem>The installation descriptor (<b>metadata/install.xml</b>)
-
-</listitem></itemizedlist></listitem>
-
-
-<listitem><b>Optional Elements:</b>
-
-
-<itemizedlist><listitem>The <b>desc</b> folder to contain descriptor files of analysis engines, component
-analysis engines (all levels), and other component (Collection Readers, CAS
-Consumers, etc).</listitem>
-
-
-<listitem>The <b>src </b>folder to contain
-the source code</listitem>
-
-
-<listitem>The <b>bin</b> folder to contain executables, scripts, class files, dlls,
-shared libraries, etc.</listitem>
-
-
-<listitem>The <b>lib</b> folder to contain
-jar files. </listitem>
-
-
-<listitem>The <b>doc </b>folder containing
-documentation materials, preferably accessible through an index.html.</listitem>
-
-
-<listitem>The <b>data</b> folder to contain
-data files (e.g. for testing).</listitem>
-
-
-<listitem>The <b>conf</b> folder to contain
-configuration files.</listitem>
-
-
-<listitem>The <b>resources</b> folder to
-contain other resources and dependencies.</listitem>
-
-
-<listitem>Other user-defined folders or
-files are allowed, but <u>should be avoided</u>.
-</listitem></itemizedlist>
-</listitem></itemizedlist>
-
-<para>For more information about the PEAR structure, please
-refer to the <quote>Processing Engine Archive</quote> section.</para>
-
-<para><img alt="" width="303" height="394"
-src="../UIMA_SDK_Guide_Ref/PEAR_Packager_files/image004.jpg"/></para>
-
-<a class="figCaption" id="_crossRef254a">The PEAR Structure</a>
-
-
-
-<h3><a id="_crossRef255">Use the PEAR Generation Wizard</a></h3>
-
-<para>Before using the PEAR Generation Wizard, make sure you add
-all the files needed to run your
-component including descriptors, jars, external libraries, resources, and component
-analysis engines (in the case of an aggregate analysis engine), etc. It's recommended to generate a jar file
-from your code as an alternative to building the project and making sure the output
-folder (bin) contains the required class files.</para>
-
-<para>Then, click on <quote>Generate PEAR file</quote> from the context menu (right-click) of
-your project, to open the PEAR Generation wizard, and follow the instructions on the
-wizard to generate the PEAR file.</para>
-
-<h4><a id="_crossRef256">The Component Information page</a></h4>
-
-<para>The first page of the PEAR generation wizard is the
-component information page. Specify in this page a component ID for your PEAR
-and select the main Analysis Engine descriptor. The descriptor must be
-specified using a pathname relative to the project's root (e.g. <quote>desc/MyTAE.xml).
-The component id is a string that uniquely identifies the component. It should
-use the JAVA naming convention (e.g. org.apache.uima.mycomponent).</para>
-
-<para>Optionally, you can include specific Collection Iterator, CAS
-Initializer, or CAS Consumers. In this case, specify the corresponding
-descriptors in this page.</para>
-
-<para><img alt="" width="636" height="453"
-src="../UIMA_SDK_Guide_Ref/PEAR_Packager_files/image006.jpg"/><span class="figCaption">Figure
-19. The component Information
-page </span></para>
-
-<h4><a id="_crossRef257">The Installation Environment page</a></h4>
-
-<para>The installation environment page is used to specify the
-following:</para>
-
-<itemizedlist spacing="compact"><listitem>Preferred operating system</listitem>
-
-
-<listitem>Required JDK version, if
-applicable.</listitem>
-
-
-<listitem>Required Environment variable,
-such as CLASSPATH
-</listitem></itemizedlist>
-
-<para>Path names should be specified using macros (see below),
-instead of hard-coded absolute paths that might work locally, but probably won't
-if the PEAR is deployed in a different machine and environment.</para>
-
-<para>Macros are variables such as $main_root, used to represent
-a string such as the full path of a certain directory.</para>
-
-<para>These macros should be defined in the PEAR.properties file
-using the local values. The tools and applications that use and deploy PEAR
-files should replace these macros (in the files included in the conf and desc
-folders) with the corresponding values in the local environment as part of the
-deployment process.</para>
-
-<para>Currently, there are two types of macros:</para>
-
-<itemizedlist><listitem>$main_root , which represents the
-local absolute path of the main component root directory after deployment. </listitem>
-
-
-<listitem>$<emphasis>component_id</emphasis>$root, which
-represents the local absolute path to the root directory of the component which
-has <emphasis>component_id </emphasis> as component ID.
-This component could be, for instance, a delegate component.
-</listitem></itemizedlist>
-
-<para><img alt="" width="612" height="388"
-src="../UIMA_SDK_Guide_Ref/PEAR_Packager_files/image008.jpg"/>
-<a class="figCaption" id="ppkgrInstallEnv">The Installation Environment Page</a></para>
-
-<h4><a id="_crossRef258">The PEAR file content page</a></h4>
-
-<para>The last page of the wizard is the </quote>PEAR file Export<quote>
-page, which allows the user to select the files to include in the PEAR file.
-The metadata folder and all its content is mandatory. Make sure you include all
-the files needed to run your
-component including descriptors, jars, external libraries, resources, and component
-analysis engines (in the case of an aggregate analysis engine), etc. It's recommended to generate a jar file
-from your code as an alternative to building the project and making sure the
-output folder (bin) contains the required class files.</para>
-
-<para>Note: If you are relying on the class files generated in
-the output folder (usually called bin) to run your code, then make sure the
-project is built properly, and all the required class files are generated
-without errors. In this case make sure your output folder (e.g. $main_root/bin)
-is in the classpath (see the </quote>Installation Environment" page.</para>
-
-
-
-<para><img alt="" width="576" height="434"
-src="../UIMA_SDK_Guide_Ref/PEAR_Packager_files/image010.jpg"/>
-<a class="figCaption" id="ppkgrExportPg">The PEAR File Export Page</a></para>
-
-</div>
-
-<emphasis><br/>
-</emphasis>
-
+<chapter id="ugr.tools.pear.packager">
+ <title>PEAR Packager User's Guide</title>
+
+ <para>A PEAR (Processing Engine ARchive) file is a standard package for UIMA (Unstructured
+ Information Management Architecture) components. The PEAR package can be used for
+ distribution and reuse by other components or applications. It also allows applications
+ and tools to manage UIMA components automatically for verification, deployment,
+ invocation, testing, etc. Please refer to the PEAR Reference chapter for more
+ information about the internal structure of a PEAR file.</para>
+
+ <para>This chapter describes how to use the PEAR Eclipse Plugin to create PEAR files for
+ standard UIMA components. This plugin is installed if you followed the directions in
+ <olink targetdoc="&uima_docs_overview;" targetptr="ugr.ovv.eclipse_setup"/>
+ .</para>
+
+ <section id="ugr.tools.pear.packager.using_eclipse_plugin">
+ <title>Using the PEAR Eclipse Plugin</title>
+
+ <para>Using the PEAR Eclipse Plugin involves the following two steps:</para>
+
+ <itemizedlist spacing="compact"><listitem><para>Add the UIMA nature to your project
+ </para></listitem>
+
+ <listitem><para>Create a PEAR file using the PEAR generation wizard </para>
+ </listitem></itemizedlist>
+
+ <section id="ugr.tools.pear.packager.add_uima_nature">
+ <title>Add UIMA Nature to your project</title>
+
+ <para>First, create a project for your UIMA component:</para>
+
+ <itemizedlist spacing="compact"><listitem><para>Create a Java project, which
+ would contain all the files and folders needed for your UIMA component.</para>
+ </listitem>
+
+ <listitem><para>Create a source folder called <quote>src</quote> in your
+ project, and make it the only source folder, by clicking on
+ <quote>Properties</quote> in your project's context menu (right-click),
+ then select <quote>Java Build Path</quote>, then add the <quote>src</quote>
+ folder to the source folders list, and remove any other folder from the
+ list.</para></listitem>
+
+ <listitem><para>Specify an output folder for your project called bin, by clicking
+ on <quote>Properties</quote> in your project's context menu
+ (right-click), then select <quote>Java Build Path</quote>, and specify
+ <quote><emphasis>your_project_name</emphasis>/bin</quote> as the default
+ output folder. </para></listitem></itemizedlist>
+
+ <para>Then, add the UIMA nature to your project by clicking on <quote>Add UIMA
+ Nature</quote> in the context menu (right-click) of your project. Click
+ <quote>Yes</quote> on the <quote>Adding UIMA custom Nature</quote> dialog box.
+ Click <quote>OK</quote> on the confirmation dialog box.
+
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="612" depth="474" format="JPG" fileref="&imgroot;image002.jpg"/>
+ </imageobject>
+ <textobject><phrase>Screenshot of Adding the UIMA Nature to your project</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot></para>
+
+ <para>Adding the UIMA nature to your project creates the PEAR structure in your
+ project. The PEAR structure is a structured tree of folders and files, including the
+ following elements:
+
+ <itemizedlist><listitem><para><emphasis role="bold">Required
+ Elements:</emphasis>
+
+ <itemizedlist><listitem><para>The <emphasis role="bold">
+ metadata</emphasis> folder which contains the PEAR installation descriptor
+ and properties files.</para></listitem>
+
+ <listitem><para>The installation descriptor (<emphasis role="bold">
+ metadata/install.xml</emphasis>)
+ </para></listitem></itemizedlist></para></listitem>
+
+ <listitem><para><emphasis role="bold">Optional Elements:</emphasis>
+
+ <itemizedlist><listitem><para>The <emphasis role="bold">
+ desc</emphasis> folder to contain descriptor files of analysis engines,
+ component analysis engines (all levels), and other component (Collection
+ Readers, CAS Consumers, etc).</para></listitem>
+
+ <listitem><para>The <emphasis role="bold">src </emphasis>folder to
+ contain the source code</para></listitem>
+
+ <listitem><para>The <emphasis role="bold">bin</emphasis> folder to
+ contain executables, scripts, class files, dlls, shared libraries,
+ etc.</para></listitem>
+
+ <listitem><para>The <emphasis role="bold">lib</emphasis> folder to
+ contain jar files. </para></listitem>
+
+ <listitem><para>The <emphasis role="bold">doc </emphasis>folder
+ containing documentation materials, preferably accessible through an
+ index.html.</para></listitem>
+
+ <listitem><para>The <emphasis role="bold">data</emphasis> folder to
+ contain data files (e.g. for testing).</para></listitem>
+
+ <listitem><para>The <emphasis role="bold">conf</emphasis> folder to
+ contain configuration files.</para></listitem>
+
+ <listitem><para>The <emphasis role="bold">resources</emphasis> folder
+ to contain other resources and dependencies.</para></listitem>
+
+ <listitem><para>Other user-defined folders or files are allowed, but
+ <emphasis>should be avoided</emphasis>. </para></listitem>
+ </itemizedlist> </para></listitem></itemizedlist></para>
+
+ <para>For more information about the PEAR structure, please refer to the
+ <quote>Processing Engine Archive</quote> section.
+
+ <figure id="ugr.tools.pear.packager.fig.pear_structure">
+ <title>The Pear Structure</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="303" depth="394" format="JPG"
+ fileref="&imgroot;image004.jpg"/>
+ </imageobject>
+ <textobject><phrase>Pear structure</phrase>
+ </textobject>
+ </mediaobject>
+ </figure></para>
+
+ </section>
+ <section id="ugr.tools.pear.packager.using_pear_generation_wizard">
+ <title>Using the PEAR Generation Wizard</title>
+
+ <para>Before using the PEAR Generation Wizard, make sure you add all the files needed to
+ run your component including descriptors, jars, external libraries, resources,
+ and component analysis engines (in the case of an aggregate analysis engine), etc.
+ It's recommended to generate a jar file from your code as an alternative to
+ building the project and making sure the output folder (bin) contains the required
+ class files.</para>
+
+ <para>Then, click on <quote>Generate PEAR file</quote> from the context menu
+ (right-click) of your project, to open the PEAR Generation wizard, and follow the
+ instructions on the wizard to generate the PEAR file.</para>
+
+ <section id="ugr.tools.pear.packager.wizard.component_information">
+ <title>The Component Information page</title>
+
+ <para>The first page of the PEAR generation wizard is the component information
+ page. Specify in this page a component ID for your PEAR and select the main Analysis
+ Engine descriptor. The descriptor must be specified using a pathname relative to
+ the project's root (e.g. <quote>desc/MyAE.xml</quote>). The component id
+ is a string that uniquely identifies the component. It should use the JAVA naming
+ convention (e.g. org.apache.uima.mycomponent).</para>
+
+ <para>Optionally, you can include specific Collection Iterator, CAS Initializer,
+ or CAS Consumers. In this case, specify the corresponding descriptors in this
+ page.
+
+ <figure id="ugr.tools.pear.packager.fig.wizard.component_information">
+ <title>The Component Information Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="636" depth="453" format="JPG"
+ fileref="&imgroot;image006.jpg"/>
+ </imageobject>
+ <textobject><phrase>Pear Wizard - component information page</phrase>
+ </textobject>
+ </mediaobject>
+ </figure></para>
+
+ </section>
+
+ <section id="ugr.tools.pear.packager.wizard.install_environment">
+ <title>The Installation Environment page</title>
+
+ <para>The installation environment page is used to specify the following:
+
+ <itemizedlist spacing="compact"><listitem><para>Preferred operating
+ system</para></listitem>
+
+ <listitem><para>Required JDK version, if applicable.</para></listitem>
+
+ <listitem><para>Required Environment variable, such as CLASSPATH </para>
+ </listitem></itemizedlist></para>
+
+ <para>Path names should be specified using macros (see below), instead of
+ hard-coded absolute paths that might work locally, but probably won't if the
+ PEAR is deployed in a different machine and environment.</para>
+
+ <para>Macros are variables such as $main_root, used to represent a string such as the
+ full path of a certain directory.</para>
+
+ <para>These macros should be defined in the PEAR.properties file using the local
+ values. The tools and applications that use and deploy PEAR files should replace
+ these macros (in the files included in the conf and desc folders) with the
+ corresponding values in the local environment as part of the deployment
+ process.</para>
+
+ <para>Currently, there are two types of macros:</para>
+
+ <itemizedlist><listitem><para>$main_root, which represents the local absolute
+ path of the main component root directory after deployment.</para></listitem>
+
+ <listitem><para><emphasis>$component_id$root</emphasis>, which
+ represents the local absolute path to the root directory of the component which
+ has <emphasis>component_id</emphasis> as component ID. This component could
+ be, for instance, a delegate component. </para></listitem></itemizedlist>
+
+ <figure id="ugr.tools.pear.packager.fig.wizard.install_environment">
+ <title>The Installation Environment Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="612" depth="388" format="JPG"
+ fileref="&imgroot;image008.jpg"/>
+ </imageobject>
+ <textobject><phrase>Pear Wizard - install environment page</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ <section id="ugr.tools.pear.packager.wizard.file_content">
+ <title>The PEAR file content page</title>
+
+ <para>The last page of the wizard is the <quote>PEAR file Export</quote> page, which
+ allows the user to select the files to include in the PEAR file. The metadata folder
+ and all its content is mandatory. Make sure you include all the files needed to run
+ your component including descriptors, jars, external libraries, resources, and
+ component analysis engines (in the case of an aggregate analysis engine), etc.
+ It's recommended to generate a jar file from your code as an alternative to
+ building the project and making sure the output folder (bin) contains the required
+ class files.</para>
+
+ <para>Note: If you are relying on the class files generated in the output folder
+ (usually called bin) to run your code, then make sure the project is built properly,
+ and all the required class files are generated without errors. In this case make
+ sure your output folder (e.g. $main_root/bin) is in the classpath (see the
+ <quote>Installation Environment</quote> page.
+
+ <figure id="ugr.tools.pear.packager.fig.wizard.export">
+ <title>The PEAR File Export Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="576" depth="434" format="JPG"
+ fileref="&imgroot;image010.jpg"/>
+ </imageobject>
+ <textobject><phrase>Pear Wizard - File Export Page</phrase>
+ </textobject>
+ </mediaobject>
+ </figure></para>
+
+ </section>
+ </section>
+ </section>
+
</chapter>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.xml?view=diff&rev=482771&r1=482770&r2=482771
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.xml Tue Dec 5 12:39:49 2006
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"[
- <!ENTITY % xinclude SYSTEM "xinclude.mod">
+ <!ENTITY % xinclude SYSTEM "../xinclude.mod">
%xinclude;
]>
<!--
@@ -24,20 +24,18 @@
-->
<book lang="en">
<title>Apache UIMA SDK Tools Guide and Reference</title>
- <para>This book describes the tools that are part of the
- UIMA distribution, and how to use them.
- </para>
- <xi:include href="common_book_info.xml"/>
-
- <toc/>
- <xi:include href="tools/Component_Descriptor_Editor.xml"/>
- <xi:include href="tools/Collection_Processing_Engine_Configurator.xml"/>
- <xi:include href="tools/Eclipse_UIMA_Component_Launcher.xml"/>
- <xi:include href="tools/PEAR_Packager.xml"/>
- <xi:include href="tools/PEAR_Installer.xml"/>
- <xi:include href="tools/PEAR_Merger.xml"/>
- <xi:include href="tools/Document_Analyzer.xml"/>
- <xi:include href="tools/JCasGen.xml"/>
- <xi:include href="tools/XCAS_Annotation_viewer.xml"/>
- <xi:include href="Notices_and_Trademarks.xml"/>
- </book>
+ <xi:include href="../common_book_info.xml"/>
+ <toc/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tools.cde.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tools.cpe.xml"/>
+ <!--
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tools.eclipse_launcher.xml"/>
+ -->
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tools.doc_analyzer.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tools.annotation_viewer.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tools.cvd.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tools.jcasgen.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tools.pear.packager.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tools.pear.installer.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tools.pear.merger.xml"/>
+</book>
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=482771&r1=482770&r2=482771
==============================================================================
--- 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 Tue Dec 5 12:39:49 2006
@@ -23,7 +23,7 @@
specific language governing permissions and limitations
under the License.
-->
-<chapter id="ugr.aae">
+<chapter id="ugr.tug.aae">
<title>Annotator and Analysis Engine Developer's Guide</title>
<para>This chapter describes how to develop UIMA <emphasis>type systems</emphasis>,
@@ -92,7 +92,7 @@
</listitem>
<listitem>
<para><emphasis role="bolditalic"><xref
- linkend="ugr.tug.aae.configuring_logging"/></emphasis> discusses how to
+ linkend="ugr.tug.aae.logging.configuring"/></emphasis> discusses how to
make your UIMA annotator configurable, and how it can write messages to the UIMA log
file.</para>
</listitem>
@@ -130,7 +130,7 @@
use Analysis Engines, along with other components, e.g. a search engine, document store,
and user interface, to deliver a complete package of functionality to an end-user. For
information on application development, see <olink
- targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.app_dev"/>
+ targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.application"/>
.</para>
<section id="ugr.tug.aae.getting_started">
@@ -141,7 +141,7 @@
<literal>examples</literal> directory of the UIMA SDK. This directory is designed to
be imported into your Eclipse workspace; see <olink
targetdoc="&uima_docs_overview;"
- targetptr="ugr.eclipse_setup.example_code"/> for instructions on how to do
+ targetptr="ugr.ovv.eclipse_setup.example_code"/> for instructions on how to do
this. Also you may wish to refer to the UIMA SDK JavaDocs located in the <ulink
url="file:api/index.html">docs/api</ulink> directory.</para>
<note><para>In Eclipse 3.1, if you highlight a UIMA class or method defined in the UIMA SDK
@@ -194,7 +194,7 @@
<para>UIMA includes an Eclipse plug-in that will help you edit Type System
Descriptors, so if you are using Eclipse you will not need to worry about the details of
the XML syntax. See <olink targetdoc="&uima_docs_overview;"
- targetptr="ugr.eclipse_setup"/> for instructions on setting up Eclipse and
+ targetptr="ugr.ovv.eclipse_setup"/> for instructions on setting up Eclipse and
installing the plugin.</para>
<para>The Type System Descriptor for our annotator is located in the file
@@ -202,7 +202,7 @@
and all other examples are located in the <literal>examples</literal>directory of
the installation of the UIMA SDK, which can be imported into an Eclipse project for
your convenience, as described in <olink targetdoc="&uima_docs_overview;"
- targetptr="ugr.eclipse_setup.example_code"/>.)</para>
+ targetptr="ugr.ovv.eclipse_setup.example_code"/>.)</para>
<para>In Eclipse, expand the <literal>uimaj_examples</literal> project in the
Package Explorer view, and browse to the file
@@ -360,7 +360,7 @@
use the JCas will extend from this class, so they only have to implement the process
method. This class is not restricted to handling just text; see <olink
targetdoc="&uima_docs_tutorial_guides;"
- targetptr="ugr.tug.annotations_artifacts_sofas"/>.</para>
+ targetptr="ugr.tug.aas"/>.</para>
<para>Annotators are not required to extend from the JCasAnnotator_ImplBase class;
they may instead directly implement the AnalysisComponent interface, and provide
@@ -607,7 +607,7 @@
leave this blank. The Sofas section allows you to specify the names of additional
subjects of analysis. This capability and the Sofa Mappings at the bottom are
advanced topics, described in <olink targetdoc="&uima_docs_tutorial_guides;"
- targetptr="ugr.tug.annotations_artifacts_sofas"/>. </para>
+ targetptr="ugr.tug.aas"/>. </para>
<para>This is all of the information we need to provide for a simple annotator. If you
want to peek at the XML that this tool saves you from having to write, click on the
@@ -706,10 +706,10 @@
</section>
</section>
- <section>
+ <section id="ugr.tug.aae.configuration_logging">
<title>Configuration and Logging</title>
- <section>
+ <section id="ugr.tug.aae.configuration_parameters">
<title>Configuration Parameters</title>
<para>The example RoomNumberAnnotator from the previous section used hardcoded
@@ -933,7 +933,7 @@
Preferences → General → Workspace, then click the <quote>refresh
automatically</quote> checkbox.</para></note>
- <section id="ugr.tug.aae.configuring_logging">
+ <section id="ugr.tug.aae.logging.configuring">
<title>Specifying the Logging Configuration</title>
<para>The standard UIMA logger uses the underlying Java 1.4 logging mechanism. You
@@ -974,7 +974,7 @@
</para>
</section>
- <section>
+ <section id="ugr.tug.aae.logging.setting_logging_levels">
<title>Setting Logging Levels</title>
<para>Within the logging control file, the default global logging level specifies
@@ -1001,7 +1001,7 @@
specification for logging in Java 1.4.</para>
</section>
- <section>
+ <section id="ugr.tug.aae.logging.output_format">
<title>Format of logging output</title>
<para>The logging output is formatted by handlers specified in the properties file
@@ -1018,7 +1018,7 @@
in!</literal></para>
</section>
- <section>
+ <section id="ugr.tug.aae.logging.meaning_of_severity_levels">
<title>Meaning of the logging severity levels</title>
<para>These levels are defined by the Java logging framework, which was
@@ -1060,7 +1060,7 @@
</listitem></itemizedlist></para>
</section>
- <section>
+ <section id="ugr.tug.aae.logging.using_outside_of_an_annotator">
<title>Using the logger outside of an annotator</title>
<para>An application using UIMA may want to log its messages using the same logging
@@ -1144,7 +1144,7 @@
which run remotely (for example, on another machine using a remote networking
connection). This capability is described in section <olink
targetdoc="&uima_docs_tutorial_guides;"
- targetptr="ugr.tug.app_dev.how_to_call_a_uima_service"/>,</para>
+ targetptr="ugr.tug.application.how_to_call_a_uima_service"/>,</para>
</note> </para>
<para>The order of the components in the left pane does not imply an order of
@@ -1200,7 +1200,7 @@
</section>
</section>
- <section>
+ <section id="ugr.tug.aae.aaes_can_contain_cas_consumers">
<title>Aggregate Engines can also contain CAS Consumers</title>
<para>In addition to aggregating Analysis Engines, Aggregates can also contain CAS
@@ -1308,7 +1308,7 @@
<listitem><para>XmlDetagger – A multi-sofa annotator that does XML
detagging. Multiple Sofas (Subjects of Analysis) are described in a later –
see <olink targetdoc="&uima_docs_tutorial_guides;"
- targetptr="ugr.tug.multiple_views"/>. Reads XML data from the input Sofa
+ targetptr="ugr.tug.mvs"/>. Reads XML data from the input Sofa
(named "xmlDocument"); this data can be stored in the CAS as a string or array, or it can
be a URI to a remote file. The XML is parsed using the JVM's default parser, and the
plain-text content is written to a new sofa called "plainTextDocument".</para>
@@ -1656,7 +1656,7 @@
<para>The top window has a scroll bar allowing you to see the rest of the line.</para>
- <section>
+ <section id="ugr.tug.aae.resources.declaring_dependencies">
<title>Declaring Resource Dependencies</title>
<para>The bottom window is where an annotator declares an external resource
@@ -1682,7 +1682,7 @@
will get direct access to the data file.</para>
</section>
- <section>
+ <section id="ugr.tug.aae.resources.accessing_from_uimacontext">
<title>Accessing the Resource from the UimaContext</title>
<para> If you look at the
@@ -1723,7 +1723,7 @@
</section>
- <section>
+ <section id="ugr.tug.aae.resources.declaring_and_bindings">
<title>Declaring Resources and Bindings</title>
<para>Refer back to the top window in the Resources page of the Component Descriptor
@@ -1826,7 +1826,8 @@
made our external resource dependencies explicit in the descriptor, which will
help others to deploy our annotator.</para>
</section>
- <section><title>Sharing Resources between Annotators</title>
+ <section id="ugr.tug.aae.resources.sharing_among_annotators">
+ <title>Sharing Resources among Annotators</title>
<para>Another advantage of the Resource Manager is that it allows our data to be
shared between annotators. To demonstrate this we have developed another
@@ -1932,7 +1933,8 @@
</section>
- <section><title>Default ResultSpecification</title>
+ <section id="ugr.tug.aae.result_spec.default">
+ <title>Default ResultSpecification</title>
<para>The default Result Specification is taken from the Engine's output
Capability Specification. Remember that a Capability Specification has both
@@ -1943,7 +1945,8 @@
</section>
- <section><title>Passing Result Specifications to Annotators</title>
+ <section id="ugr.tug.aae.result_spec.passing_to_annotators">
+ <title>Passing Result Specifications to Annotators</title>
<para>If you are not using aggregation or collection processing, but instead are
instantiating your own primitive analysis engines and calling their process
@@ -1954,13 +1957,15 @@
Result Specification is created and passed, as above.</para>
</section>
- <section><title>Aggregates</title>
+ <section id="ugr.tug.aae.result_spec.aggregates">
+ <title>Aggregates</title>
<para>For aggregate engines, the value passed to the primitive annotator code depends
on the kind of flow.</para>
- </section>
+
- <section><title>Fixed Flow</title>
+ <section id="ugr.tug.aae.result_spec.aggregates.fixed_flow">
+ <title>Fixed Flow</title>
<para>For FixedFlow, any ResultSpecification passed into the aggregate is ignored,
and instead, each primitive annotator is passed a result spec that corresponds to the
@@ -1970,7 +1975,8 @@
</section>
- <section><title>CapabilityLanguageFlow</title>
+ <section id="ugr.tug.aae.result_spec.aggregates.capability_language_flow">
+ <title>CapabilityLanguageFlow</title>
<para>For CapabilityLanguageFlow, each annotator is passed a ResultSpecification
that is the intersection of the primitive annotator's output Capability
Specification with the ResultSpecification passed to the aggregate. If this
@@ -1982,8 +1988,10 @@
need to be produced internally in the flow, or else things will not work
properly.</para>
</section>
+
- <section><title>Special rule for skipping Analysis Engines</title>
+ <section id="ugr.tug.aae.skipping_ae_in_capability_language_flow">
+ <title>Special rule for skipping Analysis Engines</title>
<para>When using the CapabilityLanguageFlow, an annotator will be also be skipped if
all of its outputs are in the output capability of some annotator(s) that has (have)
@@ -2002,14 +2010,15 @@
need to be produced, or else things will not work properly.</para>
</section>
- <section><title>Collection Proessing Engines</title>
+ <section id="ugr.tug.aae.result_spec.aggregates.cpes">
+ <title>Collection Proessing Engines</title>
<para>The Default Result Specification is always used for all components of a
Collection Processing Engine.</para>
</section>
-
- <section>
+ </section>
+ <section id="ugr.tug.aae.classpath_when_using_jcas">
<title>Class path setup when using JCas</title>
<para>JCas provides Java classes that correspond to each CAS type in an application.
@@ -2052,7 +2061,7 @@
<para>Other environment variables are used by the shell scripts, as follows:
- <table frame="all">
+ <table frame="all" id="ugr.aae.tbl.env_vars_used_by_shell_scripts">
<title>Environment variables used by the shell scripts</title>
<tgroup cols="2" rowsep="1" colsep="1">
<colspec colname="c1"/>
@@ -2091,14 +2100,14 @@
<entry>(Optional) if specified, the network IP name of the host running the
Vinci Name Server (VNS) (see <olink
targetdoc="&uima_docs_tutorial_guides;"
- targetptr="ugr.tug.app_dev.vns"/>)</entry>
+ targetptr="ugr.tug.application.vns"/>)</entry>
</row>
<row>
<entry>VNS_PORT</entry>
<entry>(Optional) if specified, the network IP port number of the Vinci
Name Server (VNS) (see <olink
targetdoc="&uima_docs_tutorial_guides;"
- targetptr="ugr.tug.app_dev.vns"/>)</entry>
+ targetptr="ugr.tug.application.vns"/>)</entry>
</row>
<row>
<entry>ECLIPSE_HOME</entry>
@@ -2334,10 +2343,11 @@
</section>
- <section id="ugr.tug.aae.xml_intro_configuration_parameters">
+ <section id="ugr.tug.aae.xml_intro.configuration_parameters">
<title>Configuration Parameters (Optional)</title>
- <section><title>Configuration Parameter Declarations</title>
+ <section id="ugr.tug.aae.xml_intro.configuration_parameters_declarations">
+ <title>Configuration Parameter Declarations</title>
<programlisting>
@@ -2426,7 +2436,7 @@
</section>
- <section>
+ <section id="ugr.tug.aae.xml_intro.aggregate">
<title>Aggregate Analysis Engine Descriptor</title>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.application.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.application.xml?view=diff&rev=482771&r1=482770&r2=482771
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.application.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.application.xml Tue Dec 5 12:39:49 2006
@@ -250,10 +250,11 @@
<para>See:</para>
<itemizedlist><listitem><para> <olink
- targetdoc="ugr.tug.aae.developing_your_annotator"/> </para>
+ targetdoc="&uima_docs_tutorial_guides;"
+ targetptr="ugr.tug.aae.developing_annotator_code"/> </para>
</listitem>
- <listitem><para> <olink targetdoc="ugr.ref.jcas"/> </para></listitem>
+ <listitem><para> <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.jcas"/></para></listitem>
<listitem><para> The source code for
<literal>org.apache.uima.examples.AnnotationFilter</literal>, which is
@@ -422,7 +423,7 @@
<para>In most cases, the easiest way to use multiple Analysis Engines from within an
application is to combine them into an aggregate AE. For instructions, see <olink
targetdoc="&uima_docs_tutorial_guides;"
- targetptr="ugr.tug.aae.building_aggregate_aes"/>. Be sure that you
+ targetptr="ugr.tug.aae.building_aggregates"/>. Be sure that you
understand this method before deciding to use the more advanced feature described in
this section.</para>
@@ -903,7 +904,7 @@
<para>Run the CPE Configurator tool by executing the <literal>cpeGui</literal>
shell script in the <literal>bin</literal> directory of the UIMA SDK. (For
instructions on using this tool, see the <olink targetdoc="&uima_docs_tools;"
- targetptr="ugr.tools.cpe_configurator"/>.)</para>
+ targetptr="ugr.tools.cpe"/>.)</para>
<para>In the CPE Configurator tool, select the following components by browsing to
their descriptors:</para>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cas_multiplier.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cas_multiplier.xml?view=diff&rev=482771&r1=482770&r2=482771
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cas_multiplier.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cas_multiplier.xml Tue Dec 5 12:39:49 2006
@@ -125,7 +125,7 @@
<literal>org.apache.uima.examples.casMultiplier.SimpleTextSegmenter</literal> and the source
code is included in the UIMA SDK under the <literal>examples/src</literal> directory.</para>
- <section>
+ <section id="ugr.tug.cm.example_code.overall_structure">
<title>Overall Structure</title>
@@ -156,7 +156,7 @@
</section>
- <section>
+ <section id="ugr.tug.cm.example_code.initialize">
<title>Initialize Method</title>
@@ -174,7 +174,7 @@
</section>
- <section>
+ <section id="ugr.tug.cm.example_code.process">
<title>Process Method</title>
@@ -208,7 +208,7 @@
</section>
- <section>
+ <section id="ugr.tug.cm.example_code.hasnext">
<title>HasNext Method</title>
@@ -222,7 +222,7 @@
</section>
- <section>
+ <section id="ugr.tug.cm.example_code.next">
<title>Next Method</title>
@@ -473,7 +473,7 @@
occurring inside it is hidden from users of that Analysis Engine.</para> <note>
<para>If you want to output some new Output CASes and not others, you need to implement a custom Flow Controller
that makes this decision — see <olink targetdoc="&uima_docs_tutorial_guides;"
- targetptr="ugr.tug.fc."/>. </para> </note>
+ targetptr="ugr.tug.fc"/>. </para> </note>
</section>
</section>
@@ -595,7 +595,7 @@
<para>An example CAS Multiplier that merges CASes can be found is provided in the UIMA SDK. The Java class for
this example is <literal>org.apache.uima.examples.casMultiplier.SimpleTextMerger</literal> and
the source code is located under the <literal>examples/src</literal> directory.</para>
- <section>
+ <section id="ugr.tug.cm.example_cas_merger.process">
<title>Process Method</title>
<para>Almost all of the code for this example is in the <literal>process</literal> method. The first part of
the <literal>process</literal> method shows how to copy Feature Structures from the input CAS to the
@@ -687,7 +687,7 @@
FeatureStructure), and then sets the <literal>mReadyToOutput</literal> field to true. This field is
then used in the <literal>hasNext</literal> and <literal>next</literal> methods.</para>
</section>
- <section>
+ <section id="ugr.tug.cm.example_cas_merger.hasnext_and_next">
<title>HasNext and Next Methods</title>
<para>These methods are relatively simple:</para>
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=482771&r1=482770&r2=482771
==============================================================================
--- 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 Tue Dec 5 12:39:49 2006
@@ -45,14 +45,14 @@
<para>A Collection Reader provides the interface to the raw input data and knows how to
iterate over the data collection. Collection Readers are discussed in <xref
- linkend="ugr.tug.cpe.developing_collection_readers"/>. The CAS Initializer
+ linkend="ugr.tug.cpe.collection_reader.developing"/>. The CAS Initializer
<footnote><para>CAS Initializers are deprecated in favor of a more general mechanism,
multiple subjects of analysis.</para></footnote> prepares an individual data item for
analysis and loads it into the CAS. CAS Initializers are discussed in <xref
- linkend="ugr.tug.cpe.developing_cas_initializers"/> A CAS Consumer extracts
+ linkend="ugr.tug.cpe.cas_initializer.developing"/> A CAS Consumer extracts
analysis results from the CAS and may also perform <emphasis>collection level
processing</emphasis>, or analysis over a collection of CASes. CAS Consumers are
- discussed in <xref linkend="ugr.tug.cpe.developing_cas_consumers"/>.</para>
+ discussed in <xref linkend="ugr.tug.cpe.cas_consumer.developing"/>.</para>
<para>Analysis Engines and CAS Consumers are both instances of <emphasis>CAS
Processors</emphasis>. A Collection Processing Engine (CPE) may contain multiple CAS
@@ -72,7 +72,7 @@
provides a graphical tool, called the CPE Configurator, for assisting in the assembly of
CPEs. Use of this tool is summarized in <xref
linkend="ugr.tug.cpe.cpe_configurator"/>, and more details can be found in <olink
- targetdoc="&uima_docs_tools;" targetptr="ugr.tools.cpe_configurator"/>.
+ targetdoc="&uima_docs_tools;" targetptr="ugr.tools.cpe"/>.
Alternatively, a CPE can be assembled by writing an XML CPE descriptor. Details on the CPE
descriptor, including its syntax and content, can be found in the <olink
targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe"/>. The individual
@@ -305,7 +305,7 @@
<para>If you have followed the instructions in <olink
targetdoc="&uima_docs_overview;"
- targetptr="ugr.overview.eclipse_setup"/> and imported the example Eclipse
+ targetptr="ugr.ovv.eclipse_setup"/> and imported the example Eclipse
project, then you should already have a Run configuration for the CPE Configurator
tool (called <literal>UIMA CPE GUI</literal>) configured to run in the example
project. Simply run that configuration to start the CPE Configurator.</para>
@@ -405,7 +405,7 @@
which you have defined at least one constructor does not get a default 0-argument
constructor.)</para>
- <section id="ugr.tug.cpe.developing_collection_readers">
+ <section id="ugr.tug.cpe.collection_reader.developing">
<title>Developing Collection Readers</title>
<para>A Collection Reader is responsible for obtaining documents from the collection
@@ -420,7 +420,8 @@
<literal>%UIMA_HOME%/examples/src/main/descriptors/collection_reader/
FileSystemCollectionReader.xml</literal>.</para>
- <section><title>Java Class for the Collection Reader</title>
+ <section id="ugr.tug.cpe.collection_reader.java_class">
+ <title>Java Class for the Collection Reader</title>
<para>The Java class for a Collection Reader must implement the
<literal>org.apache.uima.collection.CollectionReader</literal>
@@ -463,11 +464,14 @@
for more details.</para>
</section>
- <section><title>Required Methods in the Collection Reader class</title>
+ <section id="ugr.tug.cpe.collection_reader.required_methods">
+ <title>Required Methods in the Collection Reader class</title>
+
<para>The following abstract methods must be implemented:</para>
- <section><title>initialize()</title>
+ <section id="ugr.tug.cpe.collection_reader.required_methods.initialize">
+ <title>initialize()</title>
<para>The <literal>initialize()</literal> method is called by the framework
when the Collection Reader is first created.
@@ -510,7 +514,8 @@
</section>
- <section><title>hasNext()</title>
+ <section id="ugr.tug.cpe.collection_reader.hasnext">
+ <title>hasNext()</title>
<para>The <literal>hasNext()</literal> method returns whether or not there are
any documents remaining to be read from the collection. The File System
@@ -526,7 +531,8 @@
</section>
- <section><title>getNext(CAS)</title>
+ <section id="ugr.tug.cpe.collection_reader.required_methods.getnext">
+ <title>getNext(CAS)</title>
<para>The <literal>getNext()</literal> method reads the next document from the
collection and populates a CAS. In the simple case, this amounts to reading the
@@ -621,7 +627,7 @@
<para>CAS Initializers are now deprecated. If you have complex initialization,
it is better to do this using one or more annotators that create new Subjects of
Analysis (see <olink targetdoc="&uima_docs_tutorial_guides;"
- targetptr="ugr.tug.multi_views"/>).</para>
+ targetptr="ugr.tug.mvs"/>).</para>
<!--However, if you are doing complex
initialization of the CAS, it may be better to use a CAS Initializer as
@@ -629,7 +635,8 @@
</a>. -->
</section>
- <section><title>getProgress()</title>
+ <section id="ugr.tug.cpe.collection_reader.required_methods.getprogress">
+ <title>getProgress()</title>
<para>The Collection Reader is responsible for returning progress information;
that is, how much of the collection has been read thus far and how much remains to be
read. The framework defines progress very generally; the Collection Reader
@@ -657,7 +664,8 @@
</section>
- <section><title>close()</title>
+ <section id="ugr.tug.cpe.collection_reader.required_methods.close">
+ <title>close()</title>
<para>The close method is called when the Collection Reader is no longer needed.
The Collection Reader should then release any resources it may be holding. The
@@ -669,16 +677,19 @@
</section>
- <section><title>Optional Methods</title>
+ <section id="ugr.tug.cpe.collection_reader.optional_methods">
+ <title>Optional Methods</title>
<para>The following methods may be implemented:</para>
- <section><title>reconfigure()</title>
+ <section id="ugr.tug.cpe.collection_reader.optional_methods.reconfigure">
+ <title>reconfigure()</title>
<para>This method is called if the Collection Reader's configuration
parameters change.</para>
</section>
- <section><title>typeSystemInit()</title>
+ <section id="ugr.tug.cpe.collection_reader.optional_methods.typesysteminit">
+ <title>typeSystemInit()</title>
<para>If you are only setting the document text in the CAS, or if you are using the
JCas (recommended, as in the current example, you do not have to implement this
@@ -689,7 +700,8 @@
</section>
</section>
- <section><title>Threading considerations</title>
+ <section id="ugr.tug.cpe.collection_reader.threading">
+ <title>Threading considerations</title>
<para>Collection readers do not have to be thread safe; they are run with a single
thread per instance, and only one instance per instance of the Collection
@@ -697,7 +709,8 @@
</section>
- <section><title>XML Descriptor for a Collection Reader</title>
+ <section id="ugr.tug.cpe.collection_reader.descriptor">
+ <title>XML Descriptor for a Collection Reader</title>
<para>You can use the Component Description Editor to create and / or edit the File
System Collection Reader's descriptor. Here is its descriptor
@@ -779,11 +792,11 @@
</section>
</section>
- <section id="ugr.tug.cpe.developing_cas_initializers"><title>Developing CAS
+ <section id="ugr.tug.cpe.cas_initializer.developing"><title>Developing CAS
Initializers</title> <note><para>CAS Initializers are now deprecated (as of
version 2.1). For complex initialization, please use instead the capabilities of
creating additional Subjects of Analysis (see <olink
- targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.multi_views"/>
+ targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.mvs"/>
). </para></note>
<para>Although Collection Readers can directly write to the CAS, it is best that they do
@@ -907,7 +920,7 @@
been supplied, and call the CAS Initializer's
<literal>initializeCas()</literal> method, rather than setting up the CAS
itself. Our File System Collection Reader example, <xref
- linkend="ugr.tug.cpe.developing_collection_readers"/>, optionally uses a
+ linkend="ugr.tug.cpe.collection_reader.developing"/>, optionally uses a
CAS Initializer as follows:
@@ -927,7 +940,7 @@
</section>
- <section id="ugr.tug.cpe.developing_cas_consumers"><title>Developing CAS
+ <section id="ugr.tug.cpe.cas_consumer.developing"><title>Developing CAS
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
@@ -968,13 +981,14 @@
<literal>%UIMA_HOME%/examples/descriptors/cas_consumer/XmiWriterCasConsumer.xml</literal>
.</para>
- <section><title>Required Methods for a CAS Consumer</title>
+ <section id="ugr.tug.cpe.cas_consumer.required_methods">
+ <title>Required Methods for a CAS Consumer</title>
<para>When extending the convenience class
<literal>org.apache.uima.collection.CasConsumer_ImplBase</literal>, the
following abstract methods must be implemented:</para>
- <section>
+ <section id="ugr.tug.cpe.cas_consumer.required_methods.initialize">
<title>initialize()</title>
<para>The <literal>initialize()</literal> method is called by the framework
when the CAS Consumer is first created.
@@ -999,7 +1013,8 @@
</programlisting></para>
</section>
- <section><title>processCas()</title>
+ <section id="ugr.tug.cpe.cas_consumer.required_methods.processcas">
+ <title>processCas()</title>
<para>The <literal>processCas()</literal> method is where the CAS Consumer
does most of its work. In our example, the XMI Writer CAS Consumer obtains an
@@ -1063,10 +1078,12 @@
</section>
- <section><title>Optional Methods></title>
+ <section id="ugr.tug.cpe.cas_consumer.optional_methods">
+ <title>Optional Methods></title>
<para>The following methods are optional in a CAS Consumer, though they are often
used.</para>
- <section><title>batchProcessComplete()</title>
+ <section id="ugr.tug.cpe.cas_consumer.optional_methods.batchprocesscomplete">
+ <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
@@ -1075,7 +1092,8 @@
Collection Processing Engine descriptor.</para>
</section>
- <section><title>collectionProcessComplete()</title>
+ <section id="ugr.tug.cpe.cas_consumer.optional_methods.collectionprocesscomplete">
+ <title>collectionProcessComplete()</title>
<para>The framework calls the collectionProcessComplete() method at the end
of the collection (i.e., when all objects in the collection have been
@@ -1152,14 +1170,14 @@
accomplished using <emphasis>Vinci</emphasis>, a communication protocol used by
the CPM and which is provided as a part of Apache UIMA. Vinci handles service naming and
location and data transport (see <olink targetdoc="&uima_docs_tutorial_guides;"
- targetptr="ugr.tug.application.deploy_as_vinci_service"/> for more
+ targetptr="ugr.tug.application.how_to_deploy_a_vinci_service"/> for more
information). Service naming and location are provided by a <emphasis>Vinci Naming
Service</emphasis>, or <emphasis>VNS</emphasis>. For managed CAS Processors, the
CPE uses its own internal VNS. For non-managed CAS Processors, a separate VNS must be
running.</para> <note><para>The UIMA SDK also supports using unmanaged remote
services via the web-standard SOAP communications protocol (see <olink
targetdoc="&uima_docs_tutorial_guides;"
- targetptr="ugr.tug.application.deploy_as_soap_service"/>. This approach is
+ targetptr="ugr.tug.application.how_to_deploy_as_soap"/>. This approach is
based on a proxy implementation, where the proxy is essentially running in an integrated
mode. To use this approach with the CPM, use the Integrated mode, with the component being
an Aggregate which, in turn, connects to a remote service. </para></note>
@@ -1279,7 +1297,7 @@
running on the network. This VNS must be manually started and monitored by the end user
or application. Instructions for running a VNS can be found in <olink
targetdoc="&uima_docs_tutorial_guides;"
- targetptr="ugr.tug.application.starting_vns"/>.</para>
+ targetptr="ugr.tug.application.vns.starting"/>.</para>
<para>To deploy a non-managed CAS Processor, the CPE deployer must change the CPE
descriptor. The following is a section from the CPE descriptor that shows an example
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=482771&r1=482770&r2=482771
==============================================================================
--- 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 Tue Dec 5 12:39:49 2006
@@ -113,7 +113,8 @@
and the source code is included in the UIMA SDK under the
<literal>examples/src</literal> directory.</para>
- <section><title>The WhiteboardFlowController Class</title>
+ <section id="ugr.tug.fc.whiteboard">
+ <title>The WhiteboardFlowController Class</title>
<programlisting>public class WhiteboardFlowController extends CasFlowController_ImplBase {
@@ -143,7 +144,8 @@
not be any confusion.</para>
</section>
- <section><title>The WhiteboardFlow Class</title>
+ <section id="ugr.tug.fc.whiteboardflow">
+ <title>The WhiteboardFlow Class</title>
<programlisting>class WhiteboardFlow extends CasFlow_ImplBase {
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.multi_views.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.multi_views.xml?view=diff&rev=482771&r1=482770&r2=482771
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.multi_views.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.multi_views.xml Tue Dec 5 12:39:49 2006
@@ -172,7 +172,7 @@
targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.component_descriptor"/>. The Component Descriptor
Editor supports Sofa declarations on the <olink targetdoc="&uima_docs_tools;"
- targetptr="ugr.tools.cde.capabilities_page"/>.</para>
+ targetptr="ugr.tools.cde.capabilities"/>.</para>
</section>
</section>
@@ -275,7 +275,7 @@
<para>The Component Descriptor Editor supports Sofa name mapping in aggregates and
simplifies the task. See <olink targetdoc="&uima_docs_tools;"
- targetptr="ugr.tools.cde.sofa_name_mappings"/> for details.</para>
+ targetptr="ugr.tools.cde.capabilities.sofa_name_mapping"/> for details.</para>
</section>
@@ -452,7 +452,8 @@
<listitem><para>The strong affinity of annotations with a specific Sofa. </para>
</listitem></itemizedlist>
- <section><title>Annotator Descriptor</title>
+ <section id="ugr.tug.mvs.sample_application.descriptor">
+ <title>Annotator Descriptor</title>
<para>The annotator descriptor in
<literal>examples/descriptors/analysis_engine/SofaExampleAnnotator.xml</literal>
@@ -480,7 +481,8 @@
</section>
- <section><title>Application Setup</title>
+ <section id="ugr.tug.mvs.sample_application.setup">
+ <title>Application Setup</title>
<para>The application driver instantiates an analysis engine,
<literal>seAnnotator</literal>, from the annotator descriptor, obtains a new
@@ -503,7 +505,8 @@
</section>
- <section><title>Annotator Processing</title>
+ <section id="ugr.tug.mvs.sample_application.annotator_processing">
+ <title>Annotator Processing</title>
<para>Annotator processing consists of parsing the English document into individual
words, doing word-by-word translation and concatenating the translations into a
@@ -538,7 +541,8 @@
</section>
- <section><title>Accessing the results of analysis</title>
+ <section id="ugr.tug.mvs.sample_application.accessing_results">
+ <title>Accessing the results of analysis</title>
<para>The application needs to get the results of analysis, which may be in different
views. Analysis results for each Sofa are dumped independently by iterating over all
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tutorials_and_users_guides.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tutorials_and_users_guides.xml?view=diff&rev=482771&r1=482770&r2=482771
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tutorials_and_users_guides.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tutorials_and_users_guides.xml Tue Dec 5 12:39:49 2006
@@ -36,4 +36,4 @@
<xi:include href="tug.multi_views.xml"/>
<xi:include href="tug.cas_multiplier.xml"/>
<xi:include href="tug.xmi_emf.xml"/>
- </book>
+</book>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/html-target.db
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/html-target.db?view=diff&rev=482771&r1=482770&r2=482771
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/html-target.db (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/html-target.db Tue Dec 5 12:39:49 2006
@@ -307,7 +307,7 @@
<xreftext>Section 2.8, âNext Stepsâ</xreftext>
</div>
</div>
- <div element="chapter" href="ch03.html" number="3" targetptr="ugr.eclipse_setup">
+ <div element="chapter" href="ch03.html" number="3" targetptr="ugr.ovv.eclipse_setup">
<ttl>Setting up Eclipse IDE to work with UIMA</ttl>
<xreftext>Chapter 3, <i>Setting up Eclipse IDE to work with UIMA</i>
</xreftext>
@@ -339,7 +339,7 @@
</div>
</div>
</div>
- <div element="section" href="ch03s02.html" number="3.2" targetptr="ugr.eclipse_setup.example_code">
+ <div element="section" href="ch03s02.html" number="3.2" targetptr="ugr.ovv.eclipse_setup.example_code">
<ttl>Setting up Eclipse to view Example Code</ttl>
<xreftext>Section 3.2, âSetting up Eclipse to view Example Codeâ</xreftext>
</div>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/htmlsingle-target.db
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/htmlsingle-target.db?view=diff&rev=482771&r1=482770&r2=482771
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/htmlsingle-target.db (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/htmlsingle-target.db Tue Dec 5 12:39:49 2006
@@ -307,7 +307,7 @@
<xreftext>Section 2.8, âNext Stepsâ</xreftext>
</div>
</div>
- <div element="chapter" href="#ugr.eclipse_setup" number="3" targetptr="ugr.eclipse_setup">
+ <div element="chapter" href="#ugr.ovv.eclipse_setup" number="3" targetptr="ugr.ovv.eclipse_setup">
<ttl>Setting up Eclipse IDE to work with UIMA</ttl>
<xreftext>Chapter 3, <i>Setting up Eclipse IDE to work with UIMA</i>
</xreftext>
@@ -339,7 +339,7 @@
</div>
</div>
</div>
- <div element="section" href="#ugr.eclipse_setup.example_code" number="3.2" targetptr="ugr.eclipse_setup.example_code">
+ <div element="section" href="#ugr.ovv.eclipse_setup.example_code" number="3.2" targetptr="ugr.ovv.eclipse_setup.example_code">
<ttl>Setting up Eclipse to view Example Code</ttl>
<xreftext>Section 3.2, âSetting up Eclipse to view Example Codeâ</xreftext>
</div>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/pdf-target.db
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/pdf-target.db?view=diff&rev=482771&r1=482770&r2=482771
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/pdf-target.db (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/pdf-target.db Tue Dec 5 12:39:49 2006
@@ -307,7 +307,7 @@
<xreftext>Section 2.8, âNext Stepsâ</xreftext>
</div>
</div>
- <div element="chapter" href="#ugr.eclipse_setup" number="3" targetptr="ugr.eclipse_setup">
+ <div element="chapter" href="#ugr.ovv.eclipse_setup" number="3" targetptr="ugr.ovv.eclipse_setup">
<ttl>Setting up Eclipse IDE to work with UIMA</ttl>
<xreftext>Chapter 3, <fo:inline xmlns:fo="http://www.w3.org/1999/XSL/Format" font-style="italic">Setting up Eclipse IDE to work with UIMA</fo:inline>
</xreftext>
@@ -339,7 +339,7 @@
</div>
</div>
</div>
- <div element="section" href="#ugr.eclipse_setup.example_code" number="3.2" targetptr="ugr.eclipse_setup.example_code">
+ <div element="section" href="#ugr.ovv.eclipse_setup.example_code" number="3.2" targetptr="ugr.ovv.eclipse_setup.example_code">
<ttl>Setting up Eclipse to view Example Code</ttl>
<xreftext>Section 3.2, âSetting up Eclipse to view Example Codeâ</xreftext>
</div>