Modified: uima/site/trunk/uima-website/docs/d/uimaj-current/overview_and_setup.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimaj-current/overview_and_setup.html?rev=1907218&r1=1907217&r2=1907218&view=diff ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimaj-current/overview_and_setup.html (original) +++ uima/site/trunk/uima-website/docs/d/uimaj-current/overview_and_setup.html Thu Feb 2 08:24:16 2023 @@ -1,10 +1,10 @@ <html><head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> - <title>UIMA Overview & SDK Setup</title><link rel="stylesheet" type="text/css" href="css/stylesheet-html.css"><meta name="generator" content="DocBook XSL-NS Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div lang="en" class="book" title="UIMA Overview & SDK Setup" id="d5e1"><div xmlns:d="http://docbook.org/ns/docbook"; class="titlepage"><div><div><h1 class="title">UIMA Overview & SDK Setup</h1></div><div><div class="authorgroup"> + <title>UIMA Overview & SDK Setup</title><link rel="stylesheet" type="text/css" href="css/stylesheet-html.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div lang="en" class="book" id="d5e1"><div xmlns:d="http://docbook.org/ns/docbook"; class="titlepage"><div><div><h1 class="title">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 3.3.1</p></div><div><p class="copyright">Copyright © 2006, 2022 The Apache Software Foundation</p></div><div><p class="copyright">Copyright © 2004, 2006 International Business Machines Corporation</p></div><div><div class="legalnotice" title="Legal Notice"><a name="d5e8"></a> + </div></div><div><p class="releaseinfo">Version 3.4.0</p></div><div><p class="copyright">Copyright © 2006, 2023 The Apache Software Foundation</p></div><div><p class="copyright">Copyright © 2004, 2006 International Business Machines Corporation</p></div><div><div class="legalnotice" id="d5e8"> <p> </p> - <p title="License and Disclaimer"> + <p> <b>License and Disclaimer. </b> The ASF licenses this documentation @@ -14,7 +14,7 @@ </p><div class="blockquote"><blockquote class="blockquote"> <a class="ulink" href="http://www.apache.org/licenses/LICENSE-2.0"; target="_top">http://www.apache.org/licenses/LICENSE-2.0</a> - </blockquote></div><p title="License and Disclaimer"> + </blockquote></div><p> Unless required by applicable law or agreed to in writing, this documentation and its contents are distributed under the License @@ -27,7 +27,7 @@ </p> <p> </p> <p> </p> - <p title="Trademarks"> + <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 @@ -35,13 +35,13 @@ the trademark or service mark. </p> - </div></div><div><p class="pubdate">October, 2022</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><dt><span class="section"><a href="#ugr.project_overview_v3" >1.1.6. Version 3 User's guide</a></span></dt></dl></dd><dt><span >class="section"><a href="#ugr.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 UIMA >Version 2</a></span></dt><dt><span class="section"><a >href="#ugr.project_overview_migrating_from_v2_to_v3">1.4. Migrating existing >UIMA pipelines from Version 2 to Version 3</a></span></dt><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></dl></dd><dt><span class="section"><a >href="#ugr.project_overview_summar y_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 Architecture, 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 Ex ternal 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_processing">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><dt><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_uima_eclipse_plugins">3.1.2. Installing >the UIMA Eclipse Plugins</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 c lass="section"><a href="#ugr.ovv.eclipse_setup.install_uima_eclipse_plugins_manually">3.1.4. Installing the UIMA Eclipse Plugins, manually</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 clas s="glossary"><a href="#ugr.glossary">Glossary</a></span></dt></dl></div> + </div></div><div><p class="pubdate">January, 2023</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><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><dt><span class="section"><a href="#ugr.project_ overview_v3">1.1.6. Version 3 User's guide</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.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 UIMA Version 2</a></span></dt><dt><span class="section"><a href="#ugr.project_overview_migrating_from_v2_to_v3">1.4. Migrating existing UIMA pipelines from Version 2 to Version 3</a></span></dt><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></dl></dd><dt><span class="section"><a href="#ugr.project_ove rview_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 Architecture, 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_processing">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.sema ntic_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><dt><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_uima_eclipse_plugins">3.1.2. Installing the UIMA Eclipse Plugins</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_manually">3.1.4. >Installing the UIMA Eclipse Plugins, manually</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><d t><span class="glossary"><a href="#ugr.glossary">Glossary</a></span></dt></dl></div> - <div class="chapter" title="Chapter 1. UIMA Overview" id="ugr.project_overview"><div class="titlepage"><div><div><h2 class="title">Chapter 1. UIMA Overview</h2></div></div></div> + <div class="chapter" id="ugr.project_overview"><div class="titlepage"><div><div><h1 class="title">Chapter 1. UIMA Overview</h1></div></div></div> @@ -66,7 +66,7 @@ <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 class="itemizedlist" type="disc"><li class="listitem"> + <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> <p> <a class="xref" 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 class="listitem"> @@ -76,14 +76,14 @@ <p>The main website for Apache UIMA is <a class="ulink" href="http://uima.apache.org"; target="_top">http://uima.apache.org</a>. Here you can find out many things, including: - </p><div class="itemizedlist"><ul class="itemizedlist" type="disc" compact><li class="listitem"><p>how to download (both the binary and source distributions</p></li><li class="listitem"><p>how to participate in the development</p></li><li class="listitem"><p>mailing lists - including the user list used like a forum for questions and answers</p></li><li class="listitem"><p>a Wiki where you can find and contribute all kinds of information, including tips and best practices</p></li><li class="listitem"><p>a sandbox - a subproject for potential new additions to Apache UIMA or to subprojects of it. Things here + </p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc; "><li class="listitem"><p>how to download (both the binary and source distributions</p></li><li class="listitem"><p>how to participate in the development</p></li><li class="listitem"><p>mailing lists - including the user list used like a forum for questions and answers</p></li><li class="listitem"><p>a Wiki where you can find and contribute all kinds of information, including tips and best practices</p></li><li class="listitem"><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 class="listitem"><p>links to conferences</p></li></ul></div><p> </p> - <div class="section" title="1.1. Apache UIMA Project Documentation Overview"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.project_overview_doc_overview">1.1. Apache UIMA Project Documentation Overview</h2></div></div></div> + <div class="section" id="ugr.project_overview_doc_overview"><div class="titlepage"><div><div><h2 class="title" style="clear: both">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 class="itemizedlist" type="disc" compact><li class="listitem"> + </p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc; "><li class="listitem"> <p> Overviews - this documentation </p> </li><li class="listitem"> <p> Eclipse Tooling Installation and Setup - also in this document </p> @@ -112,69 +112,69 @@ documentation. </p> - <div class="section" title="1.1.1. Overviews"><div class="titlepage"><div><div><h3 class="title" id="ugr.project_overview_overview">1.1.1. Overviews</h3></div></div></div> + <div class="section" id="ugr.project_overview_overview"><div class="titlepage"><div><div><h3 class="title">1.1.1. Overviews</h3></div></div></div> <div class="informaltable"> - <table 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 class="col1"><col class="col2"></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; "> + <table class="informaltable" style="border-collapse: collapse;border-top: 1px solid black; border-bottom: 1px solid black; border-left: 1px solid black; border-right: 1px solid black; "><colgroup><col class="col1"><col class="col2"></colgroup><tbody><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>Overview of the Documentation</em></span> + </td><td style="border-bottom: 1px 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 class="xref" 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 + </td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>Conceptual Overview</em></span> + </td><td style="border-bottom: 1px 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 class="xref" href="#ugr.ovv.conceptual" title="Chapter 2. UIMA Conceptual Overview">Chapter 2, <i>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 class="xref" href="#ugr.faqs" title="Chapter 4. UIMA Frequently Asked Questions (FAQ's)">Chapter 4, <i>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 class="xref" href="#ugr.issues" title="Chapter 5. Known Issues">Chapter 5, <i>Known Issues</i></a>.</td></tr><tr><td style="border-right: 0.5pt solid black; "><span class="emphasis"><em>Glossary</em></span> + See <a class="xref" href="#ugr.ovv.conceptual" title="Chapter 2. UIMA Conceptual Overview">Chapter 2, <i>UIMA Conceptual Overview</i></a></td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>UIMA FAQs</em></span> + </td><td style="border-bottom: 1px solid black; ">Frequently Asked Questions about general UIMA concepts. (Not a programming + resource.) See <a class="xref" href="#ugr.faqs" title="Chapter 4. UIMA Frequently Asked Questions (FAQ's)">Chapter 4, <i>UIMA FAQ's</i></a>.</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>Known Issues</em></span> + </td><td style="border-bottom: 1px solid black; ">Known issues and problems with the UIMA SDK. See <a class="xref" href="#ugr.issues" title="Chapter 5. Known Issues">Chapter 5, <i>Known Issues</i></a>.</td></tr><tr><td style="border-right: 1px solid black; "><span class="emphasis"><em>Glossary</em></span> </td><td style="">UIMA terms and concepts and their basic definitions. See <a class="xref" href="#ugr.glossary" title="Glossary: Key Terms & Concepts">Glossary</a>.</td></tr></tbody></table> </div> </div> - <div class="section" title="1.1.2. Eclipse Tooling Installation and Setup"><div class="titlepage"><div><div><h3 class="title" id="ugr.project_overview_setup">1.1.2. Eclipse Tooling Installation and Setup</h3></div></div></div> + <div class="section" id="ugr.project_overview_setup"><div class="titlepage"><div><div><h3 class="title">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 class="xref" href="#ugr.ovv.eclipse_setup" title="Chapter 3. Setting up the Eclipse IDE to work with UIMA">Chapter 3, <i>Setting up the Eclipse IDE to work with UIMA</i></a>.</p> + Development Environment. See <a class="xref" href="#ugr.ovv.eclipse_setup" title="Chapter 3. Setting up the Eclipse IDE to work with UIMA">Chapter 3, <i>Eclipse IDE setup for UIMA</i></a>.</p> </div> - <div class="section" title="1.1.3. Tutorials and Developer's Guides"><div class="titlepage"><div><div><h3 class="title" id="ugr.project_overview_tutorials_dev_guides">1.1.3. Tutorials and Developer's Guides</h3></div></div></div> + <div class="section" id="ugr.project_overview_tutorials_dev_guides"><div class="titlepage"><div><div><h3 class="title">1.1.3. Tutorials and Developer's Guides</h3></div></div></div> <div class="informaltable"> - <table 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 class="col1"><col class="col2"></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 + <table class="informaltable" style="border-collapse: collapse;border-top: 1px solid black; border-bottom: 1px solid black; border-left: 1px solid black; border-right: 1px solid black; "><colgroup><col class="col1"><col class="col2"></colgroup><tbody><tr id="ugr.project_overview_tutorial_annotator"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>Annotators and Analysis Engines</em></span> + </td><td style="border-bottom: 1px 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 href="tutorials_and_users_guides.html#ugr.tug.aae" class="olink">Chapter 1, <i>Annotator and Analysis Engine Developer's Guide</i></a>.</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 + <a href="tutorials_and_users_guides.html#ugr.tug.aae" class="olink">Chapter 1, <i>Annotator and Analysis Engine Developer's Guide</i></a>.</td></tr><tr id="ugr.project_overview_tutorial_cpe"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>Building UIMA Collection Processing Engines</em></span> + </td><td style="border-bottom: 1px 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 href="tutorials_and_users_guides.html#ugr.tug.cpe" class="olink">Chapter 2, <i>Collection Processing Engine Developer's Guide</i></a>.</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 + <a href="tutorials_and_users_guides.html#ugr.tug.cpe" class="olink">Chapter 2, <i>Collection Processing Engine Developer's Guide</i></a>.</td></tr><tr id="ugr.project_overview_tutorial_application_development"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>Developing Complete Applications</em></span> + </td><td style="border-bottom: 1px 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 href="tutorials_and_users_guides.html#ugr.tug.application" class="olink">Chapter 3, <i>Application Developer's Guide</i></a>.</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 + <a href="tutorials_and_users_guides.html#ugr.tug.application" class="olink">Chapter 3, <i>Application Developer's Guide</i></a>.</td></tr><tr id="ugr.project_overview_guide_flow_controller"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>Flow Controller</em></span> + </td><td style="border-bottom: 1px 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 href="tutorials_and_users_guides.html#ugr.tug.fc" class="olink">Chapter 4, <i>Flow Controller Developer's Guide</i></a>.</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 + implemented. See <a href="tutorials_and_users_guides.html#ugr.tug.fc" class="olink">Chapter 4, <i>Flow Controller Developer's Guide</i></a>.</td></tr><tr id="ugr.project_overview_guide_multiple_sofas"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>Developing Applications using Multiple Subjects of Analysis</em></span> + </td><td style="border-bottom: 1px 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 href="tutorials_and_users_guides.html#ugr.tug.aas" class="olink">Chapter 5, <i>Annotations, Artifacts, and Sofas</i></a>.</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 + <a href="tutorials_and_users_guides.html#ugr.tug.aas" class="olink">Chapter 5, <i>Annotations, Artifacts, and Sofas</i></a>.</td></tr><tr id="ugr.project_overview_guide_multiple_views"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>Multiple CAS Views of an Artifact</em></span> + </td><td style="border-bottom: 1px 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 href="tutorials_and_users_guides.html#ugr.tug.mvs" class="olink">Chapter 6, <i>Multiple CAS Views of an Artifact</i></a>.</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 + <a href="tutorials_and_users_guides.html#ugr.tug.mvs" class="olink">Chapter 6, <i>Multiple CAS Views of an Artifact</i></a>.</td></tr><tr id="ugr.project_overview_guide_cas_multiplier"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>CAS Multiplier</em></span> + </td><td style="border-bottom: 1px 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 href="tutorials_and_users_guides.html#ugr.tug.cm" class="olink">Chapter 7, <i>CAS Multiplier Developer's Guide</i></a>.</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> + CASes. See <a href="tutorials_and_users_guides.html#ugr.tug.cm" class="olink">Chapter 7, <i>CAS Multiplier Developer's Guide</i></a>.</td></tr><tr id="ugr.project_overview_xmi_emf"><td style="border-right: 1px solid black; "><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 @@ -182,70 +182,70 @@ </div> </div> - <div class="section" title="1.1.4. Tools Users' Guides"><div class="titlepage"><div><div><h3 class="title" id="ugr.project_overview_tool_guides">1.1.4. Tools Users' Guides</h3></div></div></div> + <div class="section" id="ugr.project_overview_tool_guides"><div class="titlepage"><div><div><h3 class="title">1.1.4. Tools Users' Guides</h3></div></div></div> <div class="informaltable"> - <table 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 class="col1"><col class="col2"></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>Component 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 + <table class="informaltable" style="border-collapse: collapse;border-top: 1px solid black; border-bottom: 1px solid black; border-left: 1px solid black; border-right: 1px solid black; "><colgroup><col class="col1"><col class="col2"></colgroup><tbody><tr id="ugr.project_overview_tools_component_descriptor_editor"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>Component Descriptor Editor</em></span> + </td><td style="border-bottom: 1px 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 href="tools.html#ugr.tools.cde" class="olink">Chapter 1, <i>Component Descriptor Editor User's Guide</i></a>.</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 + <a href="tools.html#ugr.tools.cde" class="olink">Chapter 1, <i>Component Descriptor Editor User's Guide</i></a>.</td></tr><tr id="ugr.project_overview_tools_cpe_configurator"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>Collection Processing Engine Configurator</em></span> + </td><td style="border-bottom: 1px 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 href="tools.html#ugr.tools.cpe" class="olink">Chapter 2, <i>Collection Processing Engine Configurator User's Guide</i></a>.</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 + <a href="tools.html#ugr.tools.cpe" class="olink">Chapter 2, <i>Collection Processing Engine Configurator User's Guide</i></a>.</td></tr><tr id="ugr.project_overview_tools_pear_packager"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>Pear Packager</em></span> + </td><td style="border-bottom: 1px 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 href="tools.html#ugr.tools.pear.packager" class="olink">Chapter 9, <i>PEAR Packager User's Guide</i></a>.</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 + <a href="tools.html#ugr.tools.pear.packager" class="olink">Chapter 9, <i>PEAR Packager User's Guide</i></a>.</td></tr><tr id="ugr.project_overview_tools_pear_installer"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>Pear Installer</em></span> + </td><td style="border-bottom: 1px 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 href="tools.html#ugr.tools.pear.installer" class="olink">Chapter 11, <i>PEAR Installer User's Guide</i></a>.</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 + <a href="tools.html#ugr.tools.pear.installer" class="olink">Chapter 11, <i>PEAR Installer User's Guide</i></a>.</td></tr><tr id="ugr.project_overview_tools_pear_merger"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>Pear Merger</em></span> + </td><td style="border-bottom: 1px solid black; ">Describes how to use the Pear Merger utility, which does a simple merge of multiple PEAR packages into one. See - <a href="tools.html#ugr.tools.pear.merger" class="olink">Chapter 12, <i>PEAR Merger User's Guide</i></a>.</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 + <a href="tools.html#ugr.tools.pear.merger" class="olink">Chapter 12, <i>PEAR Merger User's Guide</i></a>.</td></tr><tr id="ugr.project_overview_tools_document_analyzer"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>Document Analyzer</em></span> + </td><td style="border-bottom: 1px 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 href="tools.html#ugr.tools.doc_analyzer" class="olink">Chapter 3, <i>Document Analyzer User's Guide</i></a>.</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 + <a href="tools.html#ugr.tools.doc_analyzer" class="olink">Chapter 3, <i>Document Analyzer User's Guide</i></a>.</td></tr><tr id="ugr.project_overview_tools_cas_visual_debugger"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>CAS Visual Debugger</em></span> + </td><td style="border-bottom: 1px solid black; ">Describes the features of a tool for viewing the detailed structure and contents of a CAS. Good for debugging. See - <a href="tools.html#ugr.tools.cvd" class="olink">Chapter 5, <i>CAS Visual Debugger</i></a>.</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 + <a href="tools.html#ugr.tools.cvd" class="olink">Chapter 5, <i>CAS Visual Debugger</i></a>.</td></tr><tr id="ugr.project_overview_tools_jcasgen"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>JCasGen</em></span> + </td><td style="border-bottom: 1px solid black; ">Describes how to run the JCasGen utility, which automatically builds Java classes that correspond to a particular CAS Type System. See - <a href="tools.html#ugr.tools.jcasgen" class="olink">Chapter 8, <i>JCasGen User's Guide</i></a>.</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> + <a href="tools.html#ugr.tools.jcasgen" class="olink">Chapter 8, <i>JCasGen User's Guide</i></a>.</td></tr><tr id="ugr.project_overview_tools_xml_cas_viewer"><td style="border-right: 1px solid black; "><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 href="tools.html#ugr.tools.annotation_viewer" class="olink">Chapter 4, <i>Annotation Viewer</i></a>.</td></tr></tbody></table> </div> </div> - <div class="section" title="1.1.5. References"><div class="titlepage"><div><div><h3 class="title" id="ugr.project_overview_reference">1.1.5. References</h3></div></div></div> + <div class="section" id="ugr.project_overview_reference"><div class="titlepage"><div><div><h3 class="title">1.1.5. References</h3></div></div></div> <div class="informaltable"> - <table 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 class="col1"><col class="col2"></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 href="references.html#ugr.ref.javadocs" class="olink">Chapter 1, <i>Javadocs</i></a></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 + <table class="informaltable" style="border-collapse: collapse;border-top: 1px solid black; border-bottom: 1px solid black; border-left: 1px solid black; border-right: 1px solid black; "><colgroup><col class="col1"><col class="col2"></colgroup><tbody><tr id="ugr.project_overview_javadocs"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>Introduction to the UIMA API Javadocs</em></span> + </td><td style="border-bottom: 1px solid black; ">Javadocs detailing the UIMA programming interfaces See + <a href="references.html#ugr.ref.javadocs" class="olink">Chapter 1, <i>Javadocs</i></a></td></tr><tr id="ugr.project_overview_xml_ref_component_descriptor"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>XML: Component Descriptor</em></span> + </td><td style="border-bottom: 1px solid black; ">Provides detailed XML format for all the UIMA component descriptors, except the CPE (see next). See - <a href="references.html#ugr.ref.xml.component_descriptor" class="olink">Chapter 2, <i>Component Descriptor Reference</i></a>.</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 href="references.html#ugr.ref.xml.cpe_descriptor" class="olink">Chapter 3, <i>Collection Processing Engine Descriptor Reference</i></a></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 href="references.html#ugr.ref.cas" class="olink">Chapter 4, <i>CAS Reference</i></a></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 href="references.html#ugr.ref.jcas" class="olink">Chapter 5, <i>JCas Reference</i></a></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 + <a href="references.html#ugr.ref.xml.component_descriptor" class="olink">Chapter 2, <i>Component Descriptor Reference</i></a>.</td></tr><tr id="ugr.project_overview_xml_ref_collection_processing_engine_descriptor"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>XML: Collection Processing Engine Descriptor</em></span> + </td><td style="border-bottom: 1px solid black; ">Provides detailed XML format for the Collection Processing Engine descriptor. See + <a href="references.html#ugr.ref.xml.cpe_descriptor" class="olink">Chapter 3, <i>Collection Processing Engine Descriptor Reference</i></a></td></tr><tr id="ugr.project_overview_cas"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>CAS</em></span> + </td><td style="border-bottom: 1px solid black; ">Provides detailed description of the principal CAS interface. See + <a href="references.html#ugr.ref.cas" class="olink">Chapter 4, <i>CAS Reference</i></a></td></tr><tr id="ugr.project_overview_jcas"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>JCas</em></span> + </td><td style="border-bottom: 1px solid black; ">Provides details on the JCas, a native Java interface to the CAS. See + <a href="references.html#ugr.ref.jcas" class="olink">Chapter 5, <i>JCas Reference</i></a></td></tr><tr id="ugr.project_overview_ref_pear"><td style="border-right: 1px solid black; border-bottom: 1px solid black; "><span class="emphasis"><em>PEAR Reference</em></span> + </td><td style="border-bottom: 1px solid black; ">Provides detailed description of the deployable archive format for UIMA components. See - <a href="references.html#ugr.ref.pear" class="olink">Chapter 6, <i>PEAR Reference</i></a></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> + <a href="references.html#ugr.ref.pear" class="olink">Chapter 6, <i>PEAR Reference</i></a></td></tr><tr id="ugr.project_overview_xmi_cas_serialization"><td style="border-right: 1px solid black; "><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 href="references.html#ugr.ref.xmi" class="olink">Chapter 7, <i>XMI CAS Serialization Reference</i></a></td></tr></tbody></table> </div> </div> - <div class="section" title="1.1.6. Version 3 User's guide"><div class="titlepage"><div><div><h3 class="title" id="ugr.project_overview_v3">1.1.6. Version 3 User's guide</h3></div></div></div> + <div class="section" id="ugr.project_overview_v3"><div class="titlepage"><div><div><h3 class="title">1.1.6. Version 3 User's guide</h3></div></div></div> <p>This book describes Version 3's features, capabilities, and differences with version 2. </p> @@ -253,7 +253,7 @@ </div> - <div class="section" title="1.2. How to use the Documentation"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.project_overview_doc_use">1.2. How to use the Documentation</h2></div></div></div> + <div class="section" id="ugr.project_overview_doc_use"><div class="titlepage"><div><div><h2 class="title" style="clear: both">1.2. How to use the Documentation</h2></div></div></div> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> @@ -267,13 +267,13 @@ Journal special issue on Unstructured Information Management, on-line at <a class="ulink" 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 class="listitem"> - <p> Set up Apache UIMA in your Eclipse environment. To do this, follow the instructions in <a class="xref" href="#ugr.ovv.eclipse_setup" title="Chapter 3. Setting up the Eclipse IDE to work with UIMA">Chapter 3, <i>Setting up the Eclipse IDE to work with UIMA</i></a>. </p> + <p> Set up Apache UIMA in your Eclipse environment. To do this, follow the instructions in <a class="xref" href="#ugr.ovv.eclipse_setup" title="Chapter 3. Setting up the Eclipse IDE to work with UIMA">Chapter 3, <i>Eclipse IDE setup for UIMA</i></a>. </p> </li><li class="listitem"> <p> Develop sample UIMA annotators, run them and explore the results. Read <a href="tutorials_and_users_guides.html#d5e1" class="olink">UIMA Tutorial and Developers' Guides</a> <a href="tutorials_and_users_guides.html#ugr.tug.aae" class="olink">Chapter 1, <i>Annotator and Analysis Engine Developer's Guide</i></a> 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 class="itemizedlist" type="disc"><li class="listitem"> + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> <p> As part of this you will use a few tools including - </p><div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem"> + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem"> <p> The UIMA Component Descriptor Editor, described in more detail in <a href="tools.html#d5e1" class="olink">UIMA Tools Guide and Reference</a> <a href="tools.html#ugr.tools.cde" class="olink">Chapter 1, <i>Component Descriptor Editor User's Guide</i></a> and </p> </li><li class="listitem"> <p> The Document Analyzer, described in more detail in <a href="tools.html#d5e1" class="olink">UIMA Tools Guide and Reference</a> <a href="tools.html#ugr.tools.doc_analyzer" class="olink">Chapter 3, <i>Document Analyzer User's Guide</i></a>. </p> @@ -282,7 +282,7 @@ </li><li class="listitem"> <p>While following along in <a href="tutorials_and_users_guides.html#d5e1" class="olink">UIMA Tutorial and Developers' Guides</a> <a href="tutorials_and_users_guides.html#ugr.tug.aae" class="olink">Chapter 1, <i>Annotator and Analysis Engine Developer's Guide</i></a>, reference documents that may help are: - </p><div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem"> + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem"> <p> <a href="references.html#d5e1" class="olink">UIMA References</a> <a href="references.html#ugr.ref.xml.component_descriptor" class="olink">Chapter 2, <i>Component Descriptor Reference</i></a> for understanding the analysis engine descriptors </p> </li><li class="listitem"> @@ -296,7 +296,7 @@ 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 href="tutorials_and_users_guides.html#d5e1" class="olink">UIMA Tutorial and Developers' Guides</a> <a href="tutorials_and_users_guides.html#ugr.tug.application" class="olink">Chapter 3, <i>Application Developer's Guide</i></a> will guide you through this process. - </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> <p> As part of this you will use the document analyzer (described in more detail in <a href="tools.html#d5e1" class="olink">UIMA Tools Guide and Reference</a> <a href="tools.html#ugr.tools.doc_analyzer" class="olink">Chapter 3, <i>Document Analyzer User's Guide</i></a> and semantic search GUI tools (see <a href="tutorials_and_users_guides.html#d5e1" class="olink">UIMA Tutorial and Developers' Guides</a> <span class="olink">????</span>. </p> @@ -311,7 +311,7 @@ <p> Develop and run a Collection Processing Engine (CPE) to analyze and gather the results of an entire collection of documents. <a href="tutorials_and_users_guides.html#d5e1" class="olink">UIMA Tutorial and Developers' Guides</a> <a href="tutorials_and_users_guides.html#ugr.tug.cpe" class="olink">Chapter 2, <i>Collection Processing Engine Developer's Guide</i></a> will guide you through this process. - </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> <p> As part of this you will use the CPE Configurator tool. For details see <a href="tools.html#d5e1" class="olink">UIMA Tools Guide and Reference</a> <a href="tools.html#ugr.tools.cpe" class="olink">Chapter 2, <i>Collection Processing Engine Configurator User's Guide</i></a>. </p> </li><li class="listitem"> <p> You will also learn about CPE Descriptors. The detailed format for these may be found in <a href="references.html#d5e1" class="olink">UIMA References</a> <a href="references.html#ugr.ref.xml.cpe_descriptor" class="olink">Chapter 3, <i>Collection Processing Engine Descriptor Reference</i></a>. </p> @@ -325,12 +325,12 @@ </li></ol></div> </div> - <div class="section" title="1.3. Changes from UIMA Version 2"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.project_overview_changes_from_previous">1.3. Changes from UIMA Version 2</h2></div></div></div> + <div class="section" id="ugr.project_overview_changes_from_previous"><div class="titlepage"><div><div><h2 class="title" style="clear: both">1.3. Changes from UIMA Version 2</h2></div></div></div> <p>See the separate document Version 3 User's Guide.s</p> </div> - <div class="section" title="1.4. Migrating existing UIMA pipelines from Version 2 to Version 3"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.project_overview_migrating_from_v2_to_v3">1.4. Migrating existing UIMA pipelines from Version 2 to Version 3</h2></div></div></div> + <div class="section" id="ugr.project_overview_migrating_from_v2_to_v3"><div class="titlepage"><div><div><h2 class="title" style="clear: both">1.4. Migrating existing UIMA pipelines from Version 2 to Version 3</h2></div></div></div> <p>The format of JCas classes changed when going from version 2 to version 3. If you had JCas classes for user types, these need to be regenerated using the @@ -342,9 +342,9 @@ a description of the migration tool to aid in this process.</p> </div> - <div class="section" title="1.5. Apache UIMA Summary"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.project_overview_summary">1.5. Apache UIMA Summary</h2></div></div></div> + <div class="section" id="ugr.project_overview_summary"><div class="titlepage"><div><div><h2 class="title" style="clear: both">1.5. Apache UIMA Summary</h2></div></div></div> - <div class="section" title="1.5.1. General"><div class="titlepage"><div><div><h3 class="title" id="ugr.ovv.summary.general">1.5.1. General</h3></div></div></div> + <div class="section" id="ugr.ovv.summary.general"><div class="titlepage"><div><div><h3 class="title">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 @@ -354,7 +354,7 @@ tokenizers, summarizers, categorizers, parsers, named-entity detectors etc. Tutorial examples are provided with Apache UIMA; additional components are available from the community. </p> </div> - <div class="section" title="1.5.2. Programming Language Support"><div class="titlepage"><div><div><h3 class="title" id="ugr.ovv.summary.programming_language_support">1.5.2. Programming Language Support</h3></div></div></div> + <div class="section" id="ugr.ovv.summary.programming_language_support"><div class="titlepage"><div><div><h3 class="title">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> @@ -366,7 +366,7 @@ </p> </div> - <div class="section" title="1.5.3. Multi-Modal Support"><div class="titlepage"><div><div><h3 class="title" id="ugr.ovv.general.summary.multi_modal_support">1.5.3. Multi-Modal Support</h3></div></div></div> + <div class="section" id="ugr.ovv.general.summary.multi_modal_support"><div class="titlepage"><div><div><h3 class="title">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 href="tutorials_and_users_guides.html#d5e1" class="olink">UIMA Tutorial and Developers' Guides</a> <a href="tutorials_and_users_guides.html#ugr.tug.aas" class="olink">Chapter 5, <i>Annotations, Artifacts, and Sofas</i></a> discuss this is more @@ -374,10 +374,10 @@ </div> </div> - <div class="section" title="1.6. Summary of Apache UIMA Capabilities"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.project_overview_summary_sdk_capabilities">1.6. Summary of Apache UIMA Capabilities</h2></div></div></div> + <div class="section" id="ugr.project_overview_summary_sdk_capabilities"><div class="titlepage"><div><div><h2 class="title" style="clear: both">1.6. Summary of Apache UIMA Capabilities</h2></div></div></div> <div class="informaltable"> - <table 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 class="col1"><col class="col2"></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; "> + <table class="informaltable" style="border-collapse: collapse;border-top: 1px solid black; border-bottom: 1px solid black; border-left: 1px solid black; border-right: 1px solid black; "><colgroup><col class="col1"><col class="col2"></colgroup><tbody><tr><td class="tableSubhead" style="border-right: 1px solid black; border-bottom: 1px solid black; ">Module</td><td class="tableSubhead" style="border-bottom: 1px solid black; ">Description</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">UIMA Framework Core</td><td style="border-bottom: 1px 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> @@ -385,46 +385,46 @@ <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; "> + </td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">C++ and other programming language Interoperability</td><td style="border-bottom: 1px 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 + </td></tr><tr><td class="tableSubhead" style="border-right: 1px solid black; border-bottom: 1px solid black; ">Framework Services and APIs</td><td class="tableSubhead" style="border-bottom: 1px 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), + framework.</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">CAS</td><td style="border-bottom: 1px 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 + the same artifacts (e.g. documents), supporting multi-lingual and multi-modal analysis.</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">JCas</td><td style="border-bottom: 1px 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 + JavaBeans conventions of getters and setters.</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Collection Processing Management (CPM)</td><td style="border-bottom: 1px 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 + check-pointing, performance monitoring and recoverability.</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Resource Manager</td><td style="border-bottom: 1px 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: 1px solid black; border-bottom: 1px solid black; ">Configuration Manager</td><td style="border-bottom: 1px solid black; ">Provides UIMA components with run-time access to their configuration parameter settings. + </td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Logger</td><td style="border-bottom: 1px solid black; ">Provides access to a common logging facility.</td></tr><tr><td class="tableSubhead" style="border-bottom: 1px solid black; " colspan="2" align="center"> Tools and Utilities + </td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">JCasGen</td><td style="border-bottom: 1px 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: 1px solid black; border-bottom: 1px solid black; ">Saving and Restoring CAS contents</td><td style="border-bottom: 1px solid black; ">APIs in the core framework support saving and restoring the contents of a CAS to streams in multiple formats, including XMI, binary, and compressed forms. - These apis are collected into the CasIOUtils class.</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 + These apis are collected into the CasIOUtils class.</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">PEAR Packager for Eclipse</td><td style="border-bottom: 1px solid black; ">Tool for building a UIMA component archive to facilitate porting, registering, installing and + testing components.</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">PEAR Installer</td><td style="border-bottom: 1px solid black; ">Tool for installing and verifying a UIMA component archive in a UIMA installation.</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">PEAR Merger</td><td style="border-bottom: 1px solid black; ">Utility that combines multiple PEARs into one.</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Component Descriptor Editor</td><td style="border-bottom: 1px 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 style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">CAS Editor</td><td style="border-bottom: 0.5pt solid black; ">Eclipse plug-in that lets you edit the contents of a CAS</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">UIMA Pipeline Eclipse Launcher</td><td style="border-bottom: 0.5pt solid black; ">Eclipse plug-in that lets you configure Eclipse launchers for UIMA pipelines</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, + Consumers.</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">CPE Configurator</td><td style="border-bottom: 1px solid black; ">Graphical tool for configuring Collection Processing Engines and applying them to + collections of documents.</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Java Annotation Viewer</td><td style="border-bottom: 1px solid black; ">Viewer for exploring annotations and related CAS data.</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">CAS Visual Debugger</td><td style="border-bottom: 1px 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: 1px solid black; border-bottom: 1px solid black; ">Document Analyzer</td><td style="border-bottom: 1px solid black; ">GUI Java application that applies analysis engines to sets of documents and shows results in a + viewer.</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">CAS Editor</td><td style="border-bottom: 1px solid black; ">Eclipse plug-in that lets you edit the contents of a CAS</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">UIMA Pipeline Eclipse Launcher</td><td style="border-bottom: 1px solid black; ">Eclipse plug-in that lets you configure Eclipse launchers for UIMA pipelines</td></tr><tr><td class="tableSubhead" style="border-bottom: 1px solid black; " colspan="2" align="center"> Example Analysis + Components </td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Database Writer</td><td style="border-bottom: 1px 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: 1px solid black; border-bottom: 1px solid black; ">Annotators</td><td style="border-bottom: 1px solid black; "> Set of simple annotators meant for pedagogical purposes. Includes: Date/time, Room-number, Regular expression, Tokenizer, and Meeting-finder annotator. 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; ">File System Collection Reader</td><td style=""> Simple Collection Reader for pulling documents from the file system and initializing CASes. + as well. </td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Flow Controllers</td><td style="border-bottom: 1px 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: 1px solid black; border-bottom: 1px solid black; ">XMI Collection Reader, CAS Consumer</td><td style="border-bottom: 1px solid black; ">Reads and writes the CAS in the XMI format</td></tr><tr><td style="border-right: 1px solid black; ">File System Collection Reader</td><td style=""> Simple Collection Reader for pulling documents from the file system and initializing CASes. </td></tr></tbody></table> </div> </div> </div> - <div class="chapter" title="Chapter 2. UIMA Conceptual Overview" id="ugr.ovv.conceptual"><div class="titlepage"><div><div><h2 class="title">Chapter 2. UIMA Conceptual Overview</h2></div></div></div> + <div class="chapter" id="ugr.ovv.conceptual"><div class="titlepage"><div><div><h1 class="title">Chapter 2. UIMA Conceptual Overview</h1></div></div></div> <p>UIMA is an open, industrial-strength, scaleable and extensible platform for @@ -446,11 +446,11 @@ treatments of key concepts and development practices. It may be useful to refer to <a href="overview_and_setup.html#ugr.glossary" class="olink">Glossary</a>, to become familiar with the terminology in this overview.</p> - <div class="section" title="2.1. UIMA Introduction"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.ovv.conceptual.uima_introduction">2.1. UIMA Introduction</h2></div></div></div> + <div class="section" id="ugr.ovv.conceptual.uima_introduction"><div class="titlepage"><div><div><h2 class="title" style="clear: both">2.1. UIMA Introduction</h2></div></div></div> - <div class="figure"><a name="ugr.ovv.conceptual.fig.bridge"></a><div class="figure-contents"> + <div class="figure" id="ugr.ovv.conceptual.fig.bridge"><div class="figure-contents"> - <div class="mediaobject"><table border="0" summary="manufactured viewport for HTML img" cellspacing="0" cellpadding="0" width="545"><tr><td><img src="images/overview-and-setup/conceptual_overview_files/image002.png" width="545" alt="Picture of a bridge between unstructured information artifacts and structured metadata about those artifacts"></td></tr></table></div> + <div class="mediaobject"><table border="0" summary="manufactured viewport for HTML img" style="cellpadding: 0; cellspacing: 0;" width="545"><tr><td><img src="images/overview-and-setup/conceptual_overview_files/image002.png" width="545" alt="Picture of a bridge between unstructured information artifacts and structured metadata about those artifacts"></td></tr></table></div> </div><p class="title"><b>Figure 2.1. UIMA helps you build the bridge between the unstructured and structured worlds</b></p></div><br class="figure-break"> @@ -493,7 +493,7 @@ <p>In analyzing unstructured content, UIM applications make use of a variety of analysis technologies including:</p> - <div class="itemizedlist"><ul class="itemizedlist" type="disc" compact><li class="listitem"><p>Statistical and rule-based Natural Language Processing + <div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc; "><li class="listitem"><p>Statistical and rule-based Natural Language Processing (NLP)</p> </li><li class="listitem"><p>Information Retrieval (IR)</p> </li><li class="listitem"><p>Machine learning</p> @@ -524,7 +524,7 @@ </div> - <div class="section" title="2.2. The Architecture, the Framework and the SDK"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.ovv.conceptual.architecture_framework_sdk">2.2. The Architecture, the Framework and the SDK</h2></div></div></div> + <div class="section" id="ugr.ovv.conceptual.architecture_framework_sdk"><div class="titlepage"><div><div><h2 class="title" style="clear: both">2.2. The Architecture, the Framework and the SDK</h2></div></div></div> <p>UIMA is a software architecture which specifies component interfaces, data representations, design patterns and development roles for creating, describing, @@ -543,18 +543,18 @@ </div> - <div class="section" title="2.3. Analysis Basics"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.ovv.conceptual.analysis_basics">2.3. Analysis Basics</h2></div></div></div> + <div class="section" id="ugr.ovv.conceptual.analysis_basics"><div class="titlepage"><div><div><h2 class="title" style="clear: both">2.3. Analysis Basics</h2></div></div></div> - <div class="note" title="Key UIMA Concepts Introduced in this Section:" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Key UIMA Concepts Introduced in this Section:</h3><p>Analysis Engine, Document, Annotator, Annotator + <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Key UIMA Concepts Introduced in this Section:</h3><p>Analysis Engine, Document, Annotator, Annotator Developer, Type, Type System, Feature, Annotation, CAS, Sofa, JCas, UIMA Context.</p> </div> - <div class="section" title="2.3.1. Analysis Engines, Annotators & Results"><div class="titlepage"><div><div><h3 class="title" id="ugr.ovv.conceptual.aes_annotators_and_analysis_results">2.3.1. Analysis Engines, Annotators & Results</h3></div></div></div> + <div class="section" id="ugr.ovv.conceptual.aes_annotators_and_analysis_results"><div class="titlepage"><div><div><h3 class="title">2.3.1. Analysis Engines, Annotators & Results</h3></div></div></div> - <div class="figure"><a name="ugr.ovv.conceptual.metadata_in_cas"></a><div class="figure-contents"> + <div class="figure" id="ugr.ovv.conceptual.metadata_in_cas"><div class="figure-contents"> - <div class="mediaobject" align="center"><table border="0" summary="manufactured viewport for HTML img" cellspacing="0" cellpadding="0" width="594"><tr><td align="center"><img src="images/overview-and-setup/conceptual_overview_files/image004.png" align="middle" width="594" alt="Picture of some text, with a hierarchy of discovered metadata about words in the text, including some image of a person as metadata about that name."></td></tr></table></div> + <div class="mediaobject" align="center"><table border="0" summary="manufactured viewport for HTML img" style="cellpadding: 0; cellspacing: 0;" width="594"><tr><td align="center"><img src="images/overview-and-setup/conceptual_overview_files/image004.png" align="middle" width="594" alt="Picture of some text, with a hierarchy of discovered metadata about words in the text, including some image of a person as metadata about that name."></td></tr></table></div> </div><p class="title"><b>Figure 2.2. Objects represented in the Common Analysis Structure (CAS)</b></p></div><br class="figure-break"> <p>UIMA is an architecture in which basic building blocks called Analysis Engines @@ -630,7 +630,7 @@ AEs. </p> </div> - <div class="section" title="2.3.2. Representing Analysis Results in the CAS"><div class="titlepage"><div><div><h3 class="title" id="ugr.ovv.conceptual.representing_results_in_cas">2.3.2. Representing Analysis Results in the CAS</h3></div></div></div> + <div class="section" id="ugr.ovv.conceptual.representing_results_in_cas"><div class="titlepage"><div><div><h3 class="title">2.3.2. Representing Analysis Results in the CAS</h3></div></div></div> <p>How annotators represent and share their results is an important part of the UIMA @@ -641,7 +641,7 @@ objects, properties and values. Object types may be related to each other in a single-inheritance hierarchy. The CAS logically (if not physically) contains the
[... 861 lines stripped ...]
