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/09 19:58:09 UTC
svn commit: r485030 [2/4] - in /incubator/uima/uimaj/trunk/uima-docbooks: ./
src/docbook/ src/docbook/overview_and_setup/ src/docbook/references/
src/docbook/tools/ src/docbook/tutorials_and_users_guides/ src/olink/
src/olink/overview_and_setup/ src/ol...
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=485030&r1=485029&r2=485030
==============================================================================
--- 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 Sat Dec 9 10:58:06 2006
@@ -25,6 +25,7 @@
-->
<chapter id="ugr.tug.aae">
<title>Annotator and Analysis Engine Developer's Guide</title>
+ <titleabbrev>Annotator & AE Developer's Guide</titleabbrev>
<para>This chapter describes how to develop UIMA <emphasis>type systems</emphasis>,
<emphasis>Annotators</emphasis> and <emphasis>Analysis Engines</emphasis> using
@@ -85,27 +86,27 @@
<itemizedlist>
<listitem>
- <para><emphasis role="bolditalic"><xref
- linkend="ugr.tug.aae.getting_started"/></emphasis> is a tutorial with
+ <para><emphasis role="bold"><emphasis role="italic"><xref
+ linkend="ugr.tug.aae.getting_started"/></emphasis></emphasis> is a tutorial with
step-by-step instructions for how to develop and test a simple UIMA
annotator.</para>
</listitem>
<listitem>
- <para><emphasis role="bolditalic"><xref
- linkend="ugr.tug.aae.logging.configuring"/></emphasis> discusses how to
+ <para><emphasis role="bold"><emphasis role="italic"><xref
+ linkend="ugr.tug.aae.logging.configuring"/></emphasis></emphasis> discusses how to
make your UIMA annotator configurable, and how it can write messages to the UIMA log
file.</para>
</listitem>
<listitem>
- <para> <emphasis role="bolditalic"><xref
- linkend="ugr.tug.aae.building_aggregates"/></emphasis> describes how
+ <para> <emphasis role="bold"><emphasis role="italic"><xref
+ linkend="ugr.tug.aae.building_aggregates"/></emphasis></emphasis> describes how
annotators can be combined into aggregate analysis engines. It also describes how
one annotator can make use of the analysis results produced by an annotator that has
run previously.</para>
</listitem>
</itemizedlist>
- <para><emphasis role="bolditalic">Other examples</emphasis></para>
+ <para><emphasis role="bold"><emphasis role="italic">Other examples</emphasis></emphasis></para>
<para>The UIMA SDK include several other examples you may find interesting,
including</para>
@@ -118,12 +119,12 @@
example, hooks up with the Open Source Apache Derby database. </para></listitem>
</itemizedlist>
- <para><emphasis role="bolditalic">Additional Topics</emphasis> describes
+ <para><emphasis role="bold"><emphasis role="italic">Additional Topics</emphasis></emphasis> describes
additional features of the UIMA SDK that may help you in building your own annotators and
analysis engines.</para>
- <para><emphasis role="bolditalic"><xref linkend="ugr.tug.aae.common_pitfalls"/>
- </emphasis> contains some useful guidelines to help you ensure that your annotators will
+ <para><emphasis role="bold"><emphasis role="italic"><xref linkend="ugr.tug.aae.common_pitfalls"/>
+ </emphasis></emphasis> contains some useful guidelines to help you ensure that your annotators will
work correctly in any UIMA application.</para>
<para>This guide does not discuss how to build UIMA Applications, which are programs that
@@ -216,7 +217,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="575" depth="339" format="JPG" fileref="&imgroot;image002.jpg"/>
+ <imagedata width="575px" format="JPG" fileref="&imgroot;image002.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of editor for Type System Definitions</phrase></textobject>
</mediaobject>
@@ -251,12 +252,11 @@
System displayed above in the editor:</para>
- <programlisting>
-<![CDATA[
- <?xml version="1.0" encoding="UTF-8" ?>
+ <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8" ?>
<typeSystemDescription xmlns="http://uima.apache.org/resourceSpecifier">
<name>TutorialTypeSystem</name>
- <description>Type System Definition for the tutorial examples - as of Exercise 1</description>
+ <description>Type System Definition for the tutorial examples -
+ as of Exercise 1</description>
<vendor>IBM</vendor>
<version>1.0</version>
<types>
@@ -273,9 +273,7 @@
</features>
</typeDescription>
</types>
- </typeSystemDescription>
-]]>
- </programlisting>
+ </typeSystemDescription>]]></programlisting>
</section>
@@ -297,7 +295,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="575" depth="83" format="JPG" fileref="&imgroot;image004.jpg"/>
+ <imagedata width="575px" format="JPG" fileref="&imgroot;image004.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of enabling automatic running of JCasGen</phrase></textobject>
</mediaobject>
@@ -318,7 +316,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="534" depth="279" format="JPG" fileref="&imgroot;image006.jpg"/>
+ <imagedata width="534px" format="JPG" fileref="&imgroot;image006.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of JCasGen</phrase></textobject>
</mediaobject>
@@ -392,8 +390,7 @@
directory.</para>
- <programlisting>
-package org.apache.uima.tutorial.ex1;
+ <programlisting>package org.apache.uima.tutorial.ex1;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
@@ -403,16 +400,16 @@
import org.apache.uima.tutorial.RoomNumber;
/**
- * Example annotator that detects room numbers using Java 1.4 regular expressions.
+ * Example annotator that detects room numbers using
+ * Java 1.4 regular expressions.
*/
public class RoomNumberAnnotator extends JCasAnnotator_ImplBase {
- private Pattern mYorktownPattern = Pattern.compile("\\b[0-4]\\d-[0-2]\\d\\d\\b");
+ private Pattern mYorktownPattern =
+ Pattern.compile("\\b[0-4]\\d-[0-2]\\d\\d\\b");
- private Pattern mHawthornePattern = Pattern.compile("\\b[G1-4][NS]-[A-Z]\\d\\d\\b");
+ private Pattern mHawthornePattern =
+ Pattern.compile("\\b[G1-4][NS]-[A-Z]\\d\\d\\b");
- /**
- * @see JCasAnnotator_ImplBase#process(JCas)
- */
public void process(JCas aJCas) {
// Discussed Later
}
@@ -438,35 +435,34 @@
changes.</para></footnote></para>
- <programlisting>
- public void process(JCas aJCas) {
- // get document text
- String docText = aJCas.getDocumentText();
- // search for Yorktown room numbers
- Matcher matcher = mYorktownPattern.matcher(docText);
- int pos = 0;
- while (matcher.find(pos)) {
- // found one - creation annotation
- RoomNumber annotation = new RoomNumber(aJCas);
- annotation.setBegin(matcher.start());
- annotation.setEnd(matcher.end());
- annotation.setBuilding("Yorktown");
- annotation.addToIndexes();
- pos = matcher.end();
- }
- // search for Hawthorne room numbers
- matcher = mHawthornePattern.matcher(docText);
- pos = 0;
- while (matcher.find(pos)) {
- // found one - creation annotation
- RoomNumber annotation = new RoomNumber(aJCas);
- annotation.setBegin(matcher.start());
- annotation.setEnd(matcher.end());
- annotation.setBuilding("Hawthorne");
- annotation.addToIndexes();
- pos = matcher.end();
- }
+ <programlisting>public void process(JCas aJCas) {
+ // get document text
+ String docText = aJCas.getDocumentText();
+ // search for Yorktown room numbers
+ Matcher matcher = mYorktownPattern.matcher(docText);
+ int pos = 0;
+ while (matcher.find(pos)) {
+ // found one - creation annotation
+ RoomNumber annotation = new RoomNumber(aJCas);
+ annotation.setBegin(matcher.start());
+ annotation.setEnd(matcher.end());
+ annotation.setBuilding("Yorktown");
+ annotation.addToIndexes();
+ pos = matcher.end();
+ }
+ // search for Hawthorne room numbers
+ matcher = mHawthornePattern.matcher(docText);
+ pos = 0;
+ while (matcher.find(pos)) {
+ // found one - creation annotation
+ RoomNumber annotation = new RoomNumber(aJCas);
+ annotation.setBegin(matcher.start());
+ annotation.setEnd(matcher.end());
+ annotation.setBuilding("Hawthorne");
+ annotation.addToIndexes();
+ pos = matcher.end();
}
+}
</programlisting>
<para>The Matcher class is part of the java.util.regex package and is used to find the
@@ -474,12 +470,11 @@
simple as creating a new Java object and calling some set methods:</para>
- <programlisting>
- RoomNumber annotation = new RoomNumber(aJCas);
- annotation.setBegin(matcher.start());
- annotation.setEnd(matcher.end());
- annotation.setBuilding("Yorktown");
- </programlisting>
+ <programlisting>RoomNumber annotation = new RoomNumber(aJCas);
+annotation.setBegin(matcher.start());
+annotation.setEnd(matcher.end());
+annotation.setBuilding("Yorktown");
+</programlisting>
<para>The <literal>RoomNumber</literal> class was generated from the type system
description by the Component Descriptor Editor or the JCasGen tool, as discussed in
@@ -545,7 +540,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="575" depth="313" format="JPG" fileref="&imgroot;image008.jpg"/>
+ <imagedata width="575px" format="JPG" fileref="&imgroot;image008.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of Component Descriptor Editor overview page</phrase>
</textobject>
@@ -574,7 +569,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="576" depth="257" format="JPG" fileref="&imgroot;image010.jpg"/>
+ <imagedata width="576px" format="JPG" fileref="&imgroot;image010.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of CDE Type System page</phrase></textobject>
</mediaobject>
@@ -587,7 +582,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="511" depth="398" format="JPG" fileref="&imgroot;image012.jpg"/>
+ <imagedata width="511px" format="JPG" fileref="&imgroot;image012.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of CDE Capabilities page</phrase></textobject>
</mediaobject>
@@ -632,7 +627,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="576" depth="294" format="JPG" fileref="&imgroot;image014.jpg"/>
+ <imagedata width="576px" format="JPG" fileref="&imgroot;image014.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of UIMA Document Analyzer GUI</phrase></textobject>
</mediaobject>
@@ -661,7 +656,8 @@
<para>Use the Browse button next to the third item to set the <quote>Location of AE XML
Descriptor</quote> field to the descriptor we've just been discussing
—
- <literal><where-you-installed-uima-e.g.UIMA_HOME>/examples/descriptors/tutorial/ex1/RoomNumberAnnotator.xml</literal>
+ <literal><where-you-installed-uima-e.g.UIMA_HOME>
+ /examples/descriptors/tutorial/ex1/RoomNumberAnnotator.xml</literal>
. Set the other fields to the values shown in the screen shot above (which should be the
default values if this is the first time you've run the Document Analyzer). Then
click the <quote>Run</quote> button to start processing.</para>
@@ -673,7 +669,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="332" depth="255" format="JPG" fileref="&imgroot;image016.jpg"/>
+ <imagedata width="332px" format="JPG" fileref="&imgroot;image016.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of UIMA Document Analyzer Results GUI</phrase></textobject>
</mediaobject>
@@ -688,7 +684,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="510" depth="389" format="JPG" fileref="&imgroot;image018.jpg"/>
+ <imagedata width="510px" format="JPG" fileref="&imgroot;image018.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of UIMA CAS Annotation Viewer GUI</phrase></textobject>
</mediaobject>
@@ -740,7 +736,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="538" depth="364" format="JPG" fileref="&imgroot;image020.jpg"/>
+ <imagedata width="538px" format="JPG" fileref="&imgroot;image020.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of UIMA Component Descriptor Editor (CDE) Parameters page</phrase></textobject>
</mediaobject>
@@ -778,7 +774,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="538" depth="364" format="JPG" fileref="&imgroot;image022.jpg"/>
+ <imagedata width="538px" format="JPG" fileref="&imgroot;image022.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of UIMA Component Descriptor Editor (CDE) Parameter Settings page</phrase></textobject>
</mediaobject>
@@ -804,23 +800,25 @@
body:</para>
- <programlisting>
- /**
- * @see AnalysisComponent#initialize(UimaContext)
- */
- public void initialize(UimaContext aContext) throws ResourceInitializationException {
- super.initialize(aContext);
-
- // Get config. parameter values
- String[] patternStrings = (String[]) aContext.getConfigParameterValue("Patterns");
- mLocations = (String[]) aContext.getConfigParameterValue("Locations");
+ <programlisting>/**
+* @see AnalysisComponent#initialize(UimaContext)
+*/
+public void initialize(UimaContext aContext)
+ throws ResourceInitializationException {
+ super.initialize(aContext);
+
+ // Get config. parameter values
+ String[] patternStrings =
+ (String[]) aContext.getConfigParameterValue("Patterns");
+ mLocations =
+ (String[]) aContext.getConfigParameterValue("Locations");
- // compile regular expressions
- mPatterns = new Pattern[patternStrings.length];
- for (int i = 0; i < patternStrings.length; i++) {
- mPatterns[i] = Pattern.compile(patternStrings[i]);
- }
+ // compile regular expressions
+ mPatterns = new Pattern[patternStrings.length];
+ for (int i = 0; i < patternStrings.length; i++) {
+ mPatterns[i] = Pattern.compile(patternStrings[i]);
}
+}
</programlisting>
<para>Configuration parameter values are accessed through the UimaContext. As you
@@ -906,8 +904,7 @@
<literal>org.apache.uima.tutorial.ex2.RoomNumberAnnotator</literal>:
- <programlisting>
- getContext().getLogger().log(Level.FINEST,"Found: " + annotation);
+ <programlisting>getContext().getLogger().log(Level.FINEST,"Found: " + annotation);
</programlisting>
</para>
@@ -960,8 +957,7 @@
relative to the working directory. For example:
- <programlisting>
- java "-Djava.util.logging.config.file=C:/Program Files/apache/uima/Logger.properties"
+ <programlisting><?db-font-size 60% ?>java "-Djava.util.logging.config.file=C:/Program Files/apache/uima/Logger.properties"
</programlisting>
<note><para>In a shell script, you can use environment variables such as
UIMA_HOME if convenient.</para></note> </para>
@@ -1103,7 +1099,7 @@
<title>Combining Annotators to form an Aggregate Analysis Engine</title>
<mediaobject>
<imageobject>
- <imagedata width="560" depth="320" format="PNG"
+ <imagedata width="560px" format="PNG"
fileref="&imgroot;image024.png"/>
</imageobject>
<textobject> <phrase>Combining Annotators to form an Aggregate Analysis
@@ -1127,7 +1123,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="575" depth="357" format="JPG" fileref="&imgroot;image026.jpg"/>
+ <imagedata width="575px" format="JPG" fileref="&imgroot;image026.jpg"/>
</imageobject>
<textobject>
<phrase>Aggregate page of the Component Descriptor Editor (CDE)</phrase>
@@ -1168,7 +1164,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="526" depth="386" format="JPG" fileref="&imgroot;image028.jpg"/>
+ <imagedata width="526px" format="JPG" fileref="&imgroot;image028.jpg"/>
</imageobject>
<textobject><phrase>Screen shot of the Capabilities page of the Component Descriptor Editor
</phrase></textobject>
@@ -1190,7 +1186,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="525" depth="468" format="JPG" fileref="&imgroot;image030.jpg"/>
+ <imagedata width="525px" format="JPG" fileref="&imgroot;image030.jpg"/>
</imageobject>
<textobject><phrase>Screen shot results of running the Document Analyzer
</phrase></textobject>
@@ -1201,7 +1197,7 @@
</section>
<section id="ugr.tug.aae.aaes_can_contain_cas_consumers">
- <title>Aggregate Engines can also contain CAS Consumers</title>
+ <title>AEs can also contain CAS Consumers</title>
<para>In addition to aggregating Analysis Engines, Aggregates can also contain CAS
Consumers (see <olink targetdoc="&uima_docs_tutorial_guides;"
@@ -1225,8 +1221,7 @@
TimeAnnot annotations in the JCas:
- <programlisting>
-JFSIndexRepository indexes = aJCas.getJFSIndexRepository();
+ <programlisting>JFSIndexRepository indexes = aJCas.getJFSIndexRepository();
FSIndex timeIndex = indexes.getAnnotationIndex(TimeAnnot.type);
Iterator timeIter = timeIndex.iterator();
while (timeIter.hasNext()) {
@@ -1262,7 +1257,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="526" depth="416" format="JPG" fileref="&imgroot;image032.jpg"/>
+ <imagedata width="526px" format="JPG" fileref="&imgroot;image032.jpg"/>
</imageobject>
<textobject><phrase>Screen shot of Capabilities page of the Component Descriptor Editor
</phrase></textobject>
@@ -1284,7 +1279,7 @@
previous engines</title>
<mediaobject>
<imageobject>
- <imagedata width="555" depth="232" format="PNG"
+ <imagedata width="555px" format="PNG"
fileref="&imgroot;image034.png"/>
</imageobject>
<textobject><phrase>An Aggregate Analysis Engine where an internal
@@ -1324,7 +1319,7 @@
<title>Additional Topics</title>
<section id="ugr.tug.aae.contract_for_annotator_methods">
- <title>Contract for Annotator methods called by the Framework</title>
+ <title>Contract: Framework called Annotator methods</title>
<para>Every instance of an Annotator is associated with one and only one thread. An
instance never has to worry about running some method on one thread, and then
@@ -1443,9 +1438,8 @@
this:</para>
- <programlisting>
- throw new AnnotatorConfigurationException(
- "The regular expression " + x + " is not valid.");
+ <programlisting>throw new AnnotatorConfigurationException(
+ "The regular expression " + x + " is not valid.");
</programlisting>
<para>UIMA, however, does not do it this way. All UIMA exceptions are
@@ -1501,16 +1495,15 @@
will see the following code:
- <programlisting>
- try {
- mPatterns[i] = Pattern.compile(patternStrings[i]);
- }
- catch (PatternSyntaxException e) {
- throw new AnnotatorConfigurationException(
- MESSAGE_DIGEST, "regex_syntax_error",
- new Object[]{patternStrings[i]}, e);
- }
-</programlisting>>
+ <programlisting>try {
+ mPatterns[i] = Pattern.compile(patternStrings[i]);
+}
+catch (PatternSyntaxException e) {
+ throw new AnnotatorConfigurationException(
+ MESSAGE_DIGEST, "regex_syntax_error",
+ new Object[]{patternStrings[i]}, e);
+}
+</programlisting>
where the MESSAGE_DIGEST constant has the value <literal>
"org.apache.uima.tutorial.ex5.RoomNumberAnnotator_Messages". </literal>
</para>
@@ -1553,7 +1546,7 @@
<para>Create a file with the .properties extension, where you declare message keys and
their associated messages, using the same syntax as shown above for the
regex_syntax_error exception. The properties file syntax is more completely
- described in the JavaDocs for the <ulink
+ described in the JavaDocs for the <ulink
url="http://java.sun.com/j2se/1.4.1/docs/api/java/util/Properties.html#load(java.io.InputStream)">
load</ulink>> method of the java.util.Properties class.</para>
@@ -1573,18 +1566,16 @@
<para>In your annotator code, throw an exception like this:
-
- <programlisting>
- throw new AnnotatorConfigurationException(
- MESSAGE_DIGEST, "your_message_name",
- new Object[]{param1,param2,...});
+ <programlisting>throw new AnnotatorConfigurationException(
+ MESSAGE_DIGEST, "your_message_name",
+ new Object[]{param1,param2,...});
</programlisting></para>
<para>You may also wish to look at the JavaDocs for the UIMAException class.</para>
- <para>For more information on Java's internationalization features, see the
- Java Internationalization Guide at <ulink
- url="http://java.sun.com/j2se/1.4/docs/guide/intl/index.html"/></para>
+ <para>For more information on Java's internationalization features, see the
+ <ulink url="http://java.sun.com/j2se/1.4/docs/guide/intl/index.html">
+ Java Internationalization Guide</ulink>.</para>
</section>
<section id="ugr.tug.aae.accessing_external_resource_files">
@@ -1627,7 +1618,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="576" depth="446" format="JPG" fileref="&imgroot;image036.jpg"/>
+ <imagedata width="576px" format="JPG" fileref="&imgroot;image036.jpg"/>
</imageobject>
<textobject><phrase>Screen shot of Component Descriptor Editor page for configuring External Resources
</phrase></textobject>
@@ -1645,7 +1636,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="681" depth="354" format="JPG" fileref="&imgroot;image038.jpg"/>
+ <imagedata width="681px" format="JPG" fileref="&imgroot;image038.jpg"/>
</imageobject>
<textobject><phrase>Screen shot of Component Descriptor Editor page for configuring External Resources after
adjusting the layout
@@ -1663,8 +1654,7 @@
dependency. The XML for this is as follows:</para>
- <programlisting><![CDATA[
-<externalResourceDependency>
+ <programlisting><![CDATA[<externalResourceDependency>
<key>AcronymTable</key>
<description>Table of acronyms and their expanded forms.</description>
<interfaceName>org.apache.uima.tutorial.ex6.StringMapResource</interfaceName>
@@ -1691,8 +1681,7 @@
UimaContext by calling:
- <programlisting>
-StringMapResource mMap = (StringMapResource)getContext()getResourceObject("AcronymTable");
+ <programlisting>StringMapResource mMap = (StringMapResource)getContext()getResourceObject("AcronymTable");
</programlisting>
</para>
@@ -1732,9 +1721,7 @@
section of the descriptor:
- <programlisting>
-<![CDATA[
-<resourceManagerConfiguration>
+ <programlisting><![CDATA[<resourceManagerConfiguration>
<externalResources>
<externalResource>
<name>UimaAcronymTableFile</name>
@@ -1812,7 +1799,7 @@
<title>External Resource Binding</title>
<mediaobject>
<imageobject>
- <imagedata width="528" depth="352" format="PNG"
+ <imagedata width="528px" format="PNG"
fileref="&imgroot;image040.png"/>
</imageobject>
<textobject><phrase>External Resource Binding</phrase></textobject>
@@ -1853,7 +1840,7 @@
<title>Component engines of an aggregate share a common resource</title>
<mediaobject>
<imageobject>
- <imagedata width="563" depth="320" format="PNG"
+ <imagedata width="563px" format="PNG"
fileref="&imgroot;image042.png"/>
</imageobject>
<textobject><phrase>Picture of Component engines of an aggregate sharing a
@@ -1872,16 +1859,14 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="572" depth="504" format="JPG" fileref="&imgroot;image044.jpg"/>
+ <imagedata width="572px" format="JPG" fileref="&imgroot;image044.jpg"/>
</imageobject>
<textobject><phrase>UimaMeetingDetectorAE.xml binding a common resource</phrase></textobject>
</mediaobject>
</screenshot>
- <programlisting>
-<![CDATA[
-<externalResourceBindings>
+ <programlisting><![CDATA[<externalResourceBindings>
<externalResourceBinding>
<key>UimaAcronymAnnotator/AcronymTable</key>
<resourceName>UimaAcronymTableFile</resourceName>
@@ -1900,7 +1885,7 @@
(which uses the name AcronymTable) and UimaMeetingAnnotator (which uses
UimaTermTable) to the single declared resource named UimaAcronymFile.
Therefore they will share the same instance. Resource bindings in the aggregate
- descriptor <emphasis role="bolditalic">override</emphasis> any resource
+ descriptor <emphasis role="bold"><emphasis role="italic">override</emphasis></emphasis> any resource
declarations in individual annotator descriptors.</para>
<para>If we wanted to have the annotators use different acronym tables, we could
@@ -2053,9 +2038,8 @@
the documentAnalyzer script:
- <programlisting>
- set UIMA_CLASSPATH=c:abcmyProjectmyJarFile.jar
- documentAnalyzer
+ <programlisting>set UIMA_CLASSPATH=c:abcmyProjectmyJarFile.jar
+documentAnalyzer
</programlisting>
</para>
@@ -2167,7 +2151,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="492" depth="171" format="JPG" fileref="&imgroot;image046.jpg"/>
+ <imagedata width="492px" format="JPG" fileref="&imgroot;image046.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of Eclipse debugger showing non-logical-structure display of
a feature structure</phrase></textobject>
@@ -2182,7 +2166,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="480" depth="24" format="JPG" fileref="&imgroot;image048.jpg"/>
+ <imagedata width="480px" format="JPG" fileref="&imgroot;image048.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of Eclipse debugger showing button to push to
enable viewing logical structures</phrase></textobject>
@@ -2194,7 +2178,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="492" depth="206" format="JPG" fileref="&imgroot;image050.jpg"/>
+ <imagedata width="492px" format="JPG" fileref="&imgroot;image050.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of Eclipse debugger showing logical structure display of
an annotation</phrase></textobject>
@@ -2223,9 +2207,7 @@
<title>Header and Annotator Class Identification</title>
- <programlisting>
-<![CDATA[
-<?xml version="1.0" encoding="UTF-8" ?>
+ <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8" ?>
<!-- Descriptor for the example RoomNumberAnnotator. -->
<analysisEngineDescription xmlns="http://uima.apache.org/resourceSpecifier">
<frameworkImplementation>org.apache.uima.java</frameworkImplementation>
@@ -2260,9 +2242,7 @@
<title>Simple Metadata Attributes</title>
- <programlisting>
-<![CDATA[
-<analysisEngineMetaData>
+ <programlisting><![CDATA[<analysisEngineMetaData>
<name>Room Number Annotator</name>
<description>An example annotator that searches for room numbers in
the IBM Watson research buildings.</description>
@@ -2280,9 +2260,7 @@
<title>Type System Definition</title>
- <programlisting>
-<![CDATA[
-<typeSystemDescription>
+ <programlisting><![CDATA[<typeSystemDescription>
<imports>
<import location=<quote>TutorialTypeSystem.xml</quote>/>
</imports>
@@ -2303,9 +2281,7 @@
<title>Capabilities</title>
- <programlisting>
-<![CDATA[
-<capabilities>
+ <programlisting><![CDATA[<capabilities>
<capability>
<inputs />
<outputs>
@@ -2332,14 +2308,11 @@
The <outputs> section above could be replaced with the equivalent section:
- <programlisting>
-<![CDATA[
-<outputs>
- <type allAnnotatorFeatures =<quote>true</quote>> org.apache.uima.tutorial.RoomNumber
+ <programlisting><![CDATA[<outputs>
+ <type allAnnotatorFeatures ="true">
+ org.apache.uima.tutorial.RoomNumber
</type>
-</outputs>
-]]>
- </programlisting></para>
+</outputs>]]></programlisting></para>
</section>
@@ -2350,9 +2323,7 @@
<title>Configuration Parameter Declarations</title>
- <programlisting>
-<![CDATA[
-<configurationParameters>
+ <programlisting><![CDATA[<configurationParameters>
<configurationParameter>
<name>Patterns</name>
<description>List of room number regular expression patterns.
@@ -2370,9 +2341,7 @@
<multiValued>true</multiValued>
<mandatory>true</mandatory>
</configurationParameter>
-</configurationParameters>
-]]>
-</programlisting>
+</configurationParameters>]]></programlisting>
<para>The <literal><configurationParameters></literal> element
contains the definitions of the configuration parameters that our annotator
@@ -2407,9 +2376,7 @@
<title>Configuration Parameter Settings</title>
- <programlisting>
-<![CDATA[
-<configurationParameterSettings>
+ <programlisting><![CDATA[<configurationParameterSettings>
<nameValuePair>
<name>Patterns</name>
<value>
@@ -2430,9 +2397,7 @@
</array>
</value>
</nameValuePair>
-</configurationParameterSettings>
-]]>
- </programlisting>
+</configurationParameterSettings>]]></programlisting>
</section>
@@ -2440,9 +2405,7 @@
<title>Aggregate Analysis Engine Descriptor</title>
- <programlisting>
-<![CDATA[
-<?xml version="1.0" encoding="UTF-8" ?>
+ <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8" ?>
<analysisEngineDescription xmlns="http://uima.apache.org/resourceSpecifier">
<frameworkImplementation>org.apache.uima.java</frameworkImplementation>
<primitive>false</primitive>
@@ -2454,9 +2417,7 @@
<delegateAnalysisEngine key="DateTime">
<import location="TutorialDateTime.xml" />
</delegateAnalysisEngine>
- </delegateAnalysisEngineSpecifiers>
-]]>
-</programlisting>
+ </delegateAnalysisEngineSpecifiers>]]></programlisting>
<para>The first difference between this descriptor and an individual
annotator's descriptor is that the
@@ -2474,9 +2435,7 @@
pipeline. Ordering is done by another section of the descriptor:
- <programlisting>
-<![CDATA[
-<analysisEngineMetaData>
+ <programlisting><![CDATA[<analysisEngineMetaData>
<name>Aggregate AE - Room Number and DateTime Annotators</name>
<description>Detects Room Numbers, Dates, and Times</description>
<flowConstraints>
@@ -2484,9 +2443,7 @@
<node>RoomNumber</node>
<node>DateTime</node>
</fixedFlow>
- </flowConstraints>
-]]>
- </programlisting></para>
+ </flowConstraints>]]></programlisting></para>
<para>Here, a fixedFlow is adequate, and we specify the exact ordering in which the
AEs will be executed. In this case, it doesn't really matter, since the
@@ -2497,9 +2454,7 @@
same syntax as a primitive AE's capabilities section:
- <programlisting>
-<![CDATA[
-<capabilities>
+ <programlisting><![CDATA[<capabilities>
<capability>
<inputs />
<outputs>
@@ -2517,9 +2472,7 @@
<language>en</language>
</languagesSupported>
</capability>
-</capabilities>
-]]>
- </programlisting>
+</capabilities>]]></programlisting>
</para>
</section>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.aas.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.aas.xml?view=diff&rev=485030&r1=485029&r2=485030
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.aas.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.aas.xml Sat Dec 9 10:58:06 2006
@@ -24,6 +24,7 @@
-->
<chapter id="ugr.tug.aas">
<title>Annotations, Artifacts, and Sofas</title>
+ <titleabbrev>Annotations, Artifacts & Sofas</titleabbrev>
<para>Up to this point, the documentation has focused on analyzing strings of Unicode text,
producing subtypes of Annotations which reference offsets in those strings. This
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=485030&r1=485029&r2=485030
==============================================================================
--- 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 Sat Dec 9 10:58:06 2006
@@ -112,16 +112,14 @@
<para>The following code shows how to instantiate an AE from its XML descriptor:
- <programlisting>{
- //get Resource Specifier from XML file or PEAR
- XMLInputSource in = new XMLInputSource("MyDescriptor.xml");
- ResourceSpecifier specifier =
+ <programlisting> //get Resource Specifier from XML file or PEAR
+XMLInputSource in = new XMLInputSource("MyDescriptor.xml");
+ResourceSpecifier specifier =
UIMAFramework.getXMLParser().parseResourceSpecifier(in);
//create AE here
- AnalysisEngine ae =
- UIMAFramework.produceAnalysisEngine(specifier);
-}</programlisting></para>
+AnalysisEngine ae =
+ UIMAFramework.produceAnalysisEngine(specifier);</programlisting></para>
<para>The first two lines parse the XML descriptor (for AEs with multiple descriptor
files, one of them is the <quote>main</quote> descriptor - the AE documentation
@@ -156,9 +154,8 @@
<para>Using the JCas
- <programlisting>{
- //create a JCas, given an Analysis Engine (ae)
- JCas jcas = ae.newDefaultTextJCas();
+ <programlisting> //create a JCas, given an Analysis Engine (ae)
+JCas jcas = ae.newDefaultTextJCas();
// this is shorthand for the following steps:
// CAS aCas = ae.newCAS();
@@ -166,20 +163,19 @@
// JCas jcas = aCasView.createJCas();
//analyze a document
- jcas.setDocumentText(doc1text);
- ae.process(jcas);
- doSomethingWithResults(jcas);
- jcas.reset();
+jcas.setDocumentText(doc1text);
+ae.process(jcas);
+doSomethingWithResults(jcas);
+jcas.reset();
//analyze another document
- jcas.setDocumentText(doc2text);
- ae.process(jcas);
- doSomethingWithResults(jcas);
- jcas.reset();
- ...
+jcas.setDocumentText(doc2text);
+ae.process(jcas);
+doSomethingWithResults(jcas);
+jcas.reset();
+...
//done
- ae.destroy();
-}</programlisting></para>
+ae.destroy();</programlisting></para>
<para>Using the CAS
@@ -418,7 +414,8 @@
</section>
<section id="ugr.tug.application.using_multiple_aes">
- <title>Using Multiple Analysis Engines (and creating shared CASes)</title>
+ <title>Using Multiple Analysis Engines and creating shared CASes)</title>
+ <titleabbrev>Multiple AEs & creating shared CASes</titleabbrev>
<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
@@ -456,8 +453,8 @@
CAS cas = CasCreationUtils.createCas(list);
- // once you have this CAS, you need to create the view you want of it, and
- // also (optionally) the JCas Interface to it
+ // once you have this CAS, you need to create the view you want of it,
+ // and also (optionally) the JCas Interface to it
CAS casView = cas.createView("mySofaName", mime-type);
// (OR)
@@ -510,7 +507,8 @@
you only deal with descriptors.</para>
<section id="ugr.tug.application.running_a_cpe_from_a_descriptor">
- <title>Running a CPE from a Descriptor</title>
+ <title>Running a Collection Processing Engine from a Descriptor</title>
+ <titleabbrev>Running a CPE from a Descriptor</titleabbrev>>
<para><olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.cpe.running_cpe_from_application"/> describes how to
@@ -520,7 +518,8 @@
<section
id="ugr.tug.application.configuring_a_cpe_descriptor_programmatically">
- <title>Configuring a CPE Descriptor Programmatically</title>
+ <title>Configuring a Collection Processing Engine Descriptor Programmatically</title>
+ <titleabbrev>Configuring a CPE Descriptor Programmatically</titleabbrev>>
<para>For the finest level of control over the CPE descriptor settings, the CPE offers
programmatic access to the descriptor via an API. With this API, a developer can
@@ -588,8 +587,7 @@
cpe.setNumToProcess(1000);
// Dump the descriptor to the System.out
-((CpeDescriptionImpl)cpe).toXML(System.out);
-</programlisting>
+((CpeDescriptionImpl)cpe).toXML(System.out);</programlisting>
<para>The CPE descriptor for the above configuration looks like this:
@@ -652,9 +650,7 @@
org.apache.uima.reference_impl.util.JavaTimer
</timerImpl>
</cpeConfig>
-</cpeDescription>
-]]>
-</programlisting></para>
+</cpeDescription>]]></programlisting></para>
</section>
</section>
@@ -700,8 +696,7 @@
// Set a parameter value
consumerParamSettings.setParameterValue(
InlineXmlCasConsumer.PARAM_OUTPUTDIR,
- outputDir.getAbsolutePath());
-</programlisting></para>
+ outputDir.getAbsolutePath());</programlisting></para>
<para>Then you might produce this component using:
@@ -818,9 +813,7 @@
<style name="Annotation"/>
</indexRule>
</indexBuildItem>
-</indexBuildSpecification>
-]]>
-</programlisting></para>
+</indexBuildSpecification>]]></programlisting></para>
<para>The index build specification is a series of index build items, each of which
identifies a CAS annotation type (a subtype of
@@ -893,6 +886,7 @@
id="ugr.tug.application.search.cpe_with_semantic_search_cas_consumer">
<title>Building and Running a CPE including the Semantic Search CAS Consumer
– Indexer</title>
+ <titleabbrev>Using Semantic Search CAS Consumer</titleabbrev>
<para>The following steps illustrate how to build and run a CPE that uses the UIMA
Meeting Detector TAE and the Simple Token and Sentence Annotator, discussed in the
@@ -982,7 +976,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="576" depth="329" format="JPG" fileref="&imgroot;image002.jpg"/>
+ <imagedata width="576px" format="JPG" fileref="&imgroot;image002.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of the Semantic Search tool set up to run
semantic queries against a semantic search index</phrase></textobject>
@@ -1033,7 +1027,7 @@
</section>
<section id="ugr.tug.application.remote_services">
- <title>Working with Analysis Engine and CAS Consumer Remote Services</title>
+ <title>Working with Remote Services</title>
<para>The UIMA SDK allows you to easily take any Analysis Engine or CAS Consumer and deploy
it as a service. That Analysis Engine or CAS Consumer can then be called from a remote
@@ -1061,7 +1055,8 @@
communications protocol. </para></listitem></orderedlist></para>
<section id="ugr.tug.application.how_to_deploy_as_soap">
- <title>How to Deploy a UIMA Component as a SOAP Web Service</title>
+ <title>Deploying a UIMA Component as a SOAP Service</title>
+ <titleabbrev>Deploying as SOAP Service</titleabbrev>
<para>To deploy a UIMA component as a SOAP Web Service, you need to first install the
following software components:
@@ -1090,7 +1085,7 @@
<literal>%CATALINA_HOME%/webapps/axis/WEB-INF/lib</literal> in your
installation.</para></listitem>
- <listitem><para><emphasis role="bolditalic">IMPORTANT</emphasis>: any
+ <listitem><para><emphasis role="bold"><emphasis role="italic">IMPORTANT</emphasis></emphasis>: any
time you add JAR files to TomCat (for instance, in the above 2 steps), you must
shutdown and restart TomCat before it <quote>notices</quote> this. So now,
please shutdown and restart TomCat.</para></listitem>
@@ -1132,11 +1127,11 @@
looks like this (important parts are in bold italics):
- <programlisting><deployment name=<quote><emphasis role="bolditalic">PersonTitleAnnotator</emphasis></quote>
+ <programlisting><deployment name=<quote><emphasis role="bold"><emphasis role="italic">PersonTitleAnnotator</emphasis></emphasis></quote>
xmlns=<quote>http://xml.apache.org/axis/wsdd/</quote>
xmlns:java=<quote>http://xml.apache.org/axis/wsdd/providers/java</quote>>
- <service name=<quote><emphasis role="bolditalic">urn:PersonTitleAnnotator</emphasis></quote> provider=<quote>java:RPC</quote>>
+ <service name=<quote><emphasis role="bold"><emphasis role="italic">urn:PersonTitleAnnotator</emphasis></emphasis></quote> provider=<quote>java:RPC</quote>>
<parameter name=<quote>scope</quote> value=<quote>Request</quote>/>
@@ -1147,13 +1142,14 @@
<parameter name=<quote>allowedMethods</quote> value=<quote>getMetaData process</quote>/>
<parameter name=<quote>allowedRoles</quote> value=<quote>*</quote>/>
<parameter name=<quote>resourceSpecifierPath</quote>
- value=<quote><emphasis role="bolditalic">C:/Program Files/apache/uima/examples/
- descriptors/analysis_engine/PersonTitleAnnotator.xml</emphasis></quote>/>
+ value=<quote><emphasis role="bold"><emphasis role="italic">C:/Program Files/apache/uima/examples/
+ descriptors/analysis_engine/PersonTitleAnnotator.xml</emphasis></emphasis></quote>/>
<parameter name=<quote>numInstances</quote> value=<quote>3</quote>/>
<parameter name=<quote>timeoutPeriod</quote> value=<quote>30000</quote>/>
- <!-- Type Mappings omitted from this document; you will not need to edit them. -->
+ <!-- Type Mappings omitted from this document;
+ you will not need to edit them. -->
<typeMapping .../>
<typeMapping .../>
@@ -1178,7 +1174,7 @@
<para>To deploy the Person Title annotator service, issue the following command:
- <programlisting>C:Program Files/apache/uima>bindeploytool
+ <programlisting>C:/Program Files/apache/uima>bindeploytool
examples/deploy/soap/Deploy_PersonTitleAnnotator.wsdd</programlisting></para>
<para>Test if the deployment was successful by starting up a browser, pointing it to
@@ -1204,7 +1200,8 @@
</section>
<section id="ugr.tug.application.how_to_deploy_a_vinci_service">
- <title>How to Deploy a UIMA Component as a Vinci Service</title>
+ <title>Deploying a UIMA Component as a Vinci Service</title>
+ <titleabbrev>Deploying as a Vinci Service</titleabbrev>
<para>There are no software prerequisites for deploying a Vinci service. The
necessary libraries are part of the UIMA SDK. However, before you can use Vinci
@@ -1222,18 +1219,19 @@
<para>This example deployment descriptor looks like:
- <programlisting><deployment name=<emphasis role="bolditalic"><quote>Vinci Person Title Annotator Service</quote></emphasis>>
+ <programlisting><deployment name=<emphasis role="bold"><emphasis role="italic">"Vinci Person Title Annotator Service"</emphasis></emphasis>>
- <service name=<emphasis role="bolditalic"><quote>uima.annotator.PersonTitleAnnotator</quote></emphasis> provider=<quote>vinci</quote>>
+ <service name=<emphasis role="bold"><emphasis role="italic">"uima.annotator.PersonTitleAnnotator"</emphasis></emphasis> provider="vinci">
- <parameter name=<quote>resourceSpecifierPath</quote>
- value=<emphasis role="bolditalic"><quote>C:/Program Files/apache/uima/examples/descriptors/analysis_engine/PersonTitleAnnotator.xml</quote></emphasis>/>
+ <parameter name="resourceSpecifierPath"
+ value=<emphasis role="bold"><emphasis role="italic">"C:/Program Files/apache/uima/examples/descriptors/
+ analysis_engine/PersonTitleAnnotator.xml"</emphasis></emphasis>/>
- <parameter name=<quote>numInstances</quote> value=<quote>1</quote>/>
+ <parameter name="numInstances" value="1"/>
- <parameter name=<quote>timeoutPeriod</quote> value=<quote>30000</quote>/>
+ <parameter name="timeoutPeriod" value="30000"/>
- <parameter name=<quote>serverSocketTimeout</quote> value=<quote>120000</quote>/>
+ <parameter name="serverSocketTimeout" value="120000"/>
</service>
@@ -1277,6 +1275,7 @@
<section id="ugr.tug.application.how_to_call_a_uima_service">
<title>How to Call a UIMA Service</title>
+ <titleabbrev>Calling a UIMA Service</titleabbrev>
<para>Once an Analysis Engine or CAS Consumer has been deployed as a service, it can be
used from any UIMA application, in the exact same way that a local Analysis Engine or
@@ -1419,8 +1418,7 @@
available. If you see the following exception:
<programlisting>java.net.BindException: Address already in use:
-JVM_Bind
- </programlisting>
+JVM_Bind</programlisting>
it indicates that another process is running on port 9000. In this case, add the
parameter <literal>-p <port></literal> to the
<literal>startVNS</literal> command, using <literal><port></literal>
@@ -1592,7 +1590,7 @@
advantage of multi-processor and hyper-threaded architectures).</para>
<note><para>When using Vinci in <quote>exclusive</quote> mode (see service access
under <olink targetdoc="&uima_docs_ref;"
- targetptr="ugr.ref.xml.cpe_descriptor.cas_processors.individual.deployment_parameters"/>), only one thread is used.
+ targetptr="ugr.ref.xml.cpe_descriptor.descriptor.cas_processors.individual.deployment_parameters"/>), only one thread is used.
To achieve multi-processing on a server in this case, use multiple instances of the
service, instead of multiple threads (see <xref
linkend="ugr.tug.application.how_to_deploy_a_vinci_service"/>.</para>
@@ -1600,7 +1598,7 @@
</section>
<section id="ugr.tug.application.jmx">
- <title>Monitoring Analysis Engine Performance using JMX</title>
+ <title>Monitoring AE Performance using JMX</title>
<para>As of version 2, UIMA supports remote monitoring of Analysis Engine performance
via the Java Management Extensions (JMX) API. JMX is a standard part of the Java Runtime
@@ -1624,7 +1622,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="400" depth="300" format="JPG" fileref="&imgroot;image004.jpg"/>
+ <imagedata width="300px" format="JPG" fileref="&imgroot;image004.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of JMX console</phrase></textobject>
</mediaobject>
@@ -1641,7 +1639,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="634" depth="400" format="JPG" fileref="&imgroot;image006.jpg"/>
+ <imagedata width="634px" format="JPG" fileref="&imgroot;image006.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of JMX console monitoring UIMA components</phrase></textobject>
</mediaobject>
@@ -1674,8 +1672,8 @@
completed, you will need to write your application so that the JVM remains running after
processing completes, waiting for some user signal before terminating.</para>
- <para>For information on JMX see <ulink
- url="http://java.sun.com/j2se/1.5.0/docs/api/javax/management/package-summary.html#package_description"/>
- .</para>
+ <para>For information on JMX can be found in the <ulink
+ url="http://java.sun.com/j2se/1.5.0/docs/api/javax/management/package-summary.html#package_description">
+ Java 5 documentation</ulink>.</para>
</section>
</chapter>
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=485030&r1=485029&r2=485030
==============================================================================
--- 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 Sat Dec 9 10:58:06 2006
@@ -25,6 +25,7 @@
-->
<chapter id="ugr.tug.cm">
<title>CAS Multiplier Developer's Guide</title>
+ <titleabbrev>CAS Multiplier</titleabbrev>
<para>The UIMA analysis components (Annotators and CAS Consumers) described previously in this manual all take a
single CAS as input, optionally make modifications to it, and output that same CAS. This chapter describes an
@@ -89,6 +90,7 @@
<section id="ugr.tug.cm.how_to_get_empty_cas_instance">
<title>How to Get an Empty CAS Instance</title>
+ <titleabbrev>Getting an empty CAS Instance</titleabbrev>
<para>The CAS Multiplier's <literal>next</literal> method must return a CAS instance that represents
a new representation of the input artifact. Since CAS instances are managed by the framework, the CAS
@@ -135,7 +137,8 @@
private int mSegmentSize;
private String mDocUri;
- public void initialize(UimaContext aContext) throws ResourceInitializationException
+ public void initialize(UimaContext aContext)
+ throws ResourceInitializationException
{ ... }
public void process(JCas aJCas) throws AnalysisEngineProcessException
@@ -187,7 +190,8 @@
FSIterator it = aJCas.getJFSIndexRepository()
.getAnnotationIndex(SourceDocumentInformation.type).iterator();
if (it.hasNext()) {
- SourceDocumentInformation fileLoc = (SourceDocumentInformation)it.next();
+ SourceDocumentInformation fileLoc =
+ (SourceDocumentInformation)it.next();
mDocUri = fileLoc.getUri();
}
else {
@@ -226,42 +230,51 @@
<title>Next Method</title>
- <programlisting> public AbstractCas next() throws AnalysisEngineProcessException {
- int breakAt = mPos + mSegmentSize;
- if (breakAt > mDoc.length())
- breakAt = mDoc.length();
- // search for the next newline character. Note: this example segmenter implementation
- // assumes that the document contains many newlines. In the worst case, if this segmenter
- // is runon a document with no newlines, it will produce only one segment containing the
- // entire document text. A better implementation might specify a maximum segment size as
- // well as a minimum.
- while (breakAt < mDoc.length() && mDoc.charAt(breakAt - 1) != '\n')
- breakAt++;
-
- JCas jcas = getEmptyJCas();
- try {
- jcas.setDocumentText(mDoc.substring(mPos, breakAt));
- // if original CAS had SourceDocumentInformation, also add SourceDocumentInformatio
- // to each segment
- if (mDocUri != null) {
- SourceDocumentInformation sdi = new SourceDocumentInformation(jcas);
- sdi.setUri(mDocUri);
- sdi.setOffsetInSource(mPos);
- sdi.setDocumentSize(breakAt - mPos);
- sdi.addToIndexes();
+ <programlisting>public AbstractCas next() throws AnalysisEngineProcessException {
+ int breakAt = mPos + mSegmentSize;
+ if (breakAt > mDoc.length())
+ breakAt = mDoc.length();
+
+ // search for the next newline character.
+ // Note: this example segmenter implementation
+ // assumes that the document contains many newlines.
+ // In the worst case, if this segmenter
+ // is runon a document with no newlines,
+ // it will produce only one segment containing the
+ // entire document text.
+ // A better implementation might specify a maximum segment size as
+ // well as a minimum.
+
+ while (breakAt < mDoc.length() &&
+ mDoc.charAt(breakAt - 1) != '\n')
+ breakAt++;
+
+ JCas jcas = getEmptyJCas();
+ try {
+ jcas.setDocumentText(mDoc.substring(mPos, breakAt));
+ // if original CAS had SourceDocumentInformation,
+ also add SourceDocumentInformatio
+ // to each segment
+ if (mDocUri != null) {
+ SourceDocumentInformation sdi =
+ new SourceDocumentInformation(jcas);
+ sdi.setUri(mDocUri);
+ sdi.setOffsetInSource(mPos);
+ sdi.setDocumentSize(breakAt - mPos);
+ sdi.addToIndexes();
- if (breakAt == mDoc.length()) {
- sdi.setLastSegment(true);
- }
+ if (breakAt == mDoc.length()) {
+ sdi.setLastSegment(true);
}
-
- mPos = breakAt;
- return jcas;
- } catch (Exception e) {
- jcas.release();
- throw new AnalysisEngineProcessException(e);
}
- }</programlisting>
+
+ mPos = breakAt;
+ return jcas;
+ } catch (Exception e) {
+ jcas.release();
+ throw new AnalysisEngineProcessException(e);
+ }
+}</programlisting>
<para>The <literal>next</literal> method actually produces the next segment and returns it. The
framework guarantees that it will not call <literal>next</literal> unless
@@ -286,6 +299,7 @@
<section id="ugr.tug.cm.creating_cm_descriptor">
<title>Creating the CAS Multiplier Descriptor</title>
+ <titleabbrev>CAS Multiplier Descriptor</titleabbrev>
<para>There is not a separate type of descriptor for a CAS Multiplier. CAS Multiplier are considered a type of
Analysis Engine, and so their descriptors use the same syntax as any other Analysis Engine Descriptor.</para>
@@ -305,7 +319,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="287" depth="257" format="JPG" fileref="&imgroot;image002.jpg"/>
+ <imagedata width="200px" align="center" format="JPG" fileref="&imgroot;image002.jpg"/>
</imageobject>
<textobject><phrase>Screen shot of Component Descriptor Editor on Overview
showing checking of "Outputs new CASes" box</phrase>
@@ -332,6 +346,7 @@
<section id="ugr.tug.cm.using_cm_in_aae">
<title>Using a CAS Multiplier in an Aggregate Analysis Engine</title>
+ <titleabbrev>Using CAS Multipliers in Aggregates</titleabbrev>
<para>You can include a CAS Multiplier as a component in an Aggregate Analysis Engine. For example, this allows
you to construct an Aggregate Analysis Engine that takes each input CAS, breaks it up into segments, and runs a
@@ -339,6 +354,7 @@
<section id="ugr.tug.cm.adding_cm_to_aggregate">
<title>Adding the CAS Multiplier to the Aggregate</title>
+ <titleabbrev>Aggregate: Adding the CAS Multiplier</titleabbrev>
<para>Since CAS Multiplier are considered a type of Analysis Engine, adding them to an aggregate works the same
way as for other Analysis Engines. Using the CDE, you just click the <quote>Add...</quote> button in the
@@ -480,6 +496,7 @@
<section id="ugr.tug.cm.using_cm_in_cpe">
<title>Using a CAS Multiplier in a Collection Processing Engine</title>
+ <titleabbrev>CAS Multipliers in CPE's</titleabbrev>
<para>It is currently a limitation that CAS Multiplier cannot be deployed directly in a Collection Processing
Engine. The only way that you can use a CAS Multiplier in a CPE is to first wrap it in an Aggregate Analysis Engine
@@ -494,6 +511,7 @@
<section id="ugr.tug.cm.calling_cm_from_app">
<title>Calling a CAS Multiplier from an Application</title>
+ <titleabbrev>Applications: Calling CAS Multipliers</titleabbrev>
<para>The <literal>AnalysisEngine</literal> interface has the following methods that allow you to interact
with CAS Multiplier:
@@ -552,11 +570,14 @@
<section id="ugr.tug.cm.using_cm_to_merge_cases">
<title>Using a CAS Multiplier to Merge CASes</title>
+ <titleabbrev>Merging with CAS Multipliers</titleabbrev>
+
<para>A CAS Multiplier can also be used to combine smaller CASes together to form larger CASes. In this section we
describe how this works and walk through an example.</para>
<section id="ugr.tug.cm.overview_of_how_to_merge_cases">
<title>Overview of How to Merge CASes</title>
+ <titleabbrev>Merginging Overview</titleabbrev>
<orderedlist>
<listitem>
@@ -616,10 +637,13 @@
// copy specified annotation types
CasCopier copier = new CasCopier(mMergedCas.getCas());
- Set copiedIndexedFs = new HashSet(); // needed in case one annotation is in two indexes (could
+
+ // needed in case one annotation is in two indexes (could
// happen if specified annotation types overlap)
+ Set copiedIndexedFs = new HashSet();
for (int i = 0; i < mAnnotationTypesToCopy.length; i++) {
- Type type = mMergedCas.getTypeSystem().getType(mAnnotationTypesToCopy[i]);
+ Type type = mMergedCas.getTypeSystem()
+ .getType(mAnnotationTypesToCopy[i]);
FSIndex index = aJCas.getCas().getAnnotationIndex(type);
Iterator iter = index.iterator();
while (iter.hasNext()) {
@@ -655,32 +679,32 @@
artifact, so when the CAS Multiplier sees this segment it knows it is time to produce an output CAS.</para>
- <programlisting>
- // get the SourceDocumentInformation FS, which indicates the sourceURI of the document
- // and whether the incoming CAS is the last segment
- FSIterator it = aJCas.getJFSIndexRepository()
- .getAnnotationIndex(SourceDocumentInformation.type).iterator();
- if (!it.hasNext()) {
- throw new RuntimeException("Missing SourceDocumentInformation");
- }
- SourceDocumentInformation sourceDocInfo = (SourceDocumentInformation) it.next();
- if (sourceDocInfo.getLastSegment()) {
- // time to produce an output CAS
- // set the document text
- mMergedCas.setDocumentText(mDocBuf.toString());
-
- // add source document info to destination CAS
- SourceDocumentInformation destSDI = new SourceDocumentInformation(mMergedCas);
- destSDI.setUri(sourceDocInfo.getUri());
- destSDI.setOffsetInSource(0);
- destSDI.setLastSegment(true);
- destSDI.addToIndexes();
+ <programlisting>// get the SourceDocumentInformation FS,
+// which indicates the sourceURI of the document
+// and whether the incoming CAS is the last segment
+FSIterator it = aJCas.getJFSIndexRepository()
+ .getAnnotationIndex(SourceDocumentInformation.type).iterator();
+if (!it.hasNext()) {
+ throw new RuntimeException("Missing SourceDocumentInformation");
+}
+SourceDocumentInformation sourceDocInfo =
+ (SourceDocumentInformation) it.next();
+if (sourceDocInfo.getLastSegment()) {
+ // time to produce an output CAS
+ // set the document text
+ mMergedCas.setDocumentText(mDocBuf.toString());
+
+ // add source document info to destination CAS
+ SourceDocumentInformation destSDI =
+ new SourceDocumentInformation(mMergedCas);
+ destSDI.setUri(sourceDocInfo.getUri());
+ destSDI.setOffsetInSource(0);
+ destSDI.setLastSegment(true);
+ destSDI.addToIndexes();
- mDocBuf = new StringBuffer();
- mReadyToOutput = true;
- }
- }
- </programlisting>
+ mDocBuf = new StringBuffer();
+ mReadyToOutput = true;
+}</programlisting>
<para>When it is time to produce an output CAS, the CAS Multiplier makes final updates to the merged CAS
(setting the document text and adding a <literal>SourceDocumentInformation</literal>
@@ -716,6 +740,8 @@
</section>
<section id="ugr.tug.cm.using_the_simple_text_merger_in_an_aggregate_ae">
<title>Using the SimpleTextMerger in an Aggregate Analysis Engine</title>
+ <titleabbrev>SimpleTextMerger in an Aggregate</titleabbrev>
+
<para>An example descriptor for an Aggregate Analysis Engine that uses the
<literal>SimpleTextMerger</literal> is provided in
<literal>examples/descriptors/cas_multiplier/Segment_Annotate_Merge_AE.xml</literal>. This
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=485030&r1=485029&r2=485030
==============================================================================
--- 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 Sat Dec 9 10:58:06 2006
@@ -25,6 +25,7 @@
-->
<chapter id="ugr.tug.cpe">
<title>Collection Processing Engine Developer's Guide</title>
+ <titleabbrev>CPE Developer's Guide</titleabbrev>
<para>The UIMA Analysis Engine interface provides support for developing and integrating
algorithms that analyze unstructured data. Analysis Engines are designed to operate on a
@@ -95,7 +96,7 @@
<title>CPE Components</title>
<mediaobject>
<imageobject>
- <imagedata width="576" depth="360" format="PNG"
+ <imagedata width="576px" format="PNG"
fileref="&imgroot;image002.png"/>
</imageobject>
<textobject><phrase>CPE Components and flow between them</phrase>
@@ -139,7 +140,7 @@
</section>
<section id="ugr.tug.cpe.configurator_and_viewer">
- <title>The CPE Configurator and the Externalized CAS viewer</title>
+ <title>CPE Configurator and CAS viewer</title>
<section id="ugr.tug.cpe.cpe_configurator">
<title>Using the CPE Configurator</title>
@@ -162,7 +163,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="575" depth="547" format="JPG" fileref="&imgroot;image004.jpg"/>
+ <imagedata width="350px" format="JPG" fileref="&imgroot;image004.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of CPE GUI</phrase></textobject>
</mediaobject>
@@ -188,14 +189,13 @@
CAS Consumer:
%UIMA_HOME%/examples/descriptors/cas_consumer/
- XmiWriterCasConsumer.xml
-</programlisting></para>
+ XmiWriterCasConsumer.xml</programlisting></para>
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="576" depth="439" format="JPG" fileref="&imgroot;image006.jpg"/>
+ <imagedata width="576px" format="JPG" fileref="&imgroot;image006.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of CPE GUI after fields filled in</phrase></textobject>
</mediaobject>
@@ -249,7 +249,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="488" depth="226" format="JPG" fileref="&imgroot;image008.jpg"/>
+ <imagedata width="488px" format="JPG" fileref="&imgroot;image008.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of Annotation Viewer results</phrase></textobject>
</mediaobject>
@@ -260,7 +260,7 @@
the XMI Writer CAS Consumer in the CPE configured above (e.g.,
<literal>%UIMA_HOME%\examples\data\processed</literal>) and that the TAE
Descriptor File is set to the Analysis Engine used in the CPE configured above (e.g.,
- <literal>%UIMA_HOME%\examples\descriptors\analysis_engine\NamesAndPersonTitles_TAE.xml</literal>
+ <literal>examples\descriptors\analysis_engine\NamesAndPersonTitles_TAE.xml</literal>
).</para>
<para>Click the View button to display the Analyzed Documents window:
@@ -269,7 +269,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="385" depth="286" format="JPG" fileref="&imgroot;image010.jpg"/>
+ <imagedata width="385px" format="JPG" fileref="&imgroot;image010.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of CPE Configurator Analyzed Documents</phrase></textobject>
</mediaobject>
@@ -284,7 +284,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="575" depth="418" format="JPG" fileref="&imgroot;image012.jpg"/>
+ <imagedata width="575px" format="JPG" fileref="&imgroot;image012.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of Document and Annotation Viewer</phrase></textobject>
</mediaobject>
@@ -365,8 +365,7 @@
mCPE.addStatusCallbackListener(new StatusCallbackListenerImpl());
//Start Processing
-mCPE.process();
-</programlisting></para>
+mCPE.process();</programlisting></para>
<para>This will start the CPE running in a separate thread.</para>
@@ -448,7 +447,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="378" depth="415" format="JPG" fileref="&imgroot;image014.jpg"/>
+ <imagedata width="378px" format="JPG" fileref="&imgroot;image014.jpg"/>
</imageobject>
<textobject><phrase>Screenshot showing Eclipse new class wizard</phrase></textobject>
</mediaobject>
@@ -503,8 +502,7 @@
mFiles.add(files[i]);
}
}
-}
-</programlisting>
+}</programlisting>
<note><para>This is the zero-argument version of the initialize method. There is
also a method on the Collection Reader interface called
<literal>initialize(ResourceSpecifier, Map)</literal> but it is not
@@ -525,8 +523,7 @@
<programlisting>public boolean hasNext() {
return mCurrentIndex < mFiles.size();
-}
-</programlisting>
+}</programlisting>
</para>
</section>
@@ -618,8 +615,7 @@
srcDocInfo.setOffsetInSource(0);
srcDocInfo.setDocumentSize((int) file.length());
srcDocInfo.addToIndexes();
-}
-</programlisting>
+}</programlisting>
<para>The Collection Reader can create additional annotations in the CAS at this
point, in the same way that annotators create annotations.</para>
@@ -652,8 +648,7 @@
<programlisting>public Progress[] getProgress() {
return new Progress[]{
new ProgressImpl(mCurrentIndex,mFiles.size(),Progress.ENTITIES)};
-}
-</programlisting></para>
+}</programlisting></para>
<para>In this particular example, the total number of files in the collection is
known, but the total size of the collection is not known. As such, a
@@ -785,8 +780,7 @@
<outputsNewCASes>true</outputsNewCASes>
</operationalProperties>
</processingResourceMetaData>
-</collectionReaderDescription>]]>
-</programlisting>
+</collectionReaderDescription>]]></programlisting>
</section>
</section>
@@ -871,8 +865,7 @@
} catch (Exception e) {
throw new CollectionException(e);
}
- }
-</programlisting>
+ }</programlisting>
<para>The <literal>SaxHandler</literal> class referenced here is an inner class
that does the actual work of extracting the text from the specified XML element. For
@@ -896,7 +889,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="576" depth="439" format="JPG" fileref="&imgroot;image016.jpg"/>
+ <imagedata width="576px" format="JPG" fileref="&imgroot;image016.jpg"/>
</imageobject>
<textobject><phrase>Screenshot showing CPE Configurator specifying a CAS Initializer</phrase></textobject>
</mediaobject>
@@ -930,8 +923,7 @@
}
else { //No CAS Initializer, so read file and set document text ourselves
...
-}
-</programlisting></para>
+}</programlisting></para>
<para>When you write your own Collection Reader, in the description element of your
Collection Reader's descriptor you should document whether your Collection
@@ -1009,8 +1001,7 @@
if (!mOutputDir.exists()) {
mOutputDir.mkdirs();
}
-}
-</programlisting></para>
+}</programlisting></para>
</section>
<section id="ugr.tug.cpe.cas_consumer.required_methods.processcas">
@@ -1073,8 +1064,7 @@
} catch (SAXException e) {
throw new ResourceProcessException(e);
}
-}
-</programlisting>
+}</programlisting>
</section>
@@ -1138,7 +1128,7 @@
<title>CPE Instantiation</title>
<mediaobject>
<imageobject>
- <imagedata width="535" depth="327" format="PNG"
+ <imagedata width="535px" format="PNG"
fileref="&imgroot;image018.png"/>
</imageobject>
<textobject><phrase>Picture of deployment of a CPE</phrase></textobject>
@@ -1162,8 +1152,8 @@
runs in a separate process from the CPE, but still on the same computer. The CPE controls
startup, shutdown, and recovery of a managed CAS Processor. A non-managed CAS
Processor runs as a service and may be on the same computer as the CPE or on a remote
- computer. A non-managed CAS Processor <emphasis role="bolditalic">
- service</emphasis> is started and managed independently from the CPE.</para>
+ computer. A non-managed CAS Processor <emphasis role="bold"><emphasis role="italic">
+ service</emphasis></emphasis> is started and managed independently from the CPE.</para>
<para>For both managed and non-managed CAS Processors, the CAS must be transmitted
between separate processes and possibly between separate computers. This is
@@ -1206,7 +1196,7 @@
<title>CPE with Managed CAS Processors</title>
<mediaobject>
<imageobject>
- <imagedata width="306" depth="274" format="PNG"
+ <imagedata width="306px" format="PNG"
fileref="&imgroot;image020.png"/>
</imageobject>
<textobject><phrase>Managed deployment showing separate JVMs and CASes
@@ -1228,7 +1218,7 @@
configuration specifying a managed CAS Processor.</para>
- <programlisting><casProcessor <emphasis role="bolditalic">deployment="local"</emphasis> name="Meeting Detector TAE">
+ <programlisting><casProcessor <emphasis role="bold"><emphasis role="italic">deployment="local"</emphasis></emphasis> name="Meeting Detector TAE">
<descriptor>
<include href="deploy/vinci/Deploy_MeetingDetectorTAE.xml"/>
</descriptor>
@@ -1254,8 +1244,7 @@
<timeout max="100000"/>
</errorHandling>
<checkpoint batch="10000"/>
-</casProcessor>
-</programlisting>
+</casProcessor></programlisting>
<para>See <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/> for
details and required settings.</para>
@@ -1281,7 +1270,7 @@
<title>CPE with non-managed CAS Processors</title>
<mediaobject>
<imageobject>
- <imagedata width="396" depth="309" format="PNG"
+ <imagedata width="396px" format="PNG"
fileref="&imgroot;image023.png"/>
</imageobject>
<textobject><phrase>Non-managed CPE deployment</phrase></textobject>
@@ -1304,7 +1293,7 @@
configuration for the non-managed CAS Processor.</para>
- <programlisting><casProcessor <emphasis role="bolditalic">deployment=<quote>remote</quote></emphasis> name=<quote>Meeting Detector TAE</quote>>
+ <programlisting><casProcessor <emphasis role="bold"><emphasis role="italic">deployment=<quote>remote</quote></emphasis></emphasis> name=<quote>Meeting Detector TAE</quote>>
<descriptor>
<include href=
<quote>descriptors/vinciService/MeetingDetectorVinciService.xml</quote>/>
@@ -1317,8 +1306,7 @@
<timeout max=<quote>100000</quote>/>
</errorHandling>
<checkpoint batch=<quote>10000</quote>/>
-</casProcessor>
-</programlisting>
+</casProcessor></programlisting>
<para>See <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/> for
details and required settings.</para>
@@ -1342,7 +1330,7 @@
<title>CPE with integrated CAS Processor</title>
<mediaobject>
<imageobject>
- <imagedata width="330" depth="295" format="PNG"
+ <imagedata width="330px" format="PNG"
fileref="&imgroot;image026.png"/>
</imageobject>
<textobject><phrase>CPE with integrated CAS Processor</phrase>
@@ -1354,7 +1342,7 @@
configuration for the integrated CAS Processor.</para>
- <programlisting><casProcessor <emphasis role="bolditalic">deployment=<quote>integrated</quote></emphasis> name=<quote>Meeting Detector TAE</quote>>
+ <programlisting><casProcessor <emphasis role="bold"><emphasis role="italic">deployment=<quote>integrated</quote></emphasis></emphasis> name=<quote>Meeting Detector TAE</quote>>
<descriptor>
<include href="descriptors/tutorial/ex4/MeetingDetectorTAE.xml"/>
</descriptor>
@@ -1366,8 +1354,7 @@
<timeout max="100000"/>
</errorHandling>
<checkpoint batch="10000"/>
-</casProcessor>
-</programlisting>
+</casProcessor></programlisting>
<para>See <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/> for
details and required settings.</para>
@@ -1387,7 +1374,7 @@
<para>To run either the integrated or managed examples, use the
<literal>runCPE</literal> script in the /bin directory of the UIMA installation,
passing the appropriate CPE descriptor as an argument.</para> <note><para>The
- <literal>runCPE</literal> script <emphasis role="bolditalic"> must</emphasis> be
+ <literal>runCPE</literal> script <emphasis role="bold"><emphasis role="italic"> must</emphasis></emphasis> be
run from the <literal>%UIMA_HOME%\examples </literal>directory, because it uses
relative path names that are resolved relative to this working directory. For instance,
@@ -1408,7 +1395,8 @@
<listitem><para>click on the Arguments panel, and insert a path to the appropriate CPE
descriptor in the <quote>Program Arguments</quote> box by typing, for instance:
- <literal>descriptors/collection_processing_engine/MeetingFinderCPE_Integrated.xml</literal>
+ <literal>descriptors/collection_processing_engine/
+ MeetingFinderCPE_Integrated.xml</literal>
</para></listitem>
<listitem><para>Then press <quote>Run</quote> </para></listitem>
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=485030&r1=485029&r2=485030
==============================================================================
--- 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 Sat Dec 9 10:58:06 2006
@@ -241,7 +241,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="503" depth="405" format="JPG" fileref="&imgroot;image002.jpg"/>
+ <imagedata width="503px" format="JPG" fileref="&imgroot;image002.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of Eclipse new object wizard showing Flow Controller</phrase></textobject>
</mediaobject>
@@ -252,7 +252,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="467" depth="383" format="JPG" fileref="&imgroot;image004.jpg"/>
+ <imagedata width="467px" format="JPG" fileref="&imgroot;image004.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of Component Descriptor Editor Overview page for new Flow Controller</phrase></textobject>
</mediaobject>
@@ -286,7 +286,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="409" depth="213" format="JPG" fileref="&imgroot;image006.jpg"/>
+ <imagedata width="409px" format="JPG" fileref="&imgroot;image006.jpg"/>
</imageobject>
<textobject><phrase>Screenshot of Component Descriptor Editor Aggregate page showing selecting user-defined flow</phrase></textobject>
</mediaobject>
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=485030&r1=485029&r2=485030
==============================================================================
--- 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 Sat Dec 9 10:58:06 2006
@@ -24,6 +24,7 @@
-->
<chapter id="ugr.tug.mvs">
<title>Multiple CAS Views of an Artifact</title>
+ <titleabbrev>Multiple CAS Views</titleabbrev>
<para>UIMA provides an extension to the basic model of the CAS which supports analysis of
multiple views of the same artifact, all contained with the CAS. This chapter describes
@@ -53,7 +54,8 @@
repositories:</para>
- <programlisting>aView.addFsToIndexes(aFeatureStructure) aView.removeFsFromIndexes(aFeatureStructure)</programlisting>
+ <programlisting>aView.addFsToIndexes(aFeatureStructure)
+aView.removeFsFromIndexes(aFeatureStructure)</programlisting>
<para>specify the view in which this Feature Structure should be added to or removed from the
indexes.</para>
@@ -93,7 +95,8 @@
</section>
<section id="ugr.tug.mvs.multi_view_and_single_view">
- <title>Multi-View and Single-View components and applications</title>
+ <title>Multi-View, Single-View components & applications</title>
+ <titleabbrev>Multi/Single View parts in Applications</titleabbrev>
<para>Components and applications can be written to be Multi-View or Single-View.
Most components used as primitive building blocks are expected to be Single-View.
@@ -115,6 +118,7 @@
<title>Multi-View Components</title>
<section id="ugr.tug.mvs.deciding_multi_view">
<title>How UIMA decides if a component is Multi-View</title>
+ <titleabbrev>Deciding: Multi-View</titleabbrev>
<para>Every UIMA component has an associated XML Component Descriptor. Multi-View
components are identified simply as those whose descriptors declare one or more Sofa
@@ -179,6 +183,7 @@
<section id="ugr.tug.mvs.sofa_capabilities_and_apis_for_apps">
<title>Sofa Capabilities and APIs for Applications</title>
+ <titleabbrev>Sofa Capabilities & APIs for Apps</titleabbrev>
<para>In addition to components, applications can make use of these capabilities. When
an application creates a new CAS, it also creates the initial view of that CAS - and this
@@ -411,7 +416,7 @@
</section>
<section id="ugr.tug.mvs.jcas_extensions_for_multi_views">
- <title>JCas extensions for Multiple Views / Sofas</title>
+ <title>JCas extensions for Multiple Views</title>
<para>The JCas interface to the CAS can be used with any / all views, as well as the base CAS
sent to Multi-View components. You can always get a JCas object from an existing CAS
@@ -584,10 +589,9 @@
uima.tcas.Annotation: this
uima.tcas.Annotation: beer
uima.tcas.Annotation: is
-uima.tcas.Annotation: good</programlisting>
+uima.tcas.Annotation: good
-
- <programlisting>---Printing all annotations for German Sofa---
+---Printing all annotations for German Sofa---
uima.tcas.DocumentAnnotation: das bier ist gut
sofa.test.CrossAnnotation: das
other annotation feature: this
@@ -604,11 +608,10 @@
<section id="ugr.tug.mvs.views_api_summary">
<title>Views API Summary</title>
- <para>The recommended way to deliver a particular CAS view to a <emphasis
- role="bolditalic">Single-View</emphasis> component is to use by Sofa-mapping in
+ <para>The recommended way to deliver a particular CAS view to a <emphasis role="bold"><emphasis role="italic">Single-View</emphasis></emphasis> component is to use by Sofa-mapping in
the CPE and/or aggregate descriptors.</para>
- <para>For <emphasis role="bolditalic">Multi-View </emphasis> components or
+ <para>For <emphasis role="bold"><emphasis role="italic">Multi-View </emphasis></emphasis> components or
applications, the following methods are used to create or get a reference to a CAS view
for a particular Sofa:</para>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.xmi_emf.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.xmi_emf.xml?view=diff&rev=485030&r1=485029&r2=485030
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.xmi_emf.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.xmi_emf.xml Sat Dec 9 10:58:06 2006
@@ -24,6 +24,7 @@
-->
<chapter id="ugr.tug.xmi_emf">
<title>XMI and EMF Interoperability</title>
+ <titleabbrev>XMI & EMF</titleabbrev>
<section id="ugr.tug.xmi_emf.overview">
<title>Overview</title>
@@ -46,12 +47,14 @@
of UIMA CASes to and from XMI format. This provides a number of advantages,
including:</para>
+ <blockquote>
<para>You can define a model using a UML Editor, such as Rational Rose or EclipseUML, and
then automatically convert it to a UIMA Type System.</para>
<para>You can take an existing UIMA application, convert its type system to Ecore, and
save the CASes it produces to XMI. This data is now in a form where it can easily be ingested
by an EMF-based application.</para>
+ </blockquote>
<para>More generally, we are adopting the well-documented, open standard XMI as the
standard way to represent UIMA-compliant analysis results (replacing the
@@ -129,8 +132,9 @@
<literal>UimaTypeSystem2Ecore</literal>.</para>
<para>Also, the uimaj_examples Eclipse project contains some example code that shows
- how to use the serializer and deserializer:</para>
-
+ how to use the serializer and deserializer:
+
+ <blockquote>
<para><literal>org.apache.uima.examples.xmi.XmiWriterCasConsumer:</literal>
This is a CAS Consumer that writes each CAS to an output file in XMI format. It is analogous
to the XCasWriter CAS Consumer that has existed in prior UIMA versions, except that it
@@ -141,6 +145,7 @@
them into a CAS. For example, this would allow you to build a Collection Processing
Engine that reads XMI files, which could contain some previous analysis results, and
then do further analysis.</para>
+ </blockquote></para>
<para>Finally, in under the folder <literal>uimaj_examples/ecore_src</literal> is
the class
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=485030&r1=485029&r2=485030
==============================================================================
--- 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 Sat Dec 9 10:58:06 2006
@@ -23,7 +23,7 @@
under the License.
-->
<book lang="en">
- <title>Apache UIMA SDK Tutorial and Developers' Guides</title>
+ <title>Apache UIMA SDK — Tutorial and Developers' Guides</title>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../common_book_info.xml"/>
<toc/>