You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by tw...@apache.org on 2007/08/23 18:43:57 UTC
svn commit: r569068 [4/10] - in /incubator/uima/site/trunk/uima-website:
docs/downloads/releaseDocs/2.2.0-incubating/docs/
docs/downloads/releaseDocs/2.2.0-incubating/docs/html/
docs/downloads/releaseDocs/2.2.0-incubating/docs/html/images/ docs/downloa...
Added: incubator/uima/site/trunk/uima-website/docs/downloads/releaseDocs/2.2.0-incubating/docs/html/overview_and_setup/overview_and_setup.html
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/downloads/releaseDocs/2.2.0-incubating/docs/html/overview_and_setup/overview_and_setup.html?rev=569068&view=auto
==============================================================================
--- incubator/uima/site/trunk/uima-website/docs/downloads/releaseDocs/2.2.0-incubating/docs/html/overview_and_setup/overview_and_setup.html (added)
+++ incubator/uima/site/trunk/uima-website/docs/downloads/releaseDocs/2.2.0-incubating/docs/html/overview_and_setup/overview_and_setup.html Thu Aug 23 09:43:41 2007
@@ -0,0 +1,1408 @@
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>UIMA Overview & SDK Setup</title><link rel="stylesheet" href="css/stylesheet-html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en" id="d0e2"><div class="titlepage"><div><div><h1 class="title"><a name="d0e2"></a>UIMA Overview & SDK Setup</h1></div><div><div class="authorgroup"><h3 class="corpauthor">Written and maintained by the Apache UIMA Development Community</h3></div></div><div><p class="releaseinfo">Version 2.2</p></div><div><p class="copyright">Copyright © 2006, 2007 The Apache Software Foundation</p></div><div><p class="copyright">Copyright © 2004, 2006 International Business Machines Corporation</p></div><div><div class="legalnotice"><a name="d0e15"></a><p> </p><p><b>Incubation Notice and Disclaimer. </b>Apache UIMA is an effort undergoing incubation at the Apache Software Foundation
(ASF).
+ Incubation is required of all newly accepted projects until a further review indicates that
+ the infrastructure, communications, and decision making process have stabilized in a manner
+ consistent with other successful ASF projects. While incubation status is not necessarily
+ a reflection of the completeness or stability of the code,
+ it does indicate that the project has yet to be fully endorsed by the ASF.</p><p> </p><p> </p><p><b>License and Disclaimer. </b>The ASF licenses this documentation
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this documentation except in compliance
+ with the License. You may obtain a copy of the License at
+
+ </p><div class="blockquote"><blockquote class="blockquote"><a xmlns:xlink="http://www.w3.org/1999/xlink" href="http://www.apache.org/licenses/LICENSE-2.0" target="_top">http://www.apache.org/licenses/LICENSE-2.0</a></blockquote></div><p>
+
+ Unless required by applicable law or agreed to in writing,
+ this documentation and its contents are distributed under the License
+ on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+ </p><p> </p><p> </p><p><b>Trademarks. </b>All terms mentioned in the text that are known to be trademarks or
+ service marks have been appropriately capitalized. Use of such terms
+ in this book should not be regarded as affecting the validity of the
+ the trademark or service mark.
+ </p></div></div><div><p class="pubdate">July, 2007</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#ugr.project_overview">1. Overview</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.project_overview_doc_overview">1.1. Apache UIMA Project Documentation Overview</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.project_overview_overview">1.1.1. Overviews</a></span></dt><dt><span class="section"><a href="#ugr.project_overview_setup">1.1.2. Eclipse Tooling Installation and Setup</a></span></dt><dt><span class="section"><a href="#ugr.project_overview_tutorials_dev_guides">1.1.3. Tutorials and Developer's Guides</a></span></dt><dt><span class="section"><a href="#ugr.project_overview_tool_guides">1.1.4. Tools Users' Guides</a></span></dt><dt><span class="section"><a href="#ugr.project_overview_reference">1.1.5. References</a></span></dt></dl></dd><dt><span class="section"><a href="#u
gr.project_overview_doc_use">1.2. How to use the Documentation</a></span></dt><dt><span class="section"><a href="#ugr.project_overview_changes_from_previous">1.3. Changes from Previous Versions</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.project_overview_changes_from_2_0">1.3.1. Changes from IBM UIMA 2.0 to Apache UIMA 2.1</a></span></dt><dt><span class="section"><a href="#ugr.project_overview_changes_from_v1">1.3.2. Changes from UIMA Version 1.x</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.project_overview_migrating_from_ibm_uima">1.4. Migrating from IBM UIMA to Apache UIMA</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.project_overview_running_the_migration_utility">1.4.1. Running the Migration Utility</a></span></dt><dt><span class="section"><a href="#ugr.project_overview_rare_migration">1.4.2. Manual Migration</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.project_overview_summary">1.5. Apache UIMA
Summary</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ovv.summary.general">1.5.1. General</a></span></dt><dt><span class="section"><a href="#ugr.ovv.summary.programming_language_support">1.5.2. Programming Language Support</a></span></dt><dt><span class="section"><a href="#ugr.ovv.general.summary.multi_modal_support">1.5.3. Multi-Modal Support</a></span></dt><dt><span class="section"><a href="#ugr.ovv.summary.general.semantic_search_components">1.5.4. Semantic Search Components</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.project_overview_summary_sdk_capabilities">1.6. Summary of Apache UIMA Capabilities</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.ovv.conceptual">2. UIMA Conceptual Overview</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ovv.conceptual.uima_introduction">2.1. UIMA Introduction</a></span></dt><dt><span class="section"><a href="#ugr.ovv.conceptual.architecture_framework_sdk">2.2. The Arch
itecture, the Framework and the SDK</a></span></dt><dt><span class="section"><a href="#ugr.ovv.conceptual.analysis_basics">2.3. Analysis Basics</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ovv.conceptual.aes_annotators_and_analysis_results">2.3.1. Analysis Engines, Annotators & Results</a></span></dt><dt><span class="section"><a href="#ugr.ovv.conceptual.representing_results_in_cas">2.3.2. Representing Analysis Results in the CAS</a></span></dt><dt><span class="section"><a href="#ugr.ovv.conceptual.interacting_with_cas_and_external_resources">2.3.3. Using CASes and External Resources</a></span></dt><dt><span class="section"><a href="#ugr.ovv.conceptual.component_descriptors">2.3.4. Component Descriptors</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ovv.conceptual.aggregate_analysis_engines">2.4. Aggregate Analysis Engines</a></span></dt><dt><span class="section"><a href="#ugr.ovv.conceptual.applicaiton_building_and_collection_processi
ng">2.5. Application Building and Collection Processing</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ovv.conceptual.using_framework_from_an_application">2.5.1. Using the framework from an Application</a></span></dt><dt><span class="section"><a href="#ugr.ovv.conceptual.graduating_to_collection_processing">2.5.2. Graduating to Collection Processing</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ovv.conceptual.exploiting_analysis_results">2.6. Exploiting Analysis Results</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ovv.conceptual.semantic_search">2.6.1. Semantic Search</a></span></dt><dt><span class="section"><a href="#ugr.ovv.conceptual.databases">2.6.2. Databases</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ovv.conceptual.multimodal_processing">2.7. Multimodal Processing in UIMA</a></span></dt><dt><span class="section"><a href="#ugr.ovv.conceptual.next_steps">2.8. Next Steps</a></span></dt></dl></dd><d
t><span class="chapter"><a href="#ugr.ovv.eclipse_setup">3. Eclipse IDE setup for UIMA</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ovv.eclipse_setup.installation">3.1. Installation</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ovv.eclipse_setup.install_eclipse">3.1.1. Install Eclipse</a></span></dt><dt><span class="section"><a href="#ugr.ovv.eclipse_setup.install_emf">3.1.2. Install additional Eclipse component: EMF</a></span></dt><dt><span class="section"><a href="#ugr.ovv.eclipse_setup.install_uima_sdk">3.1.3. Install the UIMA SDK</a></span></dt><dt><span class="section"><a href="#ugr.ovv.eclipse_setup.install_uima_eclipse_plugins">3.1.4. Install the UIMA Eclipse Plugins</a></span></dt><dt><span class="section"><a href="#ugr.ovv.eclipse_setup.start_eclipse">3.1.5. Start Eclipse</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ovv.eclipse_setup.example_code">3.2. Setting up Eclipse to view Example Code</a></span></dt><dt><
span class="section"><a href="#ugr.ovv.eclipse_setup.adding_source">3.3. Adding the UIMA source code to the jar files</a></span></dt><dt><span class="section"><a href="#ugr.ovv.eclipse_setup.linking_uima_javadocs">3.4. Attaching UIMA Javadocs</a></span></dt><dt><span class="section"><a href="#ugr.ovv.eclipse_setup.running_external_tools_from_eclipse">3.5. Running external tools from Eclipse</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.faqs">4. UIMA FAQ's</a></span></dt><dt><span class="chapter"><a href="#ugr.issues">5. Known Issues</a></span></dt><dt><span class="glossary"><a href="#ugr.glossary">Glossary</a></span></dt></dl></div><div class="chapter" lang="en" id="ugr.project_overview"><div class="titlepage"><div><div><h2 class="title"><a name="ugr.project_overview"></a>Chapter 1. UIMA Overview</h2></div></div></div><p>The Unstructured Information Management Architecture (UIMA) is an architecture and software framework
+ for creating, discovering, composing and deploying a broad range of multi-modal analysis capabilities and
+ integrating them with search technologies. The architecture is undergoing a standardization effort,
+ referred to as the <span class="emphasis"><em>UIMA specification</em></span> by a technical committee within
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=uima" target="_top">OASIS</a>.
+ </p><p>The <span class="emphasis"><em>Apache UIMA</em></span> framework is an Apache licensed, open source implementation of the
+ UIMA Architecture, and provides a run-time environment in which developers can plug in
+ and run their UIMA component implementations and with which they can build and deploy UIM applications. The
+ framework itself is not specific to any IDE or platform.</p><p>It includes an all-Java implementation of the
+ UIMA framework for the development, description, composition and deployment of UIMA components and
+ applications. It also provides the developer with an Eclipse-based (<a xmlns:xlink="http://www.w3.org/1999/xlink" href="http://www.eclipse.org/" target="_top">http://www.eclipse.org/</a>
+ ) development environment that includes a set of tools and utilities for using UIMA. It also includes
+ a C++ version of the framework, and
+ enablements for Annotators built in Perl, Python, and TCL.</p><p>This chapter is the intended starting point for readers that are new to the Apache UIMA Project. It includes
+ this introduction and the following sections:</p><div class="itemizedlist"><ul type="disc"><li><p> <a href="#ugr.project_overview_doc_overview" title="1.1. Apache UIMA Project Documentation Overview">Section 1.1, “Apache UIMA Project Documentation Overview”</a> provides a list of the books and topics included in
+ the Apache UIMA documentation with a brief summary of each. </p></li><li><p> <a href="#ugr.project_overview_doc_use" title="1.2. How to use the Documentation">Section 1.2, “How to use the Documentation”</a> describes a recommended path through the
+ documentation to help get the reader up and running with UIMA </p></li><li><p> <a href="#ugr.project_overview_migrating_from_ibm_uima" title="1.4. Migrating from IBM UIMA to Apache UIMA">Section 1.4, “Migrating from IBM UIMA to Apache UIMA”</a> is intended for users of IBM
+ UIMA, and describes the steps needed to upgrade to Apache UIMA. </p></li><li><p> <a href="#ugr.project_overview_changes_from_v1" title="1.3.2. Changes from UIMA Version 1.x">Section 1.3.2, “Changes from UIMA Version 1.x”</a> lists the changes that occurred between UIMA
+ v1.x and UIMA v2.x (independent of the transition to Apache).</p></li></ul></div><p>The main website for Apache UIMA is <a xmlns:xlink="http://www.w3.org/1999/xlink" href="http://incubator.apache.org/uima" target="_top">http://incubator.apache.org/uima</a>. Here you
+ can find out many things, including:
+ </p><div class="itemizedlist"><ul type="disc" compact><li><p>how to download (both the binary and source distributions</p></li><li><p>how to participate in the development</p></li><li><p>mailing lists - including the user list used like a forum for questions and answers</p></li><li><p>a Wiki where you can find and contribute all kinds of information, including tips and best practices</p></li><li><p>a sandbox - a subproject for potential new additions to Apache UIMA or to subprojects of it. Things here
+ are works in progress, and may (or may not) be included in releases.</p></li><li><p>links to conferences</p></li></ul></div><p>
+ </p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="ugr.project_overview_doc_overview"></a>1.1. Apache UIMA Project Documentation Overview</h2></div></div></div><p> The user documentation for UIMA is organized into several parts.
+ </p><div class="itemizedlist"><ul type="disc" compact><li><p> Overviews - this documentation </p></li><li><p> Eclipse Tooling Installation and Setup - also in this document </p></li><li><p> Tutorials and Developer's Guides </p></li><li><p> Tools Users' Guides </p></li><li><p> References </p></li></ul></div><p> </p><p>
+ The first 2 parts make up this book; the last 3 have individual
+ books. The books are provided both as
+ (somewhat large) html files, viewable in browsers, and also as PDF files.
+ The documentation is fully hyperlinked, with tables of contents. The PDF versions are set up to
+ print nicely - they have page numbers included on the cross references within a book. </p><p>If you view the PDF files inside
+ a browser that supports imbedded viewing of PDF, the hyperlinks between different PDF books may work (not
+ all browsers have been tested...).</p><p>The following set of tables gives a more detailed overview of the various parts of the
+ documentation.
+ </p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="ugr.project_overview_overview"></a>1.1.1. Overviews</h3></div></div></div><div class="informaltable"><table border="0" style="border-collapse: collapse;border-top: 0.5pt solid black; border-bottom: 0.5pt solid black; border-left: 0.5pt solid black; border-right: 0.5pt solid black; "><colgroup><col><col></colgroup><tbody><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><span class="emphasis"><em>Overview of the Documentation</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">
+ <p>What you are currently reading. Lists the documents provided in the Apache
+ UIMA documentation set and provides
+ a recommended path through the documentation for getting started using
+ UIMA. It includes release notes and provides a brief high-level description of
+ the different software modules included in the
+ Apache UIMA Project. See <a href="#ugr.project_overview_doc_overview" title="1.1. Apache UIMA Project Documentation Overview">Section 1.1, “Apache UIMA Project Documentation Overview”</a>.</p>
+ </td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><span class="emphasis"><em>Conceptual Overview</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Provides a broad conceptual overview of the UIMA component architecture; includes
+ references to the other documents in the documentation set that provide more detail.
+ See <a href="#ugr.ovv.conceptual" title="Chapter 2. UIMA Conceptual Overview">Chapter 2, <i xmlns:xlink="http://www.w3.org/1999/xlink">UIMA Conceptual Overview</i></a></td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><span class="emphasis"><em>UIMA FAQs</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Frequently Asked Questions about general UIMA concepts. (Not a programming
+ resource.) See <a href="#ugr.faqs" title="Chapter 4. UIMA Frequently Asked Questions (FAQ's)">Chapter 4, <i xmlns:xlink="http://www.w3.org/1999/xlink">UIMA Frequently Asked Questions (FAQ's)</i></a>.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><span class="emphasis"><em>Known Issues</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Known issues and problems with the UIMA SDK. See <a href="#ugr.issues" title="Chapter 5. Known Issues">Chapter 5, <i xmlns:xlink="http://www.w3.org/1999/xlink">Known Issues</i></a>.</td></tr><tr><td style="border-right: 0.5pt solid black; "><span class="emphasis"><em>Glossary</em></span>
+ </td><td style="">UIMA terms and concepts and their basic definitions. See <a href="#ugr.glossary" title="Glossary: Key Terms & Concepts">Glossary</a>.</td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="ugr.project_overview_setup"></a>1.1.2. Eclipse Tooling Installation and Setup</h3></div></div></div><p>Provides step-by-step instructions for installing Apache UIMA in the Eclipse Interactive
+ Development Environment. See <a href="#ugr.ovv.eclipse_setup" title="Chapter 3. Setting up the Eclipse IDE to work with UIMA">Chapter 3, <i xmlns:xlink="http://www.w3.org/1999/xlink">Setting up the Eclipse IDE to work with UIMA</i></a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="ugr.project_overview_tutorials_dev_guides"></a>1.1.3. Tutorials and Developer's Guides</h3></div></div></div><div class="informaltable"><table border="0" style="border-collapse: collapse;border-top: 0.5pt solid black; border-bottom: 0.5pt solid black; border-left: 0.5pt solid black; border-right: 0.5pt solid black; "><colgroup><col><col></colgroup><tbody><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_tutorial_annotator"></a><span class="emphasis"><em>Annotators and Analysis Engines</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Tutorial-style guide for building UIMA annotators and analysis engines. This chapter
+ introduces the developer to creating type systems and using UIMA's common data structure,
+ the CAS or Common Analysis Structure. It demonstrates how to use built in tools to specify and create
+ basic UIMA analysis components. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.aae" class="olink">Chapter 1, <i>Annotator and Analysis Engine Developer's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tutorial and Developers' Guides</span>.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_tutorial_cpe"></a><span class="emphasis"><em>Building UIMA Collection Processing Engines</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Tutorial-style guide for building UIMA collection processing engines. These
+ manage the
+ analysis of collections of documents from source to sink. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.cpe" class="olink">Chapter 2, <i>Collection Processing Engine Developer's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tutorial and Developers' Guides</span>.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_tutorial_application_development"></a><span class="emphasis"><em>Developing Complete Applications</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Tutorial-style guide on using the UIMA APIs to create, run and manage UIMA components from
+ your application. Also describes APIs for saving and restoring the contents of a CAS using an XML
+ format called <span class="trademark"> XMI</span>®. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.application" class="olink">Chapter 3, <i>Application Developer's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tutorial and Developers' Guides</span>.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_guide_flow_controller"></a><span class="emphasis"><em>Flow Controller</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">When multiple components are combined in an Aggregate, each CAS flow among the various
+ components. UIMA provides two built-in flows, and also allows custom flows to be
+ implemented. See <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.fc" class="olink">Chapter 4, <i>Flow Controller Developer's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tutorial and Developers' Guides</span>.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_guide_multiple_sofas"></a><span class="emphasis"><em>Developing Applications using Multiple Subjects of Analysis</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">A single CAS maybe associated with multiple subjects of analysis (Sofas). These are useful
+ for representing and analyzing different formats or translations of the same document. For
+ multi-modal analysis, Sofas are good for different modal representations of the same stream
+ (e.g., audio and close-captions).This chapter provides the developer details on how to use
+ multiple Sofas in an application. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.aas" class="olink">Chapter 5, <i>Annotations, Artifacts, and Sofas</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tutorial and Developers' Guides</span>.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_guide_multiple_views"></a><span class="emphasis"><em>Multiple CAS Views of an Artifact</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">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 the concepts, terminology, and the API and XML extensions that
+ enable this. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.mvs" class="olink">Chapter 6, <i>Multiple CAS Views of an Artifact</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tutorial and Developers' Guides</span>.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_guide_cas_multiplier"></a><span class="emphasis"><em>CAS Multiplier</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">A component may add additional CASes into the workflow. This may be useful to break up a large
+ artifact into smaller units, or to create a new CAS that collects information from multiple other
+ CASes. See <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.cm" class="olink">Chapter 7, <i>CAS Multiplier Developer's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tutorial and Developers' Guides</span>.</td></tr><tr><td style="border-right: 0.5pt solid black; "><a name="ugr.project_overview_xmi_emf"></a><span class="emphasis"><em>XMI and EMF Interoperability</em></span>
+ </td><td style="">The UIMA Type system and the contents of the CAS itself can be externalized using the XMI
+ standard for XML MetaData. Eclipse Modeling Framework (EMF) tooling can be used to develop
+ applications that use this information. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.xmi_emf" class="olink">Chapter 8, <i>XMI and EMF Interoperability</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tutorial and Developers' Guides</span>.</td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="ugr.project_overview_tool_guides"></a>1.1.4. Tools Users' Guides</h3></div></div></div><div class="informaltable"><table border="0" style="border-collapse: collapse;border-top: 0.5pt solid black; border-bottom: 0.5pt solid black; border-left: 0.5pt solid black; border-right: 0.5pt solid black; "><colgroup><col><col></colgroup><tbody><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_tools_component_descriptor_editor"></a><span class="emphasis"><em>Compon
ent Descriptor Editor</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Describes the features of the Component Descriptor Editor Tool. This tool provides a GUI for
+ specifying the details of UIMA component descriptors, including those for Analysis Engines
+ (primitive and aggregate), Collection Readers, CAS Consumers and Type Systems. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tools/tools.html#ugr.tools.cde" class="olink">Chapter 1, <i>Component Descriptor Editor User's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tools Guide and Reference</span>.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_tools_cpe_configurator"></a><span class="emphasis"><em>Collection Processing Engine Configurator</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Describes the User Interfaces and features of the CPE Configurator tool. This tool allows the
+ user to select and configure the components of a Collection Processing Engine and then to run the
+ engine. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tools/tools.html#ugr.tools.cpe" class="olink">Chapter 2, <i>Collection Processing Engine Configurator User's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tools Guide and Reference</span>.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_tools_pear_packager"></a><span class="emphasis"><em>Pear Packager</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Describes how to use the PEAR Packager utility. This utility enables developers to produce an
+ archive file for an analysis engine that includes all required resources for installing that
+ analysis engine in another UIMA environment. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tools/tools.html#ugr.tools.pear.packager" class="olink">Chapter 7, <i>PEAR Packager User's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tools Guide and Reference</span>.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_tools_pear_installer"></a><span class="emphasis"><em>Pear Installer</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Describes how to use the PEAR Installer utility. This utility installs and verifies an
+ analysis engine from an archive file (PEAR) with all its resources in the right place so it is ready to
+ run. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tools/tools.html#ugr.tools.pear.installer" class="olink">Chapter 8, <i>PEAR Installer User's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tools Guide and Reference</span>.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_tools_pear_merger"></a><span class="emphasis"><em>Pear Merger</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Describes how to use the Pear Merger utility, which does a simple merge of multiple PEAR
+ packages into one. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tools/tools.html#ugr.tools.pear.merger" class="olink">Chapter 9, <i>PEAR Merger User's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tools Guide and Reference</span>.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_tools_document_analyzer"></a><span class="emphasis"><em>Document Analyzer</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Describes the features of a tool for applying a UIMA analysis engine to a set of documents and
+ viewing the results. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tools/tools.html#ugr.tools.doc_analyzer" class="olink">Chapter 3, <i>Document Analyzer User's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tools Guide and Reference</span>.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_tools_cas_visual_debugger"></a><span class="emphasis"><em>CAS Visual Debugger</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Describes the features of a tool for viewing the detailed structure and contents of a CAS. Good
+ for debugging. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tools/tools.html#ugr.tools.cvd" class="olink">Chapter 5, <i>CAS Visual Debugger</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tools Guide and Reference</span>.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_tools_jcasgen"></a><span class="emphasis"><em>JCasGen</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Describes how to run the JCasGen utility, which automatically builds Java classes that
+ correspond to a particular CAS Type System. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tools/tools.html#ugr.tools.jcasgen" class="olink">Chapter 6, <i>JCasGen User's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tools Guide and Reference</span>.</td></tr><tr><td style="border-right: 0.5pt solid black; "><a name="ugr.project_overview_tools_xml_cas_viewer"></a><span class="emphasis"><em>XML CAS Viewer</em></span>
+ </td><td style="">Describes how to run the supplied viewer to view externalized XML forms of CASes. This viewer
+ is used in the examples. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tools/tools.html#ugr.tools.annotation_viewer" class="olink">Chapter 4, <i>Annotation Viewer</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tools Guide and Reference</span>.</td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="ugr.project_overview_reference"></a>1.1.5. References</h3></div></div></div><div class="informaltable"><table border="0" style="border-collapse: collapse;border-top: 0.5pt solid black; border-bottom: 0.5pt solid black; border-left: 0.5pt solid black; border-right: 0.5pt solid black; "><colgroup><col><col></colgroup><tbody><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_javadocs"></a><span class="emphasis"><em>Introduction to the UIMA API Javadocs</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Javadocs detailing the UIMA programming interfaces See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../references/references.html#ugr.ref.javadocs" class="olink">Chapter 1, <i>Javadocs</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA References</span></td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_xml_ref_component_descriptor"></a><span class="emphasis"><em>XML: Component Descriptor</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Provides detailed XML format for all the UIMA component descriptors, except the CPE (see
+ next). See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../references/references.html#ugr.ref.xml.component_descriptor" class="olink">Chapter 2, <i>Component Descriptor Reference</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA References</span>.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_xml_ref_collection_processing_engine_descriptor"></a><span class="emphasis"><em>XML: Collection Processing Engine Descriptor</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Provides detailed XML format for the Collection Processing Engine descriptor. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../references/references.html#ugr.ref.xml.cpe_descriptor" class="olink">Chapter 3, <i>Collection Processing Engine Descriptor Reference</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA References</span></td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_cas"></a><span class="emphasis"><em>CAS</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Provides detailed description of the principal CAS interface. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../references/references.html#ugr.ref.cas" class="olink">Chapter 4, <i>CAS Reference</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA References</span></td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_jcas"></a><span class="emphasis"><em>JCas</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Provides details on the JCas, a native Java interface to the CAS. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../references/references.html#ugr.ref.jcas" class="olink">Chapter 5, <i>JCas Reference</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA References</span></td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; "><a name="ugr.project_overview_ref_pear"></a><span class="emphasis"><em>PEAR Reference</em></span>
+ </td><td style="border-bottom: 0.5pt solid black; ">Provides detailed description of the deployable archive format for UIMA
+ components. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../references/references.html#ugr.ref.pear" class="olink">Chapter 6, <i>PEAR Reference</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA References</span></td></tr><tr><td style="border-right: 0.5pt solid black; "><a name="ugr.project_overview_xmi_cas_serialization"></a><span class="emphasis"><em>XMI CAS Serialization Reference</em></span>
+ </td><td style="">Provides detailed description of the deployable archive format for UIMA
+ components. See
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../references/references.html#ugr.ref.xmi" class="olink">Chapter 7, <i>XMI CAS Serialization Reference</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA References</span></td></tr></tbody></table></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="ugr.project_overview_doc_use"></a>1.2. How to use the Documentation</h2></div></div></div><div class="orderedlist"><ol type="1"><li><p>Explore this chapter to get an overview of the different documents that are included with Apache UIMA.</p></li><li><p> Read <a xmlns:xlink="http://www.w3.org/1999/xlink" href="overview_and_setup.html#ugr.ovv.conceptual" class="olink">Chapter 2, <i>UIMA Conceptual Overview</i></a> to get a broad
+ view of the basic UIMA concepts and philosophy with reference to the other documents included in the
+ documentation set which provide greater detail. </p></li><li><p> For more general information on the UIMA architecture and how it has been used, refer to the IBM Systems
+ Journal special issue on Unstructured Information Management, on-line at <a xmlns:xlink="http://www.w3.org/1999/xlink" href="http://www.research.ibm.com/journal/sj43-3.html" target="_top">http://www.research.ibm.com/journal/sj43-3.html</a> or to the section of the UIMA project
+ website on Apache website where other publications are listed. </p></li><li><p> Set up Apache UIMA in your Eclipse environment. To do this, follow the instructions in <a href="#ugr.ovv.eclipse_setup" title="Chapter 3. Setting up the Eclipse IDE to work with UIMA">Chapter 3, <i xmlns:xlink="http://www.w3.org/1999/xlink">Setting up the Eclipse IDE to work with UIMA</i></a>. </p></li><li><p> Develop sample UIMA annotators, run them and explore the results. Read <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.aae" class="olink">Chapter 1, <i>Annotator and Analysis Engine Developer's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tutorial and Developers' Guides</span> and follow it like a tutorial
+ to learn how to develop your first UIMA annotator and set up and run your first UIMA analysis engines.
+ </p><div class="itemizedlist"><ul type="disc"><li><p> As part of this you will use a few tools including
+ </p><div class="itemizedlist"><ul type="circle"><li><p> The UIMA Component Descriptor Editor, described in more detail in <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tools/tools.html#ugr.tools.cde" class="olink">Chapter 1, <i>Component Descriptor Editor User's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tools Guide and Reference</span> and </p></li><li><p> The Document Analyzer, described in more detail in <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tools/tools.html#ugr.tools.doc_analyzer" class="olink">Chapter 3, <i>Document Analyzer User's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tools Guide and Reference</span>. </p></li></ul></div><p> </p></li><li><p>While following along in <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.aae" class="olink">Chapter
1, <i>Annotator and Analysis Engine Developer's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tutorial and Developers' Guides</span>, reference documents that may help are:
+ </p><div class="itemizedlist"><ul type="circle"><li><p> <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../references/references.html#ugr.ref.xml.component_descriptor" class="olink">Chapter 2, <i>Component Descriptor Reference</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA References</span> for understanding the analysis
+ engine descriptors </p></li><li><p> <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../references/references.html#ugr.ref.jcas" class="olink">Chapter 5, <i>JCas Reference</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA References</span> for
+ understanding the JCas </p></li></ul></div><p> </p></li></ul></div><p> </p></li><li><p> Learn how to create, run and manage a UIMA analysis engine as part of an application.
+ Connect your analysis engine to the provided semantic search engine to learn how a
+ complete analysis and search application may be built with Apache UIMA. <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.application" class="olink">Chapter 3, <i>Application Developer's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tutorial and Developers' Guides</span> will guide you
+ through this process.
+ </p><div class="itemizedlist"><ul type="disc"><li><p> As part of this you will use the document analyzer (described in more detail in <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tools/tools.html#ugr.tools.doc_analyzer" class="olink">Chapter 3, <i>Document Analyzer User's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tools Guide and Reference</span> and semantic search
+ GUI tools (see <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.application.search.query_tool" class="olink">Section 3.5.2, “Semantic Search Query Tool”</a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tutorial and Developers' Guides</span>. </p></li></ul></div><p> </p></li><li><p> Pat yourself on the back. Congratulations! If you reached this step successfully, then you have an
+ appreciation for the UIMA analysis engine architecture. You would have built a few sample annotators,
+ deployed UIMA analysis engines to analyze a few documents, searched over the results using the built-in
+ semantic search engine and viewed the results through a built-in viewer
+ – all as part of a simple but complete application. </p></li><li><p> Develop and run a Collection Processing Engine (CPE) to analyze and gather the results of an entire
+ collection of documents. <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.cpe" class="olink">Chapter 2, <i>Collection Processing Engine Developer's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tutorial and Developers' Guides</span> will guide you through this process.
+ </p><div class="itemizedlist"><ul type="disc"><li><p> As part of this you will use the CPE Configurator tool. For details see <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tools/tools.html#ugr.tools.cpe" class="olink">Chapter 2, <i>Collection Processing Engine Configurator User's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tools Guide and Reference</span>. </p></li><li><p> You will also learn about CPE Descriptors. The detailed format for these may be found in <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../references/references.html#ugr.ref.xml.cpe_descriptor" class="olink">Chapter 3, <i>Collection Processing Engine Descriptor Reference</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA References</span>. </p></li></ul></div><p> </p></li><li><p> Learn how to package up an analysis engine for easy installation into another UIMA environment.
+ <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tools/tools.html#ugr.tools.pear.packager" class="olink">Chapter 7, <i>PEAR Packager User's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tools Guide and Reference</span> and <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tools/tools.html#ugr.tools.pear.installer" class="olink">Chapter 8, <i>PEAR Installer User's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tools Guide and Reference</span> will teach you how to
+ create UIMA analysis engine archives so that you can easily share your components with a broader
+ community. </p></li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="ugr.project_overview_changes_from_previous"></a>1.3. Changes from Previous Versions</h2></div></div></div><p> There are two previous version of UIMA, available from IBM's alphaWorks: version 1.4.x and version 2.0
+ (the 2.0 version was a "beta" only release). This section describes the changes relative to both of these
+ releases. A migration utility is provided which updates your Java code and descriptors as needed for this
+ release. See <a href="#ugr.project_overview_migrating_from_ibm_uima" title="1.4. Migrating from IBM UIMA to Apache UIMA">Section 1.4, “Migrating from IBM UIMA to Apache UIMA”</a> for instructions on how to
+ run the migration utility. </p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="ugr.project_overview_changes_from_2_0"></a>1.3.1. Changes from IBM UIMA 2.0 to Apache UIMA 2.1</h3></div></div></div><p>This section describes what has changed between version 2.0 and version 2.1 of UIMA;
+ the following section describes the differences between version 1.4 and version 2.1.
+ </p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="ugr.project_overview.migration_utility.java_package_name_changes"></a>1.3.1.1. Java Package Name Changes</h4></div></div></div><p>All of the UIMA Java package names have changed in Apache UIMA. They now start with
+ <code class="literal">org.apache</code> rather than <code class="literal">com.ibm</code>. There have been other
+ changes as well. The package name segment <code class="literal">reference_impl</code> has been shortened to
+ <code class="literal">impl</code>, and some segments have been reordered. For example
+ <code class="literal">com.ibm.uima.reference_impl.analysis_engine</code> has become
+ <code class="literal">org.apache.uima.analysis_engine.impl</code>. Tools are now consolidated under
+ <code class="literal">org.apache.uima.tools</code> and service adapters under
+ <code class="literal">org.apache.uima.adapter</code>. </p><p>The migration utility will replace all occurrences of IBM UIMA package names with their Apache UIMA
+ equivalents. It will not replace <span class="emphasis"><em>prefixes</em></span> of package names, so if your code uses
+ a package called <code class="literal">com.ibm.uima.myproject</code> (although that is not recommended), it
+ will not be replaced.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="ugr.project_overview.migration_utility.xml_descriptor_changes"></a>1.3.1.2. XML Descriptor Changes</h4></div></div></div><p>The XML namespace in UIMA component descriptors has changed from
+ <code class="literal">http://uima.watson.ibm.com/resourceSpecifier</code> to
+ <code class="literal">http://uima.apache.org/resourceSpecifier</code>. The value of the
+ <code class="literal"><frameworkImplementation></code> must now be
+ <code class="literal">org.apache.uima.java</code> or <code class="literal">org.apache.uima.cpp</code>. The
+ migration script will apply these replacements. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="ugr.project_overview.migration_utility.tcas_replaced_by_cas"></a>1.3.1.3. TCAS replaced by CAS</h4></div></div></div><p>In Apache UIMA the <code class="literal">TCAS</code> interface has been removed. All uses of it must now be
+ replaced by the <code class="literal">CAS</code> interface. (All methods that used to be defined on
+ <code class="literal">TCAS</code> were moved to <code class="literal">CAS</code> in v2.0.) The method
+ <code class="literal">CAS.getTCAS()</code> is replaced with <code class="literal">CAS.getCurrentView()</code> and
+ <code class="literal">CAS.getTCAS(String)</code> is replaced with <code class="literal">CAS.getView(String)</code>
+ . The following have also been removed and replaced with the equivalent "CAS" variants:
+ <code class="literal">TCASException</code>, <code class="literal">TCASRuntimeException</code>,
+ <code class="literal">TCasPool</code>, and <code class="literal">CasCreationUtils.createTCas(...)</code>. </p><p>The migration script will apply the necessary replacements.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="ugr.project_overview.migration_utility.jcas_interface"></a>1.3.1.4. JCas Is Now an Interface</h4></div></div></div><p>In previous versions, user code accessed the JCas <span class="emphasis"><em>class</em></span> directly. In Apache
+ UIMA there is now an interface, <code class="literal">org.apache.uima.jcas.JCas</code>, which all JCas-based
+ user code must now use. Static methods that were previously on the JCas class (and called from JCas cover
+ classes generated by JCasGen) have been moved to the new
+ <code class="literal">org.apache.uima.jcas.JCasRegistry</code> class. The migration script will apply the
+ necessary replacements to your code, including any JCas cover classes that are part of your codebase.
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="ugr.project_overview.migration_utility.jar_files"></a>1.3.1.5. JAR File names Have Changed</h4></div></div></div><p>The UIMA JAR file names have changed slightly. Underscores have been replaced with hyphens to
+ be consistent with Apache naming conventions. For example <code class="literal">uima_core.jar</code> is now
+ <code class="literal">uima-core.jar</code>. Also <code class="literal">uima_jcas_builtin_types.jar</code> has been
+ renamed to <code class="literal">uima-document-annotation.jar</code>. Finally, the <code class="literal">jVinci.jar</code>
+ file is now in the <code class="literal">lib</code> directory rather than the <code class="literal">lib/vinci</code>
+ directory as was previously the case. The migration script will apply the necessary replacements,
+ for example to script files or Eclipse launch configurations. (See <a href="#ugr.project_overview_running_the_migration_utility" title="1.4.1. Running the Migration Utility">Section 1.4.1, “Running the Migration Utility”</a> for a list of file extensions that
+ the migration utility will process by default.)
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="ugr.ovv.search_engine_repackaged"></a>1.3.1.6. Semantic Search Engine Repackaged</h4></div></div></div><p>The versions of the UIMA SDK prior to the move into Apache came with a semantic search engine. The Apache
+ version does not include this search engine. The search engine has been repackaged and is separately
+ available from <a xmlns:xlink="http://www.w3.org/1999/xlink" href="http://www.alphaworks.ibm.com/tech/uima" target="_top">http://www.alphaworks.ibm.com/tech/uima</a>. The intent is to hook up (over
+ time) with other open source search engines, such as the Lucene search engine project in Apache.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="ugr.project_overview_changes_from_v1"></a>1.3.2. Changes from UIMA Version 1.x</h3></div></div></div><p>Version 2.x of UIMA provides new capabilities and refines several areas of the UIMA
+ architecture, as compared with version 1.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="ugr.project_overview_new_capabilities"></a>1.3.2.1. New Capabilities</h4></div></div></div><p><a name="ugr.project_overview_new_data_types"></a><b>New Primitive data types. </b>UIMA now supports Boolean (bit), Byte, Short (16 bit integers), Long (64 bit
+ integers), and Double (64 bit floating point) primitive types, and arrays of
+ these. These types can be used like all the other primitive types.</p><p><a name="ugr.ovv.simpler_aes_and_cases"></a><b>Simpler Analysis Engines and CASes. </b>Version 1.x made a distinction between Analysis Engines and Text Analysis
+ Engines. This distinction has been eliminated in Version 2 - new code should just
+ refer to Analysis Engines. Analysis Engines can operate on multiple kinds of
+ artifacts, including text.</p><p><a name="ugr.ovv.sofas_and_cas_views_simplified"></a><b>Sofas and CAS Views simplified. </b>The APIs for manipulating multiple subjects of analysis (Sofas) and their
+ corresponding CAS Views have been simplified.</p><p><a name="ugr.ovv.ae_support_multiple_new_cases"></a><b>Analysis Component generalized to support multiple new CAS
+ outputs. </b>Analysis Components, in general, can make use of new capabilities to return
+ multiple new CASes, in addition to returning the original CAS that is passed in.
+ This allows components to have Collection Reader-like capabilities, but be
+ placed anywhere in the flow. See <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.cm" class="olink">Chapter 7, <i>CAS Multiplier Developer's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tutorial and Developers' Guides</span>
+ .</p><p><a name="ugr.ovv.user_customized_fc"></a><b>User-customized Flow Controllers. </b>A new component, the Flow Controller, can be supplied by the user to implement
+ arbitrary flow control for CASes within an Aggregate. This is in addition to the two
+ built-in flow control choices of linear and language-capability flow. See <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.fc" class="olink">Chapter 4, <i>Flow Controller Developer's Guide</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tutorial and Developers' Guides</span>
+ .</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="ugr.ovv.other_changes"></a>1.3.2.2. Other Changes</h4></div></div></div><p><b>New additional Annotator API ImplBase. </b>
+ Version 2.1 has a new set of Annotator interfaces. Annotators should now
+ extend CasAnnotator_ImplBase or JCasAnnotator_ImplBase instead of the v1.x
+ TextAnnotator_ImplBase and JTextAnnotator_ImplBase. The v1.x annotator
+ interfaces are unchanged and are still supported for backwards compatibility.
+ </p><p>
+ The new Annotator interfaces support the changed approaches for ResultSpecifications
+ and the changed exception names (see below), and have all the methods that CAS Consumers
+ have, including CollectionProcessComplete and BatchProcessComplete.</p><p><a name="ugr.ovv.exceptions_rationalized"></a><b>UIMA Exceptions rationalized. </b> In version 1 there were different exceptions for the methods of an
+ AnalysisEngine and for the corresponding methods of an Annotator; these were merged
+ in version 2.
+
+ </p><div class="itemizedlist"><ul type="disc" compact><li><p>AnnotatorProcessException (v1) <span class="symbol">→</span>
+ AnalysisEngineProcessException (v2)</p></li><li><p>AnnotatorInitializationException (v1) <span class="symbol">→</span>
+ ResourceInitializationException (v2)</p></li><li><p>AnnotatorConfigurationException (v1) <span class="symbol">→</span>
+ ResourceConfigurationException (v2)</p></li><li><p>AnnotatorContextException (v1) <span class="symbol">→</span>
+ ResourceAccessException (v2)</p></li></ul></div><p> The previous exceptions are still available, but new code should
+ use the new exceptions.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>The signature for typeSystemInit changed the “<span class="quote">throws</span>” clause to throw AnalysisEngineProcessException.
+ For Annotators that extend the previous base, the previous definition of typeSystemInit will continue to
+ work for backwards compatibility.
+ </p></div><p><a name="ugr.ovv.result_specification"></a><b>Changes in Result Specifications. </b>In version 1, the <code class="literal">process(...)</code> method took a second
+ argument, a ResultSpecification. Now it is set when changed and it's up to the
+ annotator to store it in a local field and make it available when needed.
+ This approach lets the annotator receive a specific signal (a method call) when
+ the Result Specification changes. Previously, it would need to check on every call to
+ see if it changed. The default impl base classes provide set/getResultSpecification(...)
+ methods for this</p><p><a name="ugr.ovv.one_capability_set"></a><b>Only one Capability Set. </b>In version one, you can define
+ multiple capability sets. These were not supported well, and for version two,
+ this is now simplified - you should only use one capability set.
+ (For backwards compatibility, if you use more,
+ this won't cause a problem for now).</p><p><b>TextAnalysisEngine deprecated; use AnalysisEngine instead. </b>TextAnalysisEngine has been deprecated - it is now no different than
+ AnalysisEngine. Previous code that uses this should still continue to work,
+ however.</p><p><b>Annotator Context deprecated; use UimaContext instead. </b>The context for the Annotator is the same as the overall UIMA context.
+ The impl base classes provide a getContext() method which returns now the
+ UimaContext object.</p><p><b>DocumentAnalyzer tool uses XMI formats. </b>The DocumentAnalyzer tool saves outputs in the new XMI serialization format.
+ The AnnotationViewer and SemanticSearchGUI tools can read both the new XMI format
+ and the previous XCAS format.</p><p><b>CAS Initializer deprecated. </b>Example code that used CAS Initializers has been rewritten to not use this.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="ugr.project_overview_backwards_compatibility"></a>1.3.2.3. Backwards Compatibility</h4></div></div></div><p>Other than the changes from IBM UIMA to Apache UIMA described above, most UIMA 1.x
+ applications should not require additional changes to upgrade to UIMA 2.x. However,
+ there are a few exceptions that UIMA 1.x users may need to be aware of:
+ </p><div class="itemizedlist"><ul type="disc"><li><p> There have been some changes to ResultSpecifications. We do not
+ guarantee 100% backwards compatibility for applications that made use of
+ them, although most cases should work. </p></li><li><p> For applications that deal with multiple subjects of analysis (Sofas),
+ the rules that determine whether a component is Multi-View or Single-View
+ have been made more consistent. A component is considered Multi-View if and
+ only if it declares at least one inputSofa or outputSofa in its descriptor.
+ This leads to the following incompatibilities in unusual cases:
+ </p><div class="itemizedlist"><ul type="circle"><li><p> It is an error if an annotator that implements the TextAnnotator or
+ JTextAnnotator interface also declares inputSofas or outputSofas in
+ its descriptor. Such annotators must be Single-View. </p></li><li><p> Annotators that implement GenericAnnotator but do not declare
+ any inputSofas or outputSofas will now be passed the view of default
+ Sofa instead of the Base CAS. </p></li></ul></div><p> </p></li></ul></div><p> </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="ugr.project_overview_migrating_from_ibm_uima"></a>1.4. Migrating from IBM UIMA to Apache UIMA</h2></div></div></div><p>In Apache UIMA, several things have changed that require changes to user code and descriptors.
+ A migration utility is provided which will make the required updates to your files. The most
+ significant change is that the Java package names for all of the UIMA classes and interfaces have changed
+ from what they were in IBM UIMA; all of the package names now start with the prefix <code class="literal">org.apache</code>.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="ugr.project_overview_running_the_migration_utility"></a>1.4.1. Running the Migration Utility</h3></div></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Before running the migration utility, be sure to back up your files, just in case you encounter any
+ problems, because the migration tool updates the files in place in the directories where it finds them.</p></div><p> The migration utility is run by executing the script file
+ <code class="literal">apache-uima/bin/ibmUimaToApacheUima.bat</code> (Windows) or
+ <code class="literal">apache-uima/bin/ibmUimaToApacheUima.sh</code> (UNIX). You must pass one argument: the
+ directory containing the files that you want to be migrated. Subdirectories will be processed
+ recursively.</p><p>The script scans your files and applies the necessary updates, for example replacing the com.ibm
+ package names with the new org.apache package names. For more details on what has changed in the UIMA APIs and
+ what changes are performed by the migration script, see <a href="#ugr.project_overview_changes_from_2_0" title="1.3.1. Changes from IBM UIMA 2.0 to Apache UIMA 2.1">Section 1.3.1, “Changes from IBM UIMA 2.0 to Apache UIMA 2.1”</a>.</p><p>The script will only attempt to modify files with the extensions: java, xml, xmi, wsdd, properties,
+ launch, bat, cmd, sh, ksh, or csh; and files with no extension. Also, files with size greater than 1,000,000
+ bytes will be skipped. (If you want the script to modify files with other extensions, you can edit the script
+ file and change the <code class="literal">-ext</code> argument appropriately.) </p><p>If the migration tool reports warnings, there may be a few additional steps to take. The following two
+ sections explain some simple manual changes that you might need to make to your code.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="ugr.project_overview_running_the_migration_utility.jcas_for_document_annotation"></a>1.4.1.1. JCas Cover Classes for DocumentAnnotation</h4></div></div></div><p> If you have run JCasGen it is likely that you have the classes
+ <code class="literal">com.ibm.uima.jcas.tcas.DocumentAnnotation</code> and
+ <code class="literal">com.ibm.uima.jcas.tcas.DocumentAnnotation_Type</code> as part of your code. This
+ package name is no longer valid, and the migration utility does not move your files between directories so
+ it is unable to fix this. </p><p> If you have not made manual modifications to these classes, the best solution is usually to just delete
+ these two classes (and their containing package). There is a default version in the
+ <code class="literal">uima-document-annotation.jar</code> file that is included in Apache UIMA. If you
+ <span class="emphasis"><em>have</em></span> made custom changes, then you should not delete the file but instead move it to
+ the correct package <code class="literal">org.apache.uima.jcas.tcas</code>. For more information about JCas
+ and DocumentAnnotation please see <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../references/references.html#ugr.ref.jcas.documentannotation_issues" class="olink">Section 5.5.4, “Adding Features to DocumentAnnotation”</a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA References</span> </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="ugr.project_overview_running_the_migration_utility.manual_migration_needed.getdocumentannotation"></a>1.4.1.2. JCas.getDocumentAnnotation</h4></div></div></div><p>The deprecated method <code class="literal">JCas.getDocumentAnnotation</code> has been removed. Its use
+ must be replaced with <code class="literal">JCas.getDocumentAnnotationFs</code>. The method
+ <code class="literal">JCas.getDocumentAnnotationFs()</code> returns type <code class="literal">TOP</code>, so your
+ code must cast this to type <code class="literal">DocumentAnnotation</code>. The reasons for this are described
+ in <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../references/references.html#ugr.ref.jcas.documentannotation_issues" class="olink">Section 5.5.4, “Adding Features to DocumentAnnotation”</a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA References</span>.
+ </p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="ugr.project_overview_rare_migration"></a>1.4.2. Manual Migration</h3></div></div></div><p>The following are rare cases where you may need to take additional steps to migrate your code. You need only
+ read this section if the migration tool reported a warning or if you are having trouble getting your code to
+ compile or run after running the migration. For most users, attention to these things will not
+ be required.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="ugr.project_overview.manual_migration_needed.xiinclude"></a>1.4.2.1. xi:include</h4></div></div></div><p>The use of <xi:include> in UIMA component descriptors has been discouraged for some time, and in
+ Apache UIMA support for it has been removed. If you have descriptors that use that, you must change them to
+ use UIMA's <import> syntax instead. The proper syntax is described in <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../references/references.html#ugr.ref.xml.component_descriptor.imports" class="olink">Section 2.2, “Imports”</a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA References</span>.
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="ugr.project_overview.manual_migration_needed.duplicate_methods_cas_tcas"></a>1.4.2.2. Duplicate Methods Taking CAS and TCAS as Arguments</h4></div></div></div><p>Because <code class="literal">TCAS</code> has been replaced by <code class="literal">CAS</code>, if you had two
+ methods distinguished only by whether an argument type was <code class="literal">TCAS</code> or
+ <code class="literal">CAS</code>, the migration tool will cause these to have identical signatures, which will be
+ a compile error. If this happens, consider why the two variants were needed in the first place. Often, it may
+ work to simply delete one of the methods.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="ugr.project_overview.manual_migration_needed.undocumented_methods"></a>1.4.2.3. Use of Undocumented Methods from the com.ibm.uima.util package</h4></div></div></div><p>Previous UIMA versions has some methods in the <code class="literal">com.ibm.uima.util</code> package that
+ were for internal use and were not documented in the Javadoc. (There are also many methods in that package
+ which are documented, and there is no issue with using these.) It is not recommended that you use any of the
+ undocumented methods. If you do, the migration script will not handle them correctly. These have now been
+ moved to <code class="literal">org.apache.uima.internal.util</code>, and you will have to manually update your
+ imports to point to this location.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="ugr.project_overview.manual_migration_needed.uima_package_names_in_user_code"></a>1.4.2.4. Use of UIMA Package Names for User Code</h4></div></div></div><p>If you have placed your own classes in a package that has exactly the same name as one of the UIMA packages
+ (not recommended), this will cause problems when your run the migration script. Since the script replaces
+ UIMA package names, all of your imports that refer to your class will get replaced and your code will no
+ longer compile. If this happens, you can fix it by manually moving your code to the new Apache UIMA package
+ name (i.e., whatever name your imports got replaced with). However, we recommend instead that you do not
+ use Apache UIMA package names for your own code.</p><p>An even more rare case would be if you had a package name that started with a capital letter (poor Java
+ style) AND was prefixed by one of the UIMA package names, for example a package named
+ <code class="literal">com.ibm.uima.MyPackage</code>. This would be treated as a class name and replaced with
+ <code class="literal">org.apache.uima.MyPackage</code> wherever it occurs.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="ugr.project_overview.manual_migration_needed.exceptions_extend_uima_exceptions"></a>1.4.2.5. CASException and CASRuntimeException now extend UIMA(Runtime)Exception</h4></div></div></div><p>
+ This change may affect user code to a small extent, as some of the APIs on
+ <code class="literal">CASException</code> and <code class="literal">CASRuntimeException</code> no longer exist.
+ On the up side, all UIMA exceptions are now derived from the same base classes and behave
+ the same way. The most significant change is that you can no longer check for the specific
+ type of exception the way you used to. For example, if you had code like this:
+
+ </p><pre class="programlisting">catch (CASRuntimeException e) {
+ if (e.getError() == CASRuntimeException.ILLEGAL_ARRAY_SIZE) {
+ // Do something in case this particular error is caught</pre><p>
+
+ you will need to replace it with the following:
+
+ </p><pre class="programlisting">catch (CASRuntimeException e) {
+ if (e.getMessageKey().equals(CASRuntimeException.ILLEGAL_ARRAY_SIZE)) {
+ // Do something in case this particular error is caught</pre><p>
+
+ as the message keys are now strings. This change is not handled by the migration script.
+ </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="ugr.project_overview_summary"></a>1.5. Apache UIMA Summary</h2></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="ugr.ovv.summary.general"></a>1.5.1. General</h3></div></div></div><p>UIMA supports the development, discovery, composition and deployment of multi-modal
+ analytics for the analysis of unstructured information and its integration with search
+ technologies.</p><p>Apache UIMA includes APIs and tools for creating analysis components. Examples of analysis components include
+ tokenizers, summarizers, categorizers, parsers, named-entity detectors etc. Tutorial examples are
+ provided with Apache UIMA; additional components are available from the community. </p><p>Apache UIMA does not itself include a semantic search engine; instructions are included for
+ incorporating the semantic search SDK from IBM's <a xmlns:xlink="http://www.w3.org/1999/xlink" href="http://alphaworks.ibm.com/tech/uima" target="_top">alphaWorks</a>
+ which can index the results of
+ analysis and for using this semantic index to perform more advanced search. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="ugr.ovv.summary.programming_language_support"></a>1.5.2. Programming Language Support</h3></div></div></div><p>UIMA supports the development and integration of analysis algorithms developed in different
+ programming languages. </p><p>The Apache UIMA project is both a Java framework and a matching C++
+ enablement layer, which allows annotators to be written in C++ and have access to a C++ version of the CAS. The
+ C++ enablement layer also enables annotators to be written in Perl, Python, and TCL, and to interoperate with
+ those written in other languages.
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="ugr.ovv.general.summary.multi_modal_support"></a>1.5.3. Multi-Modal Support</h3></div></div></div><p>The UIMA architecture supports the development, discovery, composition and deployment of
+ multi-modal analytics, including text, audio and video. <a xmlns:xlink="http://www.w3.org/1999/xlink" href="../tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.aas" class="olink">Chapter 5, <i>Annotations, Artifacts, and Sofas</i></a> in <span xmlns:xlink="http://www.w3.org/1999/xlink" class="olinkdocname">UIMA Tutorial and Developers' Guides</span> discuss this is more
+ detail.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="ugr.ovv.summary.general.semantic_search_components"></a>1.5.4. Semantic Search Components</h3></div></div></div><p> The Lucene search engine as of this writing (November, 2006) does not support searching with
+ annotations. The site <a xmlns:xlink="http://www.w3.org/1999/xlink" href="http://www.alphaworks.ibm.com/tech/uima" target="_top">http://www.alphaworks.ibm.com/tech/uima</a> provides a download of a
+ semantic search engine, a simple demo query tool, some documentation on the semantic search engine, and a
+ component that connects the results of UIMA analysis to the indexer so that the annotations as well as
+ key-words can be indexed. </p><p>Previous versions of the UIMA SDK (prior to the Apache versions) are available from <a xmlns:xlink="http://www.w3.org/1999/xlink" href="http://www.alphaworks.ibm.com/tech/uima" target="_top"> IBM's alphaWorks</a>. The source code for
+ previous versions of the main UIMA framework is available on <a xmlns:xlink="http://www.w3.org/1999/xlink" href="http://uima-framework.sourceforge.net/" target="_top"> SourceForge</a>.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="ugr.project_overview_summary_sdk_capabilities"></a>1.6. Summary of Apache UIMA Capabilities</h2></div></div></div><div class="informaltable"><table border="0" style="border-collapse: collapse;border-top: 0.5pt solid black; border-bottom: 0.5pt solid black; border-left: 0.5pt solid black; border-right: 0.5pt solid black; "><colgroup><col><col></colgroup><tbody><tr><td class="tableSubhead" style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Module</td><td class="tableSubhead" style="border-bottom: 0.5pt solid black; ">Description</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">UIMA Framework
Core</td><td style="border-bottom: 0.5pt solid black; ">
+ <p>A framework integrating core functions for creating, deploying, running and managing UIMA
+ components, including analysis engines and Collection Processing Engines in collocated and/or
+ distributed configurations. </p>
+
+ <p>The framework includes an implementation of core components for transport layer adaptation,
+ CAS management, workflow management based on declarative specifications, resource management,
+ configuration management, logging, and other functions.</p>
+ </td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">C++ and other programming language Interoperability</td><td style="border-bottom: 0.5pt solid black; ">
+ <p>Includes C++ CAS and supports the creation of UIMA compliant C++ components that can be
+ deployed in the UIMA run-time through a built-in JNI adapter. This includes high-speed binary
+ serialization.</p>
+
+ <p>Includes support for creating service-based UIMA engines. This is ideal for
+ wrapping existing code written in different languages.</p>
+ </td></tr><tr><td class="tableSubhead" style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Framework Services and APIs</td><td class="tableSubhead" style="border-bottom: 0.5pt solid black; ">Note that interfaces of these components are available to the developer
+ but different implementations are possible in different implementations of the UIMA
+ framework.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">CAS</td><td style="border-bottom: 0.5pt solid black; ">These classes provide the developer with typed access to the Common Analysis Structure (CAS),
+ including type system schema, elements, subjects of analysis and indices. Multiple subjects of
+ analysis (Sofas) mechanism supports the independent or simultaneous analysis of multiple views of
+ the same artifacts (e.g. documents), supporting multi-lingual and multi-modal analysis.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">JCas</td><td style="border-bottom: 0.5pt solid black; ">An alternative interface to the CAS, providing Java-based UIMA Analysis components with
+ native Java object access to CAS types and their attributes or features, using the
+ JavaBeans conventions of getters and setters.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Collection Processing Management (CPM)</td><td style="border-bottom: 0.5pt solid black; ">Core functions for running UIMA collection processing engines in collocated and/or
+ distributed configurations. The CPM provides scalability across parallel processing pipelines,
+ check-pointing, performance monitoring and recoverability.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Resource Manager</td><td style="border-bottom: 0.5pt solid black; ">Provides UIMA components with run-time access to external resources handling capabilities
+ such as resource naming, sharing, and caching. </td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Configuration Manager</td><td style="border-bottom: 0.5pt solid black; ">Provides UIMA components with run-time access to their configuration parameter settings.
+ </td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Logger</td><td style="border-bottom: 0.5pt solid black; ">Provides access to a common logging facility.</td></tr><tr><td class="tableSubhead" style="border-bottom: 0.5pt solid black; " colspan="2" align="center"> Tools and Utilities
+ </td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">JCasGen</td><td style="border-bottom: 0.5pt solid black; ">Utility for generating a Java object model for CAS types from a UIMA XML type system
+ definition.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Saving and Restoring CAS contents</td><td style="border-bottom: 0.5pt solid black; ">APIs in the core framework support saving and restoring the contents of a CAS to streams using an
+ XMI format. </td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">PEAR Packager for Eclipse</td><td style="border-bottom: 0.5pt solid black; ">Tool for building a UIMA component archive to facilitate porting, registering, installing and
+ testing components.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">PEAR Installer</td><td style="border-bottom: 0.5pt solid black; ">Tool for installing and verifying a UIMA component archive in a UIMA installation.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">PEAR Merger</td><td style="border-bottom: 0.5pt solid black; ">Utility that combines multiple PEARs into one.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Component Descriptor Editor</td><td style="border-bottom: 0.5pt solid black; ">Eclipse Plug-in for specifying and configuring component descriptors for UIMA analysis
+ engines as well as other UIMA component types including Collection Readers and CAS
+ Consumers.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">CPE Configurator</td><td style="border-bottom: 0.5pt solid black; ">Graphical tool for configuring Collection Processing Engines and applying them to
+ collections of documents.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Java Annotation Viewer</td><td style="border-bottom: 0.5pt solid black; ">Viewer for exploring annotations and related CAS data.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">CAS Visual Debugger</td><td style="border-bottom: 0.5pt solid black; ">GUI Java application that provides developers with detailed visual view of the contents of a
+ CAS.</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Document Analyzer</td><td style="border-bottom: 0.5pt solid black; ">GUI Java application that applies analysis engines to sets of documents and shows results in a
+ viewer.</td></tr><tr><td class="tableSubhead" style="border-bottom: 0.5pt solid black; " colspan="2" align="center"> Example Analysis
+ Components </td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Database Writer</td><td style="border-bottom: 0.5pt solid black; ">CAS Consumer that writes the content of selected CAS types into a relational database, using
+ JDBC. This code is in cpe/PersonTitleDBWriterCasConsumer. </td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Annotators</td><td style="border-bottom: 0.5pt solid black; "> Set of simple annotators meant for pedagogical purposes. Includes: Date/time, Room-number,
+ Regular expression, Tokenizer, and Meeting-finder annotator. There are also sample wrappers for
+ annotators obtainable from <a xmlns:xlink="http://www.w3.org/1999/xlink" href="opennlp.org" target="_top">opennlp.org</a>. There are sample CAS Multipliers
+ as well. </td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Flow Controllers</td><td style="border-bottom: 0.5pt solid black; "> There is a sample flow-controller based on the whiteboard concept of sending the CAS to whatever
+ annotator hasn't yet processed it, when that annotator's inputs are available in the CAS. </td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">XMI Collection Reader, CAS Consumer</td><td style="border-bottom: 0.5pt solid black; ">Reads and writes the CAS in the XMI format</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">File System Collection Reader</td><td style="border-bottom: 0.5pt solid black; "> Simple Collection Reader for pulling documents from the file system and initializing CASes.
+ </td></tr><tr><td class="tableSubhead" style="border-bottom: 0.5pt solid black; " colspan="2" align="center"> Components available
+ from <a xmlns:xlink="http://www.w3.org/1999/xlink" href="www.alphaworks.ibm.com/tech/uima" target="_top">www.alphaworks.ibm.com/tech/uima</a> </td></tr><tr><td style="border-right: 0.5pt solid black; ">Semantic Search CAS Indexer</td><td style="">A CAS Consumer that uses the semantic search engine indexer to build an index from a stream of
+ CASes. Requires the semantic search engine (available from the same place). </td></tr></tbody></table></div></div></div><div class="chapter" lang="en" id="ugr.ovv.conceptual"><div class="titlepage"><div><div><h2 class="title"><a name="ugr.ovv.conceptual"></a>Chapter 2. UIMA Conceptual Overview</h2></div></div></div><p>UIMA is an open, industrial-strength, scaleable and extensible platform for
+ creating, integrating and deploying unstructured information management solutions
+ from powerful text or multi-modal analysis and search components. </p><p>The Apache UIMA project is an implementation of the Java UIMA framework available
+ under the Apache License, providing a common foundation for industry and academia to
[... 985 lines stripped ...]