Modified: uima/site/trunk/uima-website/docs/d/uimaj-current/issuesFixed/jira-report.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimaj-current/issuesFixed/jira-report.html?rev=1904950&r1=1904949&r2=1904950&view=diff ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimaj-current/issuesFixed/jira-report.html (original) +++ uima/site/trunk/uima-website/docs/d/uimaj-current/issuesFixed/jira-report.html Mon Oct 31 13:15:29 2022 @@ -1,5 +1,5 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2022-04-29 --> +<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2022-10-19 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> @@ -10,7 +10,7 @@ @import url("./css/site.css"); </style> <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> - <meta name="Date-Revision-yyyymmdd" content="20220429" /> + <meta name="Date-Revision-yyyymmdd" content="20221019" /> <meta http-equiv="Content-Language" content="en" /> </head> @@ -24,7 +24,7 @@ <div class="xleft"> - <span id="publishDate">Last Published: 2022-04-29</span> + <span id="publishDate">Last Published: 2022-10-19</span> | <span id="projectVersion">Version: ${project.version}</span> </div> <div class="xright"> @@ -57,174 +57,39 @@ <th>Summary</th></tr> <tr class="b"> <td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6366";>UIMA-6366</a></td> +<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6453";>UIMA-6453</a></td> <td>Resolved</td> -<td>Spelling error in documentation </td></tr> +<td>Invalid SHA512 generated for Maven artifacts</td></tr> <tr class="a"> <td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6367";>UIMA-6367</a></td> +<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6473";>UIMA-6473</a></td> <td>Resolved</td> -<td>JCas cover annotation created in PEAR context replaced during index operations</td></tr> +<td>CasToComparableText is broken</td></tr> <tr class="b"> <td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6377";>UIMA-6377</a></td> +<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6479";>UIMA-6479</a></td> <td>Resolved</td> -<td>Spurious multipleReferencesAllowed warning when serializing empty arrays</td></tr> -<tr class="a"> -<td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6378";>UIMA-6378</a></td> -<td>Resolved</td> -<td>Java SDK does not build on Java 16</td></tr> -<tr class="b"> -<td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6386";>UIMA-6386</a></td> -<td>Resolved</td> -<td>Wrong session set on ConfigurationManager in aggregates</td></tr> -<tr class="a"> -<td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6387";>UIMA-6387</a></td> -<td>Resolved</td> -<td>Update p2 repo URLs from http to https</td></tr> -<tr class="b"> -<td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6388";>UIMA-6388</a></td> -<td>Resolved</td> -<td>CAS.select(null) returns all annotations</td></tr> -<tr class="a"> -<td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6389";>UIMA-6389</a></td> -<td>Resolved</td> -<td>Logger_common_impl swallows exception</td></tr> -<tr class="b"> -<td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6390";>UIMA-6390</a></td> -<td>Resolved</td> -<td>NPE when trying to access config names of fresh context</td></tr> -<tr class="a"> -<td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6393";>UIMA-6393</a></td> -<td>Resolved</td> -<td>Circular imports break resource manager cache</td></tr> -<tr class="b"> -<td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6398";>UIMA-6398</a></td> -<td>Resolved</td> -<td>Classloader paradoxon and memory leak in UIMA loggers</td></tr> -<tr class="a"> -<td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6400";>UIMA-6400</a></td> -<td>Resolved</td> -<td>UimaContextHolder threadlocal can leak</td></tr> -<tr class="b"> -<td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6401";>UIMA-6401</a></td> -<td>Resolved</td> -<td>CPE ThreadGroupDestroyer keeps unnecessary reference on CPMEngine</td></tr> -<tr class="a"> -<td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6402";>UIMA-6402</a></td> -<td>Resolved</td> -<td>Flipping test? IntArrayRBTTest.testLargeInsertsDeletes</td></tr> -<tr class="b"> -<td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6413";>UIMA-6413</a></td> -<td>Resolved</td> -<td>Memory leak in FSClassRegistry</td></tr> -<tr class="a"> -<td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6421";>UIMA-6421</a></td> -<td>Resolved</td> -<td>Can inject String value into StringArray slot</td></tr> -<tr class="b"> -<td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6423";>UIMA-6423</a></td> -<td>Resolved</td> -<td>Selecting a non-existing type returns all types</td></tr> -<tr class="a"> -<td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6434";>UIMA-6434</a></td> -<td>Resolved</td> -<td>Some launch configs do not work</td></tr> -<tr class="b"> -<td>Bug</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6435";>UIMA-6435</a></td> -<td>Resolved</td> -<td>Vinci example descriptors do not work</td></tr> -<tr class="a"> -<td>Improvement</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6265";>UIMA-6265</a></td> -<td>Resolved</td> -<td>Drop SOAP support from UIMAv3</td></tr> -<tr class="b"> -<td>Improvement</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6321";>UIMA-6321</a></td> -<td>Resolved</td> -<td>Upgrade to xmlunit 2 (UIMA Java SDK)</td></tr> +<td>PearPackagingMavenPlugin has ancient JUnit dependency</td></tr> <tr class="a"> <td>Improvement</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6354";>UIMA-6354</a></td> +<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6454";>UIMA-6454</a></td> <td>Resolved</td> -<td>Limit permitted JDK to minimal JDK for release builds</td></tr> +<td>Update dependencies (UIMA Java SDK 3.3.1)</td></tr> <tr class="b"> <td>Improvement</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6372";>UIMA-6372</a></td> +<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6463";>UIMA-6463</a></td> <td>Resolved</td> -<td>Upgrade from JUnit 3 to JUnit 4 to JUnit 5</td></tr> +<td>Use toolchains to ensure compatibility with Java 1.8</td></tr> <tr class="a"> <td>Improvement</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6373";>UIMA-6373</a></td> +<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6469";>UIMA-6469</a></td> <td>Resolved</td> -<td>Format UIMA Core Java SDK codebase</td></tr> +<td>Cleaning up file-handling code</td></tr> <tr class="b"> <td>Improvement</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6397";>UIMA-6397</a></td> -<td>Resolved</td> -<td>Remove unnecessary code from Class_TCCL.java</td></tr> -<tr class="a"> -<td>Improvement</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6403";>UIMA-6403</a></td> -<td>Resolved</td> -<td>Update dependencies</td></tr> -<tr class="b"> -<td>Improvement</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6412";>UIMA-6412</a></td> -<td>Resolved</td> -<td>Stop using ThreadGroup in CPMEngine</td></tr> -<tr class="a"> -<td>Improvement</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6415";>UIMA-6415</a></td> -<td>Resolved</td> -<td>Deprecate unused IntArrayRBT and CompIntArrayRBT</td></tr> -<tr class="b"> -<td>Improvement</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6416";>UIMA-6416</a></td> -<td>Resolved</td> -<td>Update dependencies</td></tr> -<tr class="a"> -<td>Improvement</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6420";>UIMA-6420</a></td> -<td>Resolved</td> -<td>Remove unnecessary scm tags from pom</td></tr> -<tr class="b"> -<td>Improvement</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6430";>UIMA-6430</a></td> -<td>Resolved</td> -<td>PearPackagingMavenPlugin uses commons-io jar with CVE</td></tr> -<tr class="a"> -<td>New Feature</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6358";>UIMA-6358</a></td> -<td>Resolved</td> -<td>ResourceManager_impl should provide a more robust way to register multiple datapaths</td></tr> -<tr class="b"> -<td>New Feature</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6418";>UIMA-6418</a></td> -<td>Resolved</td> -<td>Support additional parameters value types</td></tr> -<tr class="a"> -<td>New Feature</td> -<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6431";>UIMA-6431</a></td> +<td><a class="externalLink" href="https://issues.apache.org/jira/browse/UIMA-6480";>UIMA-6480</a></td> <td>Resolved</td> -<td>Use lambda functions as CAS processors</td></tr></table></div> +<td>Add tests with empty arrays to CAS de/ser-suite</td></tr></table></div> </div> </div> <div class="clear">
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=1904950&r1=1904949&r2=1904950&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 Mon Oct 31 13:15:29 2022 @@ -2,7 +2,7 @@ <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"> <h3 class="corpauthor">Written and maintained by the Apache UIMA™ Development Community</h3> - </div></div><div><p class="releaseinfo">Version 3.3.0</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.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> <p> </p> <p title="License and Disclaimer"> <b>License and Disclaimer. </b> @@ -35,7 +35,7 @@ the trademark or service mark. </p> - </div></div><div><p class="pubdate">April, 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_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 Exte rnal 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 cla ss="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 class= "glossary"><a href="#ugr.glossary">Glossary</a></span></dt></dl></div> + </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> Modified: uima/site/trunk/uima-website/docs/d/uimaj-current/overview_and_setup.pdf URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimaj-current/overview_and_setup.pdf?rev=1904950&r1=1904949&r2=1904950&view=diff ============================================================================== Binary files - no diff available. Modified: uima/site/trunk/uima-website/docs/d/uimaj-current/references.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimaj-current/references.html?rev=1904950&r1=1904949&r2=1904950&view=diff ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimaj-current/references.html (original) +++ uima/site/trunk/uima-website/docs/d/uimaj-current/references.html Mon Oct 31 13:15:29 2022 @@ -2,7 +2,7 @@ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>UIMA References</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 References" id="d5e1"><div xmlns:d="http://docbook.org/ns/docbook"; class="titlepage"><div><div><h1 class="title">UIMA References</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.0</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.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> <p> </p> <p title="License and Disclaimer"> <b>License and Disclaimer. </b> @@ -35,7 +35,7 @@ the trademark or service mark. </p> - </div></div><div><p class="pubdate">April, 2022</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#ugr.ref.javadocs">1. Javadocs</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.javadocs.libraries">1.1. Using named Eclipse User Libraries</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.ref.xml.component_descriptor">2. Component Descriptor Reference</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.notation">2.1. Notation</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.imports">2.2. Imports</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.type_system">2.3. Type System Descriptors</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.type_system.imports">2.3.1. Imports</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.compone nt_descriptor.type_system.types">2.3.2. Types</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.type_system.features">2.3.3. Features</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.type_system.string_subtypes">2.3.4. String Subtypes</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.aes">2.4. Analysis Engine Descriptors</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.aes.primitive">2.4.1. Primitive Analysis Engine Descriptors</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.aes.aggregate">2.4.2. Aggregate Analysis Engine Descriptors</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.aes.configuration_parameters">2.4.3. Configuration Parameters</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.flow_controller">2.5. Flo w Controller Descriptors</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.collection_processing_parts">2.6. Collection Processing Component Descriptors</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.collection_processing_parts.collection_reader">2.6.1. Collection Reader Descriptors</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.collection_processing_parts.cas_initializer">2.6.2. CAS Initializer Descriptors (deprecated)</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.collection_processing_parts.cas_consumer">2.6.3. CAS Consumer Descriptors</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.service_client">2.7. Service Client Descriptors</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.custom_resource_specifiers">2.8. Custom Resource Specifiers</a></span></d t></dl></dd><dt><span class="chapter"><a href="#ugr.ref.xml.cpe_descriptor">3. CPE Descriptor Reference</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.overview">3.1. CPE Overview</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.notation">3.2. Notation</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.imports">3.3. Imports</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.descriptor">3.4. CPE Descriptor Overview</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.descriptor.collection_reader">3.5. Collection Reader</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.descriptor.collection_reader.error_handling">3.5.1. Error handling for Collection Readers</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.descriptor.cas_processors">3.6. CAS Processors</a></span></dt>< dd><dl><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.descriptor.cas_processors.individual">3.6.1. Specifying an Individual CAS Processor</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.descriptor.operational_parameters">3.7. CPE Operational Parameters</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.descriptor.resource_manager_configuration">3.8. Resource Manager Configuration</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.descriptor.example">3.9. Example CPE Descriptor</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.ref.cas">4. CAS Reference</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.cas.javadocs">4.1. Javadocs</a></span></dt><dt><span class="section"><a href="#ugr.ref.cas.overview">4.2. CAS Overview</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.cas.type_system">4.2.1. The Type System</a></span></dt><dt><s pan class="section"><a href="#ugr.ref.cas.creating_accessing_manipulating_data">4.2.2. Creating/Accessing/Changing data</a></span></dt><dt><span class="section"><a href="#ugr.ref.cas.creating_using_indexes">4.2.3. Creating and using indexes</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.cas.builtin_types">4.3. Built-in CAS Types</a></span></dt><dt><span class="section"><a href="#ugr.ref.cas.accessing_the_type_system">4.4. Accessing the type system</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.cas.type_system.printer_example">4.4.1. TypeSystemPrinter example</a></span></dt><dt><span class="section"><a href="#ugr.ref.cas.cas_apis_create_modify_feature_structures">4.4.2. Using CAS APIs: Feature Structures</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.cas.creating_feature_structures">4.5. Creating feature structures</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.cas.updating_indexed_feature_structures" >4.5.1. Updating indexed feature structures</a></span></dt></dl></dd><dt><span >class="section"><a >href="#ugr.ref.cas.accessing_modifying_features_of_feature_structures">4.6. >Accessing or modifying Features</a></span></dt><dt><span class="section"><a >href="#ugr.ref.cas.indexes_and_iterators">4.7. Indexes and >Iterators</a></span></dt><dd><dl><dt><span class="section"><a >href="#ugr.ref.cas.index.built_in_indexes">4.7.1. Built-in >Indexes</a></span></dt><dt><span class="section"><a >href="#ugr.ref.cas.index.adding_to_indexes">4.7.2. Adding Feature Structures >to the Indexes</a></span></dt><dt><span class="section"><a >href="#ugr.ref.cas.index.iterators">4.7.3. Iterators over UIMA >Indexes</a></span></dt><dt><span class="section"><a >href="#ugr.ref.cas.index.annotation_index">4.7.4. Special iterators for >Annotation types</a></span></dt><dt><span class="section"><a >href="#ugr.ref.cas.index.constraints_and_filtered_iterators">4.7.5. >Constraints and Filtered iterators</a></span></dt></dl></dd><dt ><span class="section"><a href="#ugr.ref.cas.guide_to_javadocs">4.8. CAS API's >Javadocs</a></span></dt><dd><dl><dt><span class="section"><a >href="#ugr.ref.cas.javadocs.cas_package">4.8.1. APIs in the CAS >package</a></span></dt></dl></dd><dt><span class="section"><a >href="#ugr.ref.cas.typemerging">4.9. Type Merging</a></span></dt><dt><span >class="section"><a href="#ugr.ref.cas.limitedmultipleaccess">4.10. Limited >multi-thread access to read-only CASs</a></span></dt></dl></dd><dt><span >class="chapter"><a href="#ugr.ref.jcas">5. JCas >Reference</a></span></dt><dd><dl><dt><span class="section"><a >href="#ugr.ref.jcas.name_spaces">5.1. Name Spaces</a></span></dt><dt><span >class="section"><a href="#ugr.ref.jcas.use_of_description">5.2. Use of XML >Description</a></span></dt><dt><span class="section"><a >href="#ugr.ref.jcas.mapping_built_ins">5.3. Mapping built-in CAS types to >Java types</a></span></dt><dt><span class="section"><a >href="#ugr.ref.jcas.augmenting_generated_code">5.4. Augmenting the generated Java Code</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.jcas.keeping_augmentations_when_regenerating">5.4.1. Keeping hand-coded augmentations when regenerating</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.additional_constructors">5.4.2. Additional Constructors</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.modifying_generated_items">5.4.3. Modifying generated items</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.jcas.merging_types_from_other_specs">5.5. Merging Types</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.jcas.merging_types.aggregates_and_cpes">5.5.1. Aggregate AEs and CPEs as sources of types</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.merging_types.jcasgen_support">5.5.2. JCasGen support for type merging</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.impact_of_type_merging_on_composability">5.5.3. Type Merging impacts on Compo sability</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.documentannotation_issues">5.5.4. Adding Features to DocumentAnnotation</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.jcas.using_within_an_annotator">5.6. Using JCas within an Annotator</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.jcas.new_instances">5.6.1. Creating new instances</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.getters_and_setters">5.6.2. Getters and Setters</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.obtaining_refs_to_indexes">5.6.3. Obtaining references to Indexes</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.adding_removing_instances_to_indexes">5.6.4. Updating Indexes</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.using_iterators">5.6.5. Using Iterators</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.class_loaders">5.6.6. Class Loaders in UIMA</a></span></dt><dt ><span class="section"><a >href="#ugr.ref.jcas.accessing_jcas_objects_outside_uima_components">5.6.7. >Issues accessing JCas objects outside of UIMA Engine >Components</a></span></dt></dl></dd><dt><span class="section"><a >href="#ugr.ref.jcas.setting_up_classpath">5.7. Setting up Classpath for >JCas</a></span></dt><dt><span class="section"><a >href="#ugr.ref.jcas.pear_support">5.8. PEAR >isolation</a></span></dt></dl></dd><dt><span class="chapter"><a >href="#ugr.ref.pear">6. PEAR Reference</a></span></dt><dd><dl><dt><span >class="section"><a href="#ugr.ref.pear.packaging_a_component">6.1. Packaging >a UIMA component</a></span></dt><dd><dl><dt><span class="section"><a >href="#ugr.ref.pear.creating_pear_structure">6.1.1. Creating the PEAR >structure</a></span></dt><dt><span class="section"><a >href="#ugr.ref.pear.populating_pear_structure">6.1.2. Populating the PEAR >structure</a></span></dt><dt><span class="section"><a >href="#ugr.ref.pear.creating_installation_descriptor">6.1.3. Creating the >insta llation descriptor</a></span></dt><dt><span class="section"><a href="#ugr.ref.pear.installation_descriptor">6.1.4. Installation Descriptor: template</a></span></dt><dt><span class="section"><a href="#ugr.ref.pear.packaging_into_1_file">6.1.5. Packaging the PEAR structure into one file</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.pear.installing">6.2. Installing a PEAR package</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.pear.installing_pear_using_API">6.2.1. Installing a PEAR file using the PEAR APIs</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.pear.specifier">6.3. PEAR package descriptor</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.ref.xmi">7. XMI CAS Serialization Reference</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.xmi.xmi_tag">7.1. XMI Tag</a></span></dt><dt><span class="section"><a href="#ugr.ref.xmi.feature_structures">7.2. Feature Structures</a></span></dt><dt><sp an class="section"><a href="#ugr.ref.xmi.primitive_features">7.3. Primitive Features</a></span></dt><dt><span class="section"><a href="#ugr.ref.xmi.reference_features">7.4. Reference Features</a></span></dt><dt><span class="section"><a href="#ugr.ref.xmi.array_and_list_features">7.5. Array and List Features</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.xmi.array_and_list_features.as_multi_valued_properties">7.5.1. Arrays and Lists as Multi-Valued Properties</a></span></dt><dt><span class="section"><a href="#ugr.ref.xmi.array_and_list_features.as_1st_class_objects">7.5.2. Arrays and Lists as First-Class Objects</a></span></dt><dt><span class="section"><a href="#ugr.ref.xmi.null_array_list_elements">7.5.3. Null Array/List Elements</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.xmi.sofas_views">7.6. Subjects of Analysis (Sofas) and Views</a></span></dt><dt><span class="section"><a href="#ugr.ref.xmi.linking_to_ecore_type_system">7.7. Linking X MI docs to Ecore Type System</a></span></dt><dt><span class="section"><a href="#ugr.ref.xmi.delta">7.8. Delta CAS XMI Format</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.ref.compress">8. Compressed Binary CASes</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.compress.overview">8.1. Binary CAS Compression overview</a></span></dt><dt><span class="section"><a href="#ugr.ref.compress.usage">8.2. Using Compressed Binary CASes</a></span></dt><dt><span class="section"><a href="#ugr.ref.compress.simple-deltas">8.3. Simple Delta CAS serialization</a></span></dt><dt><span class="section"><a href="#ugr.ref.compress.use-cases">8.4. Use Case cookbook</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.ref.json">9. JSON support</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.json.overview">9.1. JSON serialization support overview</a></span></dt><dt><span class="section"><a href="#ug.ref.json.cas">9.2. JSON CAS Serialization</a ></span></dt><dd><dl><dt><span class="section"><a >href="#ug.ref.json.cas.bigpic">9.2.1. The Big >Picture</a></span></dt><dt><span class="section"><a >href="#ug.ref.json.cas.context">9.2.2. The _context >section</a></span></dt><dt><span class="section"><a >href="#ug.ref.json.cas.featurestructures">9.2.3. Serializing Feature >Structures</a></span></dt></dl></dd><dt><span class="section"><a >href="#ug.ref.json.cas.featurestructures.organization">9.3. Organizing the >Feature Structures</a></span></dt><dt><span class="section"><a >href="#ug.ref.json.cas.features">9.4. Additional JSON CAS Serialization >features</a></span></dt><dd><dl><dt><span class="section"><a >href="#ugr.ref.json.delta">9.4.1. Delta >CAS</a></span></dt></dl></dd><dt><span class="section"><a >href="#ugr.ref.json.usage">9.5. Using JSON CAS >serialization</a></span></dt><dt><span class="section"><a >href="#ugr.ref.json.descriptionserialization">9.6. JSON serialization for >UIMA descriptors</a></span></dt></dl></dd><dt><span class="chap ter"><a href="#ugr.ref.config">10. Setup and Configuration</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.config.properties">10.1. UIMA JVM Configuration Properties</a></span></dt><dt><span class="section"><a href="#ugr.ref.config.protect-index">10.2. Configuring index protection</a></span></dt><dt><span class="section"><a href="#ugr.ref.config.property-table">10.3. Properties Table</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.ref.resources">11. UIMA Resources</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.resources.overview">11.1. What is a UIMA Resource?</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.resources.resource-inner-implementations">11.1.1. Resource Inner Implementations</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.resources.sharing-across-pipelines">11.2. Sharing Resources</a></span></dt><dt><span class="section"><a href="#ugr.ref.resources.external-resource-multiple-p arameterized-instances">11.3. External Resources support for multiple Parameterized Instances</a></span></dt></dl></dd></dl></div> + </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.ref.javadocs">1. Javadocs</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.javadocs.libraries">1.1. Using named Eclipse User Libraries</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.ref.xml.component_descriptor">2. Component Descriptor Reference</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.notation">2.1. Notation</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.imports">2.2. Imports</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.type_system">2.3. Type System Descriptors</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.type_system.imports">2.3.1. Imports</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.compo nent_descriptor.type_system.types">2.3.2. Types</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.type_system.features">2.3.3. Features</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.type_system.string_subtypes">2.3.4. String Subtypes</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.aes">2.4. Analysis Engine Descriptors</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.aes.primitive">2.4.1. Primitive Analysis Engine Descriptors</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.aes.aggregate">2.4.2. Aggregate Analysis Engine Descriptors</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.aes.configuration_parameters">2.4.3. Configuration Parameters</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.flow_controller">2.5. F low Controller Descriptors</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.collection_processing_parts">2.6. Collection Processing Component Descriptors</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.collection_processing_parts.collection_reader">2.6.1. Collection Reader Descriptors</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.collection_processing_parts.cas_initializer">2.6.2. CAS Initializer Descriptors (deprecated)</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.collection_processing_parts.cas_consumer">2.6.3. CAS Consumer Descriptors</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.service_client">2.7. Service Client Descriptors</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.component_descriptor.custom_resource_specifiers">2.8. Custom Resource Specifiers</a></span>< /dt></dl></dd><dt><span class="chapter"><a href="#ugr.ref.xml.cpe_descriptor">3. CPE Descriptor Reference</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.overview">3.1. CPE Overview</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.notation">3.2. Notation</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.imports">3.3. Imports</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.descriptor">3.4. CPE Descriptor Overview</a></span></dt><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.descriptor.collection_reader">3.5. Collection Reader</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.descriptor.collection_reader.error_handling">3.5.1. Error handling for Collection Readers</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.xml.cpe_descriptor.descriptor.cas_processors">3.6. CAS Processors</a></span></dt ><dd><dl><dt><span class="section"><a >href="#ugr.ref.xml.cpe_descriptor.descriptor.cas_processors.individual">3.6.1. > Specifying an Individual CAS Processor</a></span></dt></dl></dd><dt><span >class="section"><a >href="#ugr.ref.xml.cpe_descriptor.descriptor.operational_parameters">3.7. CPE >Operational Parameters</a></span></dt><dt><span class="section"><a >href="#ugr.ref.xml.cpe_descriptor.descriptor.resource_manager_configuration">3.8. > Resource Manager Configuration</a></span></dt><dt><span class="section"><a >href="#ugr.ref.xml.cpe_descriptor.descriptor.example">3.9. Example CPE >Descriptor</a></span></dt></dl></dd><dt><span class="chapter"><a >href="#ugr.ref.cas">4. CAS Reference</a></span></dt><dd><dl><dt><span >class="section"><a href="#ugr.ref.cas.javadocs">4.1. >Javadocs</a></span></dt><dt><span class="section"><a >href="#ugr.ref.cas.overview">4.2. CAS >Overview</a></span></dt><dd><dl><dt><span class="section"><a >href="#ugr.ref.cas.type_system">4.2.1. The Type System</a></span></dt><dt> <span class="section"><a href="#ugr.ref.cas.creating_accessing_manipulating_data">4.2.2. Creating/Accessing/Changing data</a></span></dt><dt><span class="section"><a href="#ugr.ref.cas.creating_using_indexes">4.2.3. Creating and using indexes</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.cas.builtin_types">4.3. Built-in CAS Types</a></span></dt><dt><span class="section"><a href="#ugr.ref.cas.accessing_the_type_system">4.4. Accessing the type system</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.cas.type_system.printer_example">4.4.1. TypeSystemPrinter example</a></span></dt><dt><span class="section"><a href="#ugr.ref.cas.cas_apis_create_modify_feature_structures">4.4.2. Using CAS APIs: Feature Structures</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.cas.creating_feature_structures">4.5. Creating feature structures</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.cas.updating_indexed_feature_structure s">4.5.1. Updating indexed feature structures</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.cas.accessing_modifying_features_of_feature_structures">4.6. Accessing or modifying Features</a></span></dt><dt><span class="section"><a href="#ugr.ref.cas.indexes_and_iterators">4.7. Indexes and Iterators</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.cas.index.built_in_indexes">4.7.1. Built-in Indexes</a></span></dt><dt><span class="section"><a href="#ugr.ref.cas.index.adding_to_indexes">4.7.2. Adding Feature Structures to the Indexes</a></span></dt><dt><span class="section"><a href="#ugr.ref.cas.index.iterators">4.7.3. Iterators over UIMA Indexes</a></span></dt><dt><span class="section"><a href="#ugr.ref.cas.index.annotation_index">4.7.4. Special iterators for Annotation types</a></span></dt><dt><span class="section"><a href="#ugr.ref.cas.index.constraints_and_filtered_iterators">4.7.5. Constraints and Filtered iterators</a></span></dt></dl></dd>< dt><span class="section"><a href="#ugr.ref.cas.guide_to_javadocs">4.8. CAS API's Javadocs</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.cas.javadocs.cas_package">4.8.1. APIs in the CAS package</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.cas.typemerging">4.9. Type Merging</a></span></dt><dt><span class="section"><a href="#ugr.ref.cas.limitedmultipleaccess">4.10. Limited multi-thread access to read-only CASs</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.ref.jcas">5. JCas Reference</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.jcas.name_spaces">5.1. Name Spaces</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.use_of_description">5.2. Use of XML Description</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.mapping_built_ins">5.3. Mapping built-in CAS types to Java types</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.augmenting_generated_code">5.4. Augmentin g the generated Java Code</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.jcas.keeping_augmentations_when_regenerating">5.4.1. Keeping hand-coded augmentations when regenerating</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.additional_constructors">5.4.2. Additional Constructors</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.modifying_generated_items">5.4.3. Modifying generated items</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.jcas.merging_types_from_other_specs">5.5. Merging Types</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.jcas.merging_types.aggregates_and_cpes">5.5.1. Aggregate AEs and CPEs as sources of types</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.merging_types.jcasgen_support">5.5.2. JCasGen support for type merging</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.impact_of_type_merging_on_composability">5.5.3. Type Merging impacts on Com posability</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.documentannotation_issues">5.5.4. Adding Features to DocumentAnnotation</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.jcas.using_within_an_annotator">5.6. Using JCas within an Annotator</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.jcas.new_instances">5.6.1. Creating new instances</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.getters_and_setters">5.6.2. Getters and Setters</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.obtaining_refs_to_indexes">5.6.3. Obtaining references to Indexes</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.adding_removing_instances_to_indexes">5.6.4. Updating Indexes</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.using_iterators">5.6.5. Using Iterators</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.class_loaders">5.6.6. Class Loaders in UIMA</a></span></dt>< dt><span class="section"><a href="#ugr.ref.jcas.accessing_jcas_objects_outside_uima_components">5.6.7. Issues accessing JCas objects outside of UIMA Engine Components</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.jcas.setting_up_classpath">5.7. Setting up Classpath for JCas</a></span></dt><dt><span class="section"><a href="#ugr.ref.jcas.pear_support">5.8. PEAR isolation</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.ref.pear">6. PEAR Reference</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.pear.packaging_a_component">6.1. Packaging a UIMA component</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.pear.creating_pear_structure">6.1.1. Creating the PEAR structure</a></span></dt><dt><span class="section"><a href="#ugr.ref.pear.populating_pear_structure">6.1.2. Populating the PEAR structure</a></span></dt><dt><span class="section"><a href="#ugr.ref.pear.creating_installation_descriptor">6.1.3. Creating the ins tallation descriptor</a></span></dt><dt><span class="section"><a href="#ugr.ref.pear.installation_descriptor">6.1.4. Installation Descriptor: template</a></span></dt><dt><span class="section"><a href="#ugr.ref.pear.packaging_into_1_file">6.1.5. Packaging the PEAR structure into one file</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.pear.installing">6.2. Installing a PEAR package</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.pear.installing_pear_using_API">6.2.1. Installing a PEAR file using the PEAR APIs</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.pear.specifier">6.3. PEAR package descriptor</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.ref.xmi">7. XMI CAS Serialization Reference</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.xmi.xmi_tag">7.1. XMI Tag</a></span></dt><dt><span class="section"><a href="#ugr.ref.xmi.feature_structures">7.2. Feature Structures</a></span></dt><dt>< span class="section"><a href="#ugr.ref.xmi.primitive_features">7.3. Primitive Features</a></span></dt><dt><span class="section"><a href="#ugr.ref.xmi.reference_features">7.4. Reference Features</a></span></dt><dt><span class="section"><a href="#ugr.ref.xmi.array_and_list_features">7.5. Array and List Features</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.xmi.array_and_list_features.as_multi_valued_properties">7.5.1. Arrays and Lists as Multi-Valued Properties</a></span></dt><dt><span class="section"><a href="#ugr.ref.xmi.array_and_list_features.as_1st_class_objects">7.5.2. Arrays and Lists as First-Class Objects</a></span></dt><dt><span class="section"><a href="#ugr.ref.xmi.null_array_list_elements">7.5.3. Null Array/List Elements</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.xmi.sofas_views">7.6. Subjects of Analysis (Sofas) and Views</a></span></dt><dt><span class="section"><a href="#ugr.ref.xmi.linking_to_ecore_type_system">7.7. Linking XMI docs to Ecore Type System</a></span></dt><dt><span class="section"><a href="#ugr.ref.xmi.delta">7.8. Delta CAS XMI Format</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.ref.compress">8. Compressed Binary CASes</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.compress.overview">8.1. Binary CAS Compression overview</a></span></dt><dt><span class="section"><a href="#ugr.ref.compress.usage">8.2. Using Compressed Binary CASes</a></span></dt><dt><span class="section"><a href="#ugr.ref.compress.simple-deltas">8.3. Simple Delta CAS serialization</a></span></dt><dt><span class="section"><a href="#ugr.ref.compress.use-cases">8.4. Use Case cookbook</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.ref.json">9. JSON support</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.json.overview">9.1. JSON serialization support overview</a></span></dt><dt><span class="section"><a href="#ug.ref.json.cas">9.2. JSON CAS Serialization< /a></span></dt><dd><dl><dt><span class="section"><a href="#ug.ref.json.cas.bigpic">9.2.1. The Big Picture</a></span></dt><dt><span class="section"><a href="#ug.ref.json.cas.context">9.2.2. The _context section</a></span></dt><dt><span class="section"><a href="#ug.ref.json.cas.featurestructures">9.2.3. Serializing Feature Structures</a></span></dt></dl></dd><dt><span class="section"><a href="#ug.ref.json.cas.featurestructures.organization">9.3. Organizing the Feature Structures</a></span></dt><dt><span class="section"><a href="#ug.ref.json.cas.features">9.4. Additional JSON CAS Serialization features</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.json.delta">9.4.1. Delta CAS</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.json.usage">9.5. Using JSON CAS serialization</a></span></dt><dt><span class="section"><a href="#ugr.ref.json.descriptionserialization">9.6. JSON serialization for UIMA descriptors</a></span></dt></dl></dd><dt><span class="ch apter"><a href="#ugr.ref.config">10. Setup and Configuration</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.config.properties">10.1. UIMA JVM Configuration Properties</a></span></dt><dt><span class="section"><a href="#ugr.ref.config.protect-index">10.2. Configuring index protection</a></span></dt><dt><span class="section"><a href="#ugr.ref.config.property-table">10.3. Properties Table</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.ref.resources">11. UIMA Resources</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.resources.overview">11.1. What is a UIMA Resource?</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.ref.resources.resource-inner-implementations">11.1.1. Resource Inner Implementations</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.ref.resources.sharing-across-pipelines">11.2. Sharing Resources</a></span></dt><dt><span class="section"><a href="#ugr.ref.resources.external-resource-multiple -parameterized-instances">11.3. External Resources support for multiple Parameterized Instances</a></span></dt></dl></dd></dl></div> Modified: uima/site/trunk/uima-website/docs/d/uimaj-current/references.pdf URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimaj-current/references.pdf?rev=1904950&r1=1904949&r2=1904950&view=diff ============================================================================== Binary files - no diff available. Modified: uima/site/trunk/uima-website/docs/d/uimaj-current/tools.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimaj-current/tools.html?rev=1904950&r1=1904949&r2=1904950&view=diff ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimaj-current/tools.html (original) +++ uima/site/trunk/uima-website/docs/d/uimaj-current/tools.html Mon Oct 31 13:15:29 2022 @@ -2,7 +2,7 @@ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>UIMA Tools Guide and Reference</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 Tools Guide and Reference" id="d5e1"><div xmlns:d="http://docbook.org/ns/docbook"; class="titlepage"><div><div><h1 class="title">UIMA Tools Guide and Reference</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.0</p></div><div><p class="copyright">Copyright © 2006, 2022 The Apache Software Foundation</p></div><div><div class="legalnotice" title="Legal Notice"><a name="d5e8"></a> + </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><div class="legalnotice" title="Legal Notice"><a name="d5e8"></a> <p> </p> <p title="License and Disclaimer"> <b>License and Disclaimer. </b> @@ -35,7 +35,7 @@ the trademark or service mark. </p> - </div></div><div><p class="pubdate">April, 2022</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#ugr.tools.cde">1. CDE User's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cde.launching">1.1. Launching the Component Descriptor Editor</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.creating_new_ae_descriptor">1.2. Creating a New AE Descriptor</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.pages_within_the_editor">1.3. Pages within the Editor</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cde.adjusting_display_of_pages">1.3.1. Adjusting the display of pages</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.cde.overview_page">1.4. Overview Page</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cde.overview_page.implementation_details">1.4.1. Implementation Details</a></span></dt><dt><span class= "section"><a href="#ugr.tools.cde.overview_page.runtime_info">1.4.2. Runtime Information</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.overview_page.overall_id_info">1.4.3. Overall Identification Information</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.cde.aggregate_page">1.5. Aggregate Page</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cde.aggregate_page.adding_components_more_than_once">1.5.1. Adding components more than once</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.aggregate_page.adding_removing_components_from_flow">1.5.2. Adding or Removing components in a flow</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.aggregate_page.adding_remote_aes">1.5.3. Adding remote Analysis Engines</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.aggregate_page.connecting_to_remote_services">1.5.4. Connecting to Remote Services</a></span></dt><dt><span class="section"><a hre f="#ugr.tools.cde.aggregate_page.finding_aes_by_searching">1.5.5. Finding Analysis Engines by searching</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.aggregate_page.component_engine_flow">1.5.6. Component Engine Flow</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.cde.parm_definition">1.6. Parameters Definition Page</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cde.parm_definition.using_groups">1.6.1. Using groups</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.parm_definition.adding">1.6.2. Adding or Editing a Parameter</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.parm_definition.aggregates">1.6.3. Parameter declarations for Aggregates</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.cde.parameter_settings">1.7. Parameter Settings Page</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.type_system">1.8. Type System Page</a></span></dt><dd><dl><dt ><span class="section"><a href="#ugr.tools.cde.type_system.exporting">1.8.1. >Exporting</a></span></dt></dl></dd><dt><span class="section"><a >href="#ugr.tools.cde.capabilities">1.9. Capabilities >Page</a></span></dt><dd><dl><dt><span class="section"><a >href="#ugr.tools.cde.capabilities.sofa_name_mapping">1.9.1. Sofa (and view) >name mappings</a></span></dt></dl></dd><dt><span class="section"><a >href="#ugr.tools.cde.indexes">1.10. Indexes Page</a></span></dt><dt><span >class="section"><a href="#ugr.tools.cde.resources">1.11. Resources >Page</a></span></dt><dd><dl><dt><span class="section"><a >href="#ugr.tools.cde.resources.binding">1.11.1. >Binding</a></span></dt><dt><span class="section"><a >href="#ugr.tools.cde.resources.aggregates">1.11.2. Resources with >Aggregates</a></span></dt><dt><span class="section"><a >href="#ugr.tools.cde.resources.imports_exports">1.11.3. Imports and >Exports</a></span></dt></dl></dd><dt><span class="section"><a >href="#ugr.tools.cde.source">1.12. Source Page</a></s pan></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cde.source.formatting">1.12.1. Source formatting – indentation</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.cde.creating_self_contained_type_system">1.13. Creating a Self-Contained Type System</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.creating_other_descriptor_components">1.14. Creating Other Descriptor Components</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tools.cpe">2. CPE Configurator User's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cpe.limitations">2.1. Limitations of the CPE Configurator</a></span></dt><dt><span class="section"><a href="#ugr.tools.cpe.starting">2.2. Starting the CPE Configurator</a></span></dt><dt><span class="section"><a href="#ugr.tools.cpe.selecting_component_descriptors">2.3. Selecting Component Descriptors</a></span></dt><dt><span class="section"><a href="#ugr.tools.cpe.running">2.4. Run ning a Collection Processing Engine</a></span></dt><dt><span class="section"><a href="#ugr.tools.cpe.file_menu">2.5. The File Menu</a></span></dt><dt><span class="section"><a href="#ugr.tools.cpe.help_menu">2.6. The Help Menu</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tools.doc_analyzer">3. Document Analyzer User's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.doc_analyzer.starting">3.1. Starting the Document Analyzer</a></span></dt><dt><span class="section"><a href="#ugr.tools.doc_analyzer.running_an_ae">3.2. Running an AE</a></span></dt><dt><span class="section"><a href="#ugr.tools.doc_analyzer.viewing_results">3.3. Viewing the Analysis Results</a></span></dt><dt><span class="section"><a href="#ugr.tools.doc_analyzer.configuring">3.4. Configuring the Annotation Viewer</a></span></dt><dt><span class="section"><a href="#ugr.tools.doc_analyzer.interactive_mode">3.5. Interactive Mode</a></span></dt><dt><span class="section"><a href="# ugr.tools.doc_analyzer.view_mode">3.6. View Mode</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tools.annotation_viewer">4. Annotation Viewer</a></span></dt><dt><span class="chapter"><a href="#ugr.tools.cvd">5. CAS Visual Debugger</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cvd.introduction">5.1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.cvd.introduction.running">5.1.1. Running CVD</a></span></dt><dt><span class="section"><a href="#cvd.introduction.commandline">5.1.2. Command line parameters</a></span></dt></dl></dd><dt><span class="section"><a href="#cvd.errorHandling">5.2. Error Handling</a></span></dt><dt><span class="section"><a href="#cvd.preferencesFile">5.3. Preferences File</a></span></dt><dt><span class="section"><a href="#cvd.theMenus">5.4. The Menus</a></span></dt><dd><dl><dt><span class="section"><a href="#cvd.fileMenu">5.4.1. The File Menu</a></span></dt><dt><span class="section"><a href="#cvd. editMenu">5.4.2. The Edit Menu</a></span></dt><dt><span class="section"><a href="#cvd.runMenu">5.4.3. The Run Menu</a></span></dt><dt><span class="section"><a href="#cvd.toolsMenu">5.4.4. The tools menu</a></span></dt></dl></dd><dt><span class="section"><a href="#cvd.mainDisplayArea">5.5. The Main Display Area</a></span></dt><dd><dl><dt><span class="section"><a href="#cvd.statusBar">5.5.1. The Status Bar</a></span></dt><dt><span class="section"><a href="#cvd.keyboardNavigation">5.5.2. Keyboard Navigation and Shortcuts</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#ugr.tools.eclipse_launcher">6. Eclipse Analysis Engine Launcher's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.eclipse_launcher.create_configuration">6.1. Creating an Analysis Engine launch configuration</a></span></dt><dt><span class="section"><a href="#ugr.tools.eclipse_launcher.launching">6.2. Launching an Analysis Engine</a></span></dt></dl></dd><dt><span class="cha pter"><a href="#ugr.tools.ce">7. Cas Editor User's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#sandbox.caseditor.Introduction">7.1. Introduction</a></span></dt><dt><span class="section"><a href="#sandbox.caseditor.Launching">7.2. Launching the Cas Editor</a></span></dt><dd><dl><dt><span class="section"><a href="#sandbox.caseditor.typeSystemSpec">7.2.1. Specifying a type system</a></span></dt></dl></dd><dt><span class="section"><a href="#sandbox.caseditor.annotation_editor">7.3. Annotation editor</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cas_editor.annotation_editor.editor">7.3.1. Editor</a></span></dt><dt><span class="section"><a href="#sandbox.caseditor.annotation_editor.styling">7.3.2. Configure annotation styling</a></span></dt><dt><span class="section"><a href="#ugr.tools.cas_editor.annotation_editor.cas_views">7.3.3. CAS view support</a></span></dt><dt><span class="section"><a href="#ugr.tools.cas_editor.annotation_editor.outline" >7.3.4. Outline view</a></span></dt><dt><span class="section"><a >href="#ugr.tools.cas_editor.annotation_editor.properties_view">7.3.5. Edit >Views</a></span></dt><dt><span class="section"><a >href="#ugr.tools.cas_editor.annotation_editor.fs_view">7.3.6. >FeatureStructure View</a></span></dt></dl></dd><dt><span class="section"><a >href="#ugr.tools.cas_editor.custom_view">7.4. Implementing a custom Cas >Editor View</a></span></dt><dd><dl><dt><span class="section"><a >href="#ugr.tools.cas_editor.custom_view.sample">7.4.1. Annotation Status View >Sample</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a >href="#ugr.tools.jcasgen">8. JCasGen User's >Guide</a></span></dt><dd><dl><dt><span class="section"><a >href="#ugr.tools.jcasgen.running_without_eclipse">8.1. Running stand-alone >without Eclipse</a></span></dt><dt><span class="section"><a >href="#ugr.tools.jcasgen.running_standalone_with_eclipse">8.2. Running >stand-alone with Eclipse</a></span></dt><dt><span class="section"><a href="# ugr.tools.jcasgen.running_within_eclipse">8.3. Running within Eclipse</a></span></dt><dt><span class="section"><a href="#ugr.tools.jcasgen.maven_plugin">8.4. Using the jcasgen-maven-plugin</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tools.pear.packager">9. PEAR Packager User's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.pear.packager.using_eclipse_plugin">9.1. Using the PEAR Eclipse Plugin</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.pear.packager.add_uima_nature">9.1.1. Add UIMA Nature to your project</a></span></dt><dt><span class="section"><a href="#ugr.tools.pear.packager.using_pear_generation_wizard">9.1.2. Using the PEAR Generation Wizard</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.pear.packager.using_command_line">9.2. Using the PEAR command line packager</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tools.pear.packager.maven.plugin.usage">10. The PEAR Pac kaging Maven Plugin</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.pear.packager.maven.plugin.usage.configure">10.1. Specifying the PEAR Packaging Maven Plugin</a></span></dt><dt><span class="section"><a href="#ugr.tools.pear.packager.maven.plugin.usage.dependencies">10.2. Automatically including dependencies</a></span></dt><dt><span class="section"><a href="#ugr.tools.pear.packager.maven.plugin.commandline">10.3. Running from the command line</a></span></dt><dt><span class="section"><a href="#ugr.tools.pear.packager.maven.plugin.install.src">10.4. Building the PEAR Packaging Plugin From Source</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tools.pear.installer">11. PEAR Installer User's Guide</a></span></dt><dt><span class="chapter"><a href="#ugr.tools.pear.merger">12. PEAR Merger User's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.pear.merger.merge_details">12.1. Details of the merging process</a></span></dt><dt ><span class="section"><a >href="#ugr.tools.pear.merger.testing_modifying_resulting_pear">12.2. Testing >and Modifying the resulting PEAR</a></span></dt><dt><span class="section"><a >href="#ugr.tools.pear.merger.restrictions_limitations">12.3. Restrictions and >Limitations</a></span></dt></dl></dd></dl></div> + </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.tools.cde">1. CDE User's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cde.launching">1.1. Launching the Component Descriptor Editor</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.creating_new_ae_descriptor">1.2. Creating a New AE Descriptor</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.pages_within_the_editor">1.3. Pages within the Editor</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cde.adjusting_display_of_pages">1.3.1. Adjusting the display of pages</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.cde.overview_page">1.4. Overview Page</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cde.overview_page.implementation_details">1.4.1. Implementation Details</a></span></dt><dt><span clas s="section"><a href="#ugr.tools.cde.overview_page.runtime_info">1.4.2. Runtime Information</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.overview_page.overall_id_info">1.4.3. Overall Identification Information</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.cde.aggregate_page">1.5. Aggregate Page</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cde.aggregate_page.adding_components_more_than_once">1.5.1. Adding components more than once</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.aggregate_page.adding_removing_components_from_flow">1.5.2. Adding or Removing components in a flow</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.aggregate_page.adding_remote_aes">1.5.3. Adding remote Analysis Engines</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.aggregate_page.connecting_to_remote_services">1.5.4. Connecting to Remote Services</a></span></dt><dt><span class="section"><a h ref="#ugr.tools.cde.aggregate_page.finding_aes_by_searching">1.5.5. Finding Analysis Engines by searching</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.aggregate_page.component_engine_flow">1.5.6. Component Engine Flow</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.cde.parm_definition">1.6. Parameters Definition Page</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cde.parm_definition.using_groups">1.6.1. Using groups</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.parm_definition.adding">1.6.2. Adding or Editing a Parameter</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.parm_definition.aggregates">1.6.3. Parameter declarations for Aggregates</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.cde.parameter_settings">1.7. Parameter Settings Page</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.type_system">1.8. Type System Page</a></span></dt><dd><dl>< dt><span class="section"><a href="#ugr.tools.cde.type_system.exporting">1.8.1. Exporting</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.cde.capabilities">1.9. Capabilities Page</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cde.capabilities.sofa_name_mapping">1.9.1. Sofa (and view) name mappings</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.cde.indexes">1.10. Indexes Page</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.resources">1.11. Resources Page</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cde.resources.binding">1.11.1. Binding</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.resources.aggregates">1.11.2. Resources with Aggregates</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.resources.imports_exports">1.11.3. Imports and Exports</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.cde.source">1.12. Source Page</a>< /span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cde.source.formatting">1.12.1. Source formatting – indentation</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.cde.creating_self_contained_type_system">1.13. Creating a Self-Contained Type System</a></span></dt><dt><span class="section"><a href="#ugr.tools.cde.creating_other_descriptor_components">1.14. Creating Other Descriptor Components</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tools.cpe">2. CPE Configurator User's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cpe.limitations">2.1. Limitations of the CPE Configurator</a></span></dt><dt><span class="section"><a href="#ugr.tools.cpe.starting">2.2. Starting the CPE Configurator</a></span></dt><dt><span class="section"><a href="#ugr.tools.cpe.selecting_component_descriptors">2.3. Selecting Component Descriptors</a></span></dt><dt><span class="section"><a href="#ugr.tools.cpe.running">2.4. R unning a Collection Processing Engine</a></span></dt><dt><span class="section"><a href="#ugr.tools.cpe.file_menu">2.5. The File Menu</a></span></dt><dt><span class="section"><a href="#ugr.tools.cpe.help_menu">2.6. The Help Menu</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tools.doc_analyzer">3. Document Analyzer User's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.doc_analyzer.starting">3.1. Starting the Document Analyzer</a></span></dt><dt><span class="section"><a href="#ugr.tools.doc_analyzer.running_an_ae">3.2. Running an AE</a></span></dt><dt><span class="section"><a href="#ugr.tools.doc_analyzer.viewing_results">3.3. Viewing the Analysis Results</a></span></dt><dt><span class="section"><a href="#ugr.tools.doc_analyzer.configuring">3.4. Configuring the Annotation Viewer</a></span></dt><dt><span class="section"><a href="#ugr.tools.doc_analyzer.interactive_mode">3.5. Interactive Mode</a></span></dt><dt><span class="section"><a href= "#ugr.tools.doc_analyzer.view_mode">3.6. View Mode</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tools.annotation_viewer">4. Annotation Viewer</a></span></dt><dt><span class="chapter"><a href="#ugr.tools.cvd">5. CAS Visual Debugger</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cvd.introduction">5.1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.cvd.introduction.running">5.1.1. Running CVD</a></span></dt><dt><span class="section"><a href="#cvd.introduction.commandline">5.1.2. Command line parameters</a></span></dt></dl></dd><dt><span class="section"><a href="#cvd.errorHandling">5.2. Error Handling</a></span></dt><dt><span class="section"><a href="#cvd.preferencesFile">5.3. Preferences File</a></span></dt><dt><span class="section"><a href="#cvd.theMenus">5.4. The Menus</a></span></dt><dd><dl><dt><span class="section"><a href="#cvd.fileMenu">5.4.1. The File Menu</a></span></dt><dt><span class="section"><a href="#cv d.editMenu">5.4.2. The Edit Menu</a></span></dt><dt><span class="section"><a href="#cvd.runMenu">5.4.3. The Run Menu</a></span></dt><dt><span class="section"><a href="#cvd.toolsMenu">5.4.4. The tools menu</a></span></dt></dl></dd><dt><span class="section"><a href="#cvd.mainDisplayArea">5.5. The Main Display Area</a></span></dt><dd><dl><dt><span class="section"><a href="#cvd.statusBar">5.5.1. The Status Bar</a></span></dt><dt><span class="section"><a href="#cvd.keyboardNavigation">5.5.2. Keyboard Navigation and Shortcuts</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#ugr.tools.eclipse_launcher">6. Eclipse Analysis Engine Launcher's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.eclipse_launcher.create_configuration">6.1. Creating an Analysis Engine launch configuration</a></span></dt><dt><span class="section"><a href="#ugr.tools.eclipse_launcher.launching">6.2. Launching an Analysis Engine</a></span></dt></dl></dd><dt><span class="c hapter"><a href="#ugr.tools.ce">7. Cas Editor User's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#sandbox.caseditor.Introduction">7.1. Introduction</a></span></dt><dt><span class="section"><a href="#sandbox.caseditor.Launching">7.2. Launching the Cas Editor</a></span></dt><dd><dl><dt><span class="section"><a href="#sandbox.caseditor.typeSystemSpec">7.2.1. Specifying a type system</a></span></dt></dl></dd><dt><span class="section"><a href="#sandbox.caseditor.annotation_editor">7.3. Annotation editor</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cas_editor.annotation_editor.editor">7.3.1. Editor</a></span></dt><dt><span class="section"><a href="#sandbox.caseditor.annotation_editor.styling">7.3.2. Configure annotation styling</a></span></dt><dt><span class="section"><a href="#ugr.tools.cas_editor.annotation_editor.cas_views">7.3.3. CAS view support</a></span></dt><dt><span class="section"><a href="#ugr.tools.cas_editor.annotation_editor.outlin e">7.3.4. Outline view</a></span></dt><dt><span class="section"><a href="#ugr.tools.cas_editor.annotation_editor.properties_view">7.3.5. Edit Views</a></span></dt><dt><span class="section"><a href="#ugr.tools.cas_editor.annotation_editor.fs_view">7.3.6. FeatureStructure View</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.cas_editor.custom_view">7.4. Implementing a custom Cas Editor View</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.cas_editor.custom_view.sample">7.4.1. Annotation Status View Sample</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#ugr.tools.jcasgen">8. JCasGen User's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.jcasgen.running_without_eclipse">8.1. Running stand-alone without Eclipse</a></span></dt><dt><span class="section"><a href="#ugr.tools.jcasgen.running_standalone_with_eclipse">8.2. Running stand-alone with Eclipse</a></span></dt><dt><span class="section"><a href= "#ugr.tools.jcasgen.running_within_eclipse">8.3. Running within Eclipse</a></span></dt><dt><span class="section"><a href="#ugr.tools.jcasgen.maven_plugin">8.4. Using the jcasgen-maven-plugin</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tools.pear.packager">9. PEAR Packager User's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.pear.packager.using_eclipse_plugin">9.1. Using the PEAR Eclipse Plugin</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.pear.packager.add_uima_nature">9.1.1. Add UIMA Nature to your project</a></span></dt><dt><span class="section"><a href="#ugr.tools.pear.packager.using_pear_generation_wizard">9.1.2. Using the PEAR Generation Wizard</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.pear.packager.using_command_line">9.2. Using the PEAR command line packager</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tools.pear.packager.maven.plugin.usage">10. The PEAR P ackaging Maven Plugin</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.pear.packager.maven.plugin.usage.configure">10.1. Specifying the PEAR Packaging Maven Plugin</a></span></dt><dt><span class="section"><a href="#ugr.tools.pear.packager.maven.plugin.usage.dependencies">10.2. Automatically including dependencies</a></span></dt><dt><span class="section"><a href="#ugr.tools.pear.packager.maven.plugin.commandline">10.3. Running from the command line</a></span></dt><dt><span class="section"><a href="#ugr.tools.pear.packager.maven.plugin.install.src">10.4. Building the PEAR Packaging Plugin From Source</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tools.pear.installer">11. PEAR Installer User's Guide</a></span></dt><dt><span class="chapter"><a href="#ugr.tools.pear.merger">12. PEAR Merger User's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.pear.merger.merge_details">12.1. Details of the merging process</a></span></dt>< dt><span class="section"><a href="#ugr.tools.pear.merger.testing_modifying_resulting_pear">12.2. Testing and Modifying the resulting PEAR</a></span></dt><dt><span class="section"><a href="#ugr.tools.pear.merger.restrictions_limitations">12.3. Restrictions and Limitations</a></span></dt></dl></dd></dl></div> Modified: uima/site/trunk/uima-website/docs/d/uimaj-current/tools.pdf URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimaj-current/tools.pdf?rev=1904950&r1=1904949&r2=1904950&view=diff ============================================================================== Binary files - no diff available.
