You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by re...@apache.org on 2023/02/02 08:24:30 UTC
svn commit: r1907218 [37/43] - in /uima/site/trunk/uima-website: docs/ docs/d/uimaj-current/ docs/d/uimaj-current/apidocs/ docs/d/uimaj-current/apidocs/org/apache/uima/ docs/d/uimaj-current/apidocs/org/apache/uima/analysis_component/ docs/d/uimaj-curre...
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=1907218&r1=1907217&r2=1907218&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 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 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">
+ <title>UIMA References</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 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.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.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>
+ </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.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.r
ef.xml.component_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_contro
ller">2.5. Flow 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></sp
an></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_featu
re_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 im
pacts on Composability</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. Crea
ting the installation 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></spa
n></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 Se
rialization</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><sp
an class="chapter"><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-resou
rce-multiple-parameterized-instances">11.3. External Resources support for multiple Parameterized Instances</a></span></dt></dl></dd></dl></div>
- <div class="chapter" title="Chapter 1. Javadocs" id="ugr.ref.javadocs"><div class="titlepage"><div><div><h2 class="title">Chapter 1. Javadocs</h2></div></div></div>
+ <div class="chapter" id="ugr.ref.javadocs"><div class="titlepage"><div><div><h1 class="title">Chapter 1. Javadocs</h1></div></div></div>
<p>The details of all the public APIs for UIMA are contained in the API Javadocs. These are located in the docs/api
@@ -51,7 +51,7 @@
to the <code class="literal">uimaj-examples</code> project, if you followed the setup instructions in <a href="overview_and_setup.html#d4e1" class="olink">UIMA Overview & SDK Setup</a> <a href="overview_and_setup.html#ugr.ovv.eclipse_setup.example_code" class="olink">Section 3.2, “Setting up Eclipse to view Example Code”</a>. To attach
Javadocs to your own Eclipse project, use the following instructions.</p>
- <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>As an alternative, you can add the UIMA source to the UIMA binary distribution; if you
+ <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>As an alternative, you can add the UIMA source to the UIMA binary distribution; if you
do this you not only will have the Javadocs automatically available (you can skip the following
setup), you will have the ability to step through the UIMA framework code while debugging.
To add the source, follow the instructions as described in the setup chapter:
@@ -66,7 +66,7 @@
</p><div class="screenshot">
- <div class="mediaobject"><table border="0" summary="manufactured viewport for HTML img" cellspacing="0" cellpadding="0" width="574"><tr><td><img src="images/references/ref.javadocs/image002.jpg" width="574" alt="Screenshot of attaching Javadoc to source in Eclipse"></td></tr></table></div>
+ <div class="mediaobject"><table border="0" summary="manufactured viewport for HTML img" style="cellpadding: 0; cellspacing: 0;" width="574"><tr><td><img src="images/references/ref.javadocs/image002.jpg" width="574" alt="Screenshot of attaching Javadoc to source in Eclipse"></td></tr></table></div>
</div>
<p>Once you do this, Eclipse can show you Javadocs for UIMA APIs as you work. To see the Javadoc for a UIMA API, you
@@ -79,7 +79,7 @@
releases is available from the Apache UIMA web site (<a class="ulink" href="http://uima.apache.org" target="_top">http://uima.apache.org</a>) on the
downloads page.</p>
- <div class="section" title="1.1. Using named Eclipse User Libraries"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.ref.javadocs.libraries">1.1. Using named Eclipse User Libraries</h2></div></div></div>
+ <div class="section" id="ugr.ref.javadocs.libraries"><div class="titlepage"><div><div><h2 class="title" style="clear: both">1.1. Using named Eclipse User Libraries</h2></div></div></div>
<p>You can also create a named "user library" in Eclipse containing the UIMA Jars, and attach the Javadocs (or
optionally, the sources); this named library is saved in the Eclipse workspace. Once created, it can be
@@ -97,7 +97,7 @@
copy this string to the clipboard and paste it into the rest of the Jars.</p>
</div>
</div>
- <div class="chapter" title="Chapter 2. Component Descriptor Reference" id="ugr.ref.xml.component_descriptor"><div class="titlepage"><div><div><h2 class="title">Chapter 2. Component Descriptor Reference</h2></div></div></div>
+ <div class="chapter" id="ugr.ref.xml.component_descriptor"><div class="titlepage"><div><div><h1 class="title">Chapter 2. Component Descriptor Reference</h1></div></div></div>
<p>This chapter is the reference guide for the UIMA SDK's Component Descriptor XML
@@ -109,7 +109,7 @@
<span class="emphasis"><em>Component</em></span> (also called <span class="emphasis"><em>Resource</em></span>) is a
general term for modules produced by UIMA developers and used by UIMA applications. The
types of Components are: Analysis Engines, Collection Readers, CAS
- Initializers<sup>[<a name="d5e71" href="#ftn.d5e71" class="footnote">1</a>]</sup>, CAS Consumers, and Collection Processing Engines.
+ Initializers<a href="#ftn.d5e71" class="footnote"><sup class="footnote" id="d5e71">[1]</sup></a>, CAS Consumers, and Collection Processing Engines.
However, Collection Processing Engine Descriptors are significantly different in
format and are covered in a separate chapter, <a href="references.html#ugr.ref.xml.cpe_descriptor" class="olink">Chapter 3, <i>Collection Processing Engine Descriptor Reference</i></a>.</p>
@@ -137,7 +137,7 @@
<span class="emphasis"><em>Custom Resource Specifiers</em></span>, which allow you to plug in your
own Java class as a UIMA Resource.</p>
- <div class="section" title="2.1. Notation"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.ref.xml.component_descriptor.notation">2.1. Notation</h2></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.notation"><div class="titlepage"><div><div><h2 class="title" style="clear: both">2.1. Notation</h2></div></div></div>
<p>This chapter uses an informal notation to specify the syntax of Component
@@ -147,7 +147,7 @@
<p>The notation used in this chapter is:</p>
- <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>An ellipsis (...) inside an element body indicates
+ <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>An ellipsis (...) inside an element body indicates
that the substructure of that element has been omitted (to be described in another
section of this chapter). An example of this would be:
@@ -170,7 +170,7 @@
prose, not in the syntax definition. </p></li></ul></div>
</div>
- <div class="section" title="2.2. Imports"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.ref.xml.component_descriptor.imports">2.2. Imports</h2></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.imports"><div class="titlepage"><div><div><h2 class="title" style="clear: both">2.2. Imports</h2></div></div></div>
<p>The UIMA SDK defines a particular syntax for XML descriptors to import information
@@ -194,7 +194,7 @@
<p>An absolute URL is written with one of the following prefixes, followed by a path
such as <code class="literal">org/apache/myproj/MyTypeSystem.xml</code>:
- </p><div class="itemizedlist"><ul class="itemizedlist" type="disc" compact><li class="listitem"><p>file:/ <span class="symbol">←</span> has no network
+ </p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc; "><li class="listitem"><p>file:/ <span class="symbol">←</span> has no network
address</p></li><li class="listitem"><p>file:/// <span class="symbol">←</span> has an empty network address</p></li><li class="listitem"><p>file://some.network.address/</p></li></ul></div>
<p>For more information about URLs, please read the javadoc information for the Java
@@ -209,7 +209,7 @@
<code class="literal">org/apache/myproj/MyTypeSystem.xml</code> in the classpath or
datapath.</p>
- <p><a name="ugr.ref.xml.component_descriptor.datapath"></a>The datapath works similarly to the classpath but can be set programmatically
+ <p id="ugr.ref.xml.component_descriptor.datapath">The datapath works similarly to the classpath but can be set programmatically
through the resource manager API. Application developers can specify a datapath
during initialization, using the following code:
@@ -240,7 +240,7 @@ AnalysisEngine ae =
</div>
- <div class="section" title="2.3. Type System Descriptors"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.ref.xml.component_descriptor.type_system">2.3. Type System Descriptors</h2></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.type_system"><div class="titlepage"><div><div><h2 class="title" style="clear: both">2.3. Type System Descriptors</h2></div></div></div>
<p>A Type System Descriptor is used to define the types and features that can be
@@ -275,7 +275,7 @@ AnalysisEngine ae =
<p>All of the subelements are optional.</p>
- <div class="section" title="2.3.1. Imports"><div class="titlepage"><div><div><h3 class="title" id="ugr.ref.xml.component_descriptor.type_system.imports">2.3.1. Imports</h3></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.type_system.imports"><div class="titlepage"><div><div><h3 class="title">2.3.1. Imports</h3></div></div></div>
<p>The <code class="literal">imports</code> section allows this descriptor to import
@@ -284,7 +284,7 @@ AnalysisEngine ae =
imports are allowed.</p>
</div>
- <div class="section" title="2.3.2. Types"><div class="titlepage"><div><div><h3 class="title" id="ugr.ref.xml.component_descriptor.type_system.types">2.3.2. Types</h3></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.type_system.types"><div class="titlepage"><div><div><h3 class="title">2.3.2. Types</h3></div></div></div>
<p>The <code class="literal">types</code> element contains zero or more
@@ -312,7 +312,7 @@ AnalysisEngine ae =
Java). Namespaces beginning with uima are reserved and should not be used. Examples
of valid type names are:</p>
- <div class="itemizedlist"><ul class="itemizedlist" type="disc" compact><li class="listitem"><p>test.TokenAnnotation</p>
+ <div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc; "><li class="listitem"><p>test.TokenAnnotation</p>
</li><li class="listitem"><p>org.myorg.TokenAnnotation</p></li><li class="listitem"><p>com.my_company.proj123.TokenAnnotation </p></li></ul></div>
<p>These would all be considered distinct types since they have different
@@ -334,7 +334,7 @@ AnalysisEngine ae =
</div>
- <div class="section" title="2.3.3. Features"><div class="titlepage"><div><div><h3 class="title" id="ugr.ref.xml.component_descriptor.type_system.features">2.3.3. Features</h3></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.type_system.features"><div class="titlepage"><div><div><h3 class="title">2.3.3. Features</h3></div></div></div>
<p>The <code class="literal">features</code> element of a
@@ -399,7 +399,7 @@ uima.tcas.Annotation.</pre><p>
</div>
- <div class="section" title="2.3.4. String Subtypes"><div class="titlepage"><div><div><h3 class="title" id="ugr.ref.xml.component_descriptor.type_system.string_subtypes">2.3.4. String Subtypes</h3></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.type_system.string_subtypes"><div class="titlepage"><div><div><h3 class="title">2.3.4. String Subtypes</h3></div></div></div>
<p>There is one other special type that you can declare – a subset of the String
@@ -432,7 +432,7 @@ uima.tcas.Annotation.</pre><p>
</div>
</div>
- <div class="section" title="2.4. Analysis Engine Descriptors"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.ref.xml.component_descriptor.aes">2.4. Analysis Engine Descriptors</h2></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes"><div class="titlepage"><div><div><h2 class="title" style="clear: both">2.4. Analysis Engine Descriptors</h2></div></div></div>
<p>Analysis Engine (AE) descriptors completely describe Analysis Engines. There
@@ -447,10 +447,10 @@ uima.tcas.Annotation.</pre><p>
discusses Primitive Analysis Engine descriptors. <a class="xref" href="#ugr.ref.xml.component_descriptor.aes.aggregate" title="2.4.2. Aggregate Analysis Engine Descriptors">Section 2.4.2, “Aggregate Analysis Engine Descriptors”</a> then
describes how Aggregate Analysis Engine descriptors are different.</p>
- <div class="section" title="2.4.1. Primitive Analysis Engine Descriptors"><div class="titlepage"><div><div><h3 class="title" id="ugr.ref.xml.component_descriptor.aes.primitive">2.4.1. Primitive Analysis Engine Descriptors</h3></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.primitive"><div class="titlepage"><div><div><h3 class="title">2.4.1. Primitive Analysis Engine Descriptors</h3></div></div></div>
- <div class="section" title="2.4.1.1. Basic Structure"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.primitive.basic">2.4.1.1. Basic Structure</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.primitive.basic"><div class="titlepage"><div><div><h4 class="title">2.4.1.1. Basic Structure</h4></div></div></div>
@@ -514,7 +514,7 @@ uima.tcas.Annotation.</pre><p>
</div>
- <div class="section" title="2.4.1.2. Analysis Engine MetaData"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.metadata">2.4.1.2. Analysis Engine MetaData</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.metadata"><div class="titlepage"><div><div><h4 class="title">2.4.1.2. Analysis Engine MetaData</h4></div></div></div>
@@ -563,7 +563,7 @@ uima.tcas.Annotation.</pre><p>
</div>
- <div class="section" title="2.4.1.3. Type System Definition"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.type_system">2.4.1.3. Type System Definition</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.type_system"><div class="titlepage"><div><div><h4 class="title">2.4.1.3. Type System Definition</h4></div></div></div>
@@ -611,7 +611,7 @@ uima.tcas.Annotation.</pre><p>
<code class="literal">version</code>, and <code class="literal">types</code>.</p>
</div>
- <div class="section" title="2.4.1.4. Type Priority Definition"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.type_priority">2.4.1.4. Type Priority Definition</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.type_priority"><div class="titlepage"><div><div><h4 class="title">2.4.1.4. Type Priority Definition</h4></div></div></div>
@@ -680,7 +680,7 @@ uima.tcas.Annotation.</pre><p>
not; see the next section.</p>
</div>
- <div class="section" title="2.4.1.5. Index Definition"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.index">2.4.1.5. Index Definition</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.index"><div class="titlepage"><div><div><h4 class="title">2.4.1.5. Index Definition</h4></div></div></div>
@@ -787,12 +787,12 @@ uima.tcas.Annotation.</pre><p>
a JVM defined property,
"uima.allow_duplicate_add_to_indexes", which (if defined whend UIMA is loaded) will restore the previous behavior.</p>
- <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>If duplicates are allowed, then the proper way to update an indexed Feature Structure is to
- </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>remove <span class="bold"><strong>*all*</strong></span> instances of the FS to be
+ <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>If duplicates are allowed, then the proper way to update an indexed Feature Structure is to
+ </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>remove <span class="bold"><strong>*all*</strong></span> instances of the FS to be
updated </p></li><li class="listitem"><p>update the features</p></li><li class="listitem"><p>re-add the Feature Structure to the indexes (perhaps multiple times, depending on the
details of your logic).</p></li></ul></div></div>
- <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>There is usually no need to explicitly declare a Bag index in your descriptor.
+ <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>There is usually no need to explicitly declare a Bag index in your descriptor.
As of UIMA v2.1, if you do not declare any index for a type (or any of its
supertypes), a Bag index will be automatically created if an instance of that type is added to the indexes.</p></div>
@@ -834,7 +834,7 @@ uima.tcas.Annotation.</pre><p>
</div>
- <div class="section" title="2.4.1.6. Capabilities"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.capabilities">2.4.1.6. Capabilities</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.capabilities"><div class="titlepage"><div><div><h4 class="title">2.4.1.6. Capabilities</h4></div></div></div>
@@ -953,7 +953,7 @@ uima.tcas.Annotation.</pre><p>
</div>
- <div class="section" title="2.4.1.7. OperationalProperties"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.operational_properties">2.4.1.7. OperationalProperties</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.operational_properties"><div class="titlepage"><div><div><h4 class="title">2.4.1.7. OperationalProperties</h4></div></div></div>
<p>Components can specify specific operational properties that can be
@@ -975,7 +975,7 @@ uima.tcas.Annotation.</pre><p>
scale-out techniques. If it is not specified, the default value is true,
except for CAS Consumer and Collection Reader components.</p>
- <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>If you wrap one or more CAS Consumers inside an aggregate as the only
+ <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>If you wrap one or more CAS Consumers inside an aggregate as the only
components, you must explicitly specify in the aggregate the
<code class="literal">multipleDeploymentAllowed</code> property as false (assuming the CAS Consumer
components take the default here); otherwise the framework will complain about inconsistent
@@ -986,7 +986,7 @@ uima.tcas.Annotation.</pre><p>
smaller pieces. See <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.cm" class="olink">Chapter 7, <i>CAS Multiplier Developer's Guide</i></a> for details.</p>
</div>
- <div class="section" title="2.4.1.8. External Resource Dependencies"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.primitive.external_resource_dependencies">2.4.1.8. External Resource Dependencies</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.primitive.external_resource_dependencies"><div class="titlepage"><div><div><h4 class="title">2.4.1.8. External Resource Dependencies</h4></div></div></div>
@@ -1010,7 +1010,7 @@ uima.tcas.Annotation.</pre><p>
<code class="literal"><externalResourceDependency></code> elements. Each
dependency has the following elements:
- </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><code class="literal">key</code> – the
+ </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="literal">key</code> – the
string by which the annotator code will attempt to access the resource. Must
be unique within this annotator.</p></li><li class="listitem"><p><code class="literal">description</code> – a textual
description of the dependency.</p></li><li class="listitem"><p><code class="literal">interfaceName</code> – the
@@ -1023,7 +1023,7 @@ uima.tcas.Annotation.</pre><p>
</div>
- <div class="section" title="2.4.1.9. Resource Manager Configuration"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.primitive.resource_manager_configuration">2.4.1.9. Resource Manager Configuration</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.primitive.resource_manager_configuration"><div class="titlepage"><div><div><h4 class="title">2.4.1.9. Resource Manager Configuration</h4></div></div></div>
@@ -1073,7 +1073,7 @@ uima.tcas.Annotation.</pre><p>
more <code class="literal">externalResource</code> elements, each of which
consists of:
- </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><code class="literal">name</code> – the
+ </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="literal">name</code> – the
name of the resource. This name is referred to in the bindings (see below).
Resource names need to be unique within any Aggregate Analysis Engine or
Collection Processing Engine, so the Java-like
@@ -1143,7 +1143,7 @@ uima.tcas.Annotation.</pre><p>
which resources are bound to which dependencies. Each
<code class="literal">externalResourceBinding</code> consists of:
- </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><code class="literal">key</code> –
+ </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="literal">key</code> –
identifies the dependency. For a binding declared in a primitive analysis
engine descriptor, this must match the value of the
<code class="literal">key</code> element of one of the
@@ -1162,7 +1162,7 @@ uima.tcas.Annotation.</pre><p>
resource sharing.</p>
</div>
- <div class="section" title="2.4.1.10. Environment Variable References"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.environment_variable_references">2.4.1.10. Environment Variable References</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.environment_variable_references"><div class="titlepage"><div><div><h4 class="title">2.4.1.10. Environment Variable References</h4></div></div></div>
<p>In several places throughout the descriptor, it is possible to reference
@@ -1177,7 +1177,7 @@ uima.tcas.Annotation.</pre><p>
, where [VariableName] is any valid Java system property name. Environment
variable references are valid in the following places:
- </p><div class="itemizedlist"><ul class="itemizedlist" type="disc" compact><li class="listitem"><p>The value of a
+ </p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc; "><li class="listitem"><p>The value of a
configuration parameter (String-valued parameters only)</p>
</li><li class="listitem"><p>The
<code class="literal"><annotatorImplementationName></code> element
@@ -1194,7 +1194,7 @@ uima.tcas.Annotation.</pre><p>
<code class="literal">c:/temp</code>, then the configuration parameter's
value would evaluate to <code class="literal">c:/temp/temp.dat</code>.</p>
- <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>The Component Descriptor Editor does not support
+ <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>The Component Descriptor Editor does not support
environment variable references. If you need to, however, you
can use the <code class="code">source</code> tab view in the CDE to manually
add this notation.
@@ -1202,7 +1202,7 @@ uima.tcas.Annotation.</pre><p>
</div>
</div>
- <div class="section" title="2.4.2. Aggregate Analysis Engine Descriptors"><div class="titlepage"><div><div><h3 class="title" id="ugr.ref.xml.component_descriptor.aes.aggregate">2.4.2. Aggregate Analysis Engine Descriptors</h3></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.aggregate"><div class="titlepage"><div><div><h3 class="title">2.4.2. Aggregate Analysis Engine Descriptors</h3></div></div></div>
<p>Aggregate Analysis Engines do not contain an annotator, but instead
@@ -1212,7 +1212,7 @@ uima.tcas.Annotation.</pre><p>
<p>Aggregate Analysis Engine Descriptors maintain most of the same structure
as Primitive Analysis Engine Descriptors. The differences are:</p>
- <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>An Aggregate Analysis Engine Descriptor
+ <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>An Aggregate Analysis Engine Descriptor
contains the element
<code class="literal"><primitive>false</primitive></code> rather
than <code class="literal"><primitive>true</primitive></code>.
@@ -1246,7 +1246,7 @@ uima.tcas.Annotation.</pre><p>
<code class="literal"><sofaMappings></code>, may be included. </p>
</li></ul></div>
- <div class="section" title="2.4.2.1. Delegate Analysis Engine Specifiers"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.aggregate.delegates">2.4.2.1. Delegate Analysis Engine Specifiers</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.aggregate.delegates"><div class="titlepage"><div><div><h4 class="title">2.4.2.1. Delegate Analysis Engine Specifiers</h4></div></div></div>
@@ -1270,7 +1270,7 @@ uima.tcas.Annotation.</pre><p>
elements. Each of these must have a unique key, and must contain
either:</p>
- <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>A complete
+ <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>A complete
<code class="literal">analysisEngineDescription</code> element describing the
delegate analysis engine <span class="bold"><strong>OR</strong></span></p>
</li><li class="listitem"><p>An <code class="literal">import</code> element giving the name or
@@ -1279,7 +1279,7 @@ uima.tcas.Annotation.</pre><p>
<p>The latter is the much more common usage, and is the only form supported by
the Component Descriptor Editor tool.</p>
</div>
- <div class="section" title="2.4.2.2. FlowController"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.aggregate.flow_controller">2.4.2.2. FlowController</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.aggregate.flow_controller"><div class="titlepage"><div><div><h4 class="title">2.4.2.2. FlowController</h4></div></div></div>
@@ -1304,7 +1304,7 @@ uima.tcas.Annotation.</pre><p>
Descriptor Editor tool only supports imports here.</p>
</div>
- <div class="section" title="2.4.2.3. FlowConstraints"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.aggregate.flow_constraints">2.4.2.3. FlowConstraints</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.aggregate.flow_constraints"><div class="titlepage"><div><div><h4 class="title">2.4.2.3. FlowConstraints</h4></div></div></div>
<p>If a <code class="literal"><flowController></code> is not specified, the
@@ -1323,7 +1323,7 @@ uima.tcas.Annotation.</pre><p>
<code class="literal"><capabilityLanguageFlow></code>. Each is discussed
in a separate section below.</p>
- <div class="section" title="Fixed Flow"><div class="titlepage"><div><div><h5 class="title" id="ugr.ref.xml.component_descriptor.aes.aggregate.flow_constraints.fixed_flow">Fixed Flow</h5></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.aggregate.flow_constraints.fixed_flow"><div class="titlepage"><div><div><h5 class="title">Fixed Flow</h5></div></div></div>
@@ -1350,7 +1350,7 @@ uima.tcas.Annotation.</pre><p>
element.</p>
</div>
- <div class="section" title="Capability Language Flow"><div class="titlepage"><div><div><h5 class="title" id="ugr.ref.xml.component_descriptor.aes.aggregate.flow_constraints.capability_language_flow">Capability Language Flow</h5></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.aggregate.flow_constraints.capability_language_flow"><div class="titlepage"><div><div><h5 class="title">Capability Language Flow</h5></div></div></div>
@@ -1369,7 +1369,7 @@ uima.tcas.Annotation.</pre><p>
true (according to that Analysis Engine's declared output
capabilities):</p>
- <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>It cannot produce any of the aggregate
+ <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>It cannot produce any of the aggregate
Analysis Engine's output capabilities for the language of the
current document.</p></li><li class="listitem"><p>All of the output capabilities have already been
produced by an earlier Analysis Engine in the flow. </p></li></ul></div>
@@ -1379,14 +1379,14 @@ uima.tcas.Annotation.</pre><p>
the same language, these feature structures will only be produced by the
first annotator in the list.</p>
- <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>The flow analysis uses the specific types that are specified in the
+ <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>The flow analysis uses the specific types that are specified in the
output capabilities, without any expansion for subtypes. So, if you expect
a type TT and another type SubTT (which is a subtype of TT) in the output, you
must include both of them in the output capabilities.</p></div>
</div>
</div>
- <div class="section" title="2.4.2.4. External Resource Bindings"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.aggregate.external_resource_bindings">2.4.2.4. External Resource Bindings</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.aggregate.external_resource_bindings"><div class="titlepage"><div><div><h4 class="title">2.4.2.4. External Resource Bindings</h4></div></div></div>
<p>Aggregate analysis engine descriptors can declare resource bindings
@@ -1444,7 +1444,7 @@ uima.tcas.Annotation.</pre><p>
multiple levels deep to handle nested aggregate analysis engines.</p>
</div>
- <div class="section" title="2.4.2.5. Sofa Mappings"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.aggregate.sofa_mappings">2.4.2.5. Sofa Mappings</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.aggregate.sofa_mappings"><div class="titlepage"><div><div><h4 class="title">2.4.2.5. Sofa Mappings</h4></div></div></div>
<p>Sofa mappings are specified between Sofa names declared in this
@@ -1478,19 +1478,19 @@ uima.tcas.Annotation.</pre><p>
</div>
</div>
- <div class="section" title="2.4.3. Configuration Parameters"><div class="titlepage"><div><div><h3 class="title" id="ugr.ref.xml.component_descriptor.aes.configuration_parameters">2.4.3. Configuration Parameters</h3></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.configuration_parameters"><div class="titlepage"><div><div><h3 class="title">2.4.3. Configuration Parameters</h3></div></div></div>
<p>Configuration parameters may be declared and set in both Primitive and
Aggregate descriptors. Parameters set in an aggregate may override parameters set in one or
more of its delegates.
</p>
- <div class="section" title="2.4.3.1. Configuration Parameter Declaration"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.configuration_parameter_declaration">2.4.3.1. Configuration Parameter Declaration</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.configuration_parameter_declaration"><div class="titlepage"><div><div><h4 class="title">2.4.3.1. Configuration Parameter Declaration</h4></div></div></div>
<p>Configuration Parameters are made available to annotator
implementations and applications by the following interfaces:
- </p><div class="itemizedlist"><ul class="itemizedlist" type="circle" compact><li class="listitem" style="list-style-type: circle"><p>
- <code class="literal">AnnotatorContext</code> <sup>[<a name="d5e690" href="#ftn.d5e690" class="footnote">2</a>]</sup> (passed as an argument to the
+ </p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: circle; "><li class="listitem" style="list-style-type: circle"><p>
+ <code class="literal">AnnotatorContext</code> <a href="#ftn.d5e690" class="footnote"><sup class="footnote" id="d5e690">[2]</sup></a> (passed as an argument to the
initialize() method of a version 1 annotator)</p>
</li><li class="listitem" style="list-style-type: circle"><p>
<code class="literal">ConfigurableResource</code> (every Analysis Engine
@@ -1546,7 +1546,7 @@ uima.tcas.Annotation.</pre><p>
<p>For each configuration parameter, the following are specified:</p>
- <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><span class="bold"><strong>name</strong></span>
+ <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="bold"><strong>name</strong></span>
– the name by which the annotator code refers to the parameter. All
parameters declared in an analysis engine descriptor must have distinct names.
(required). The name is composed of normal Java identifier characters.</p>
@@ -1618,7 +1618,7 @@ uima.tcas.Annotation.</pre><p>
particular configuration group, if that group does not exist or does not contain
a value for the requested parameter. There are currently three possible values:
- </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><span class="bold"><strong>none</strong></span>
+ </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="bold"><strong>none</strong></span>
– there is no fallback; return null if there is no value in the exact group
specified by the user.</p></li><li class="listitem"><p><span class="bold"><strong>default_fallback</strong></span>
– if there is no value found in the specified group, look in the default
@@ -1632,7 +1632,7 @@ uima.tcas.Annotation.</pre><p>
<default>.</code> </p></li></ul></div><p>
</p>
- <div class="section" title="Example"><div class="titlepage"><div><div><h5 class="title" id="ugr.ref.xml.component_descriptor.aes.configuration_parameter_declaration.example">Example</h5></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.configuration_parameter_declaration.example"><div class="titlepage"><div><div><h5 class="title">Example</h5></div></div></div>
@@ -1684,7 +1684,7 @@ uima.tcas.Annotation.</pre><p>
</div>
</div>
- <div class="section" title="2.4.3.2. Configuration Parameter Settings"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.aes.configuration_parameter_settings">2.4.3.2. Configuration Parameter Settings</h4></div></div></div>
+ <div class="section" id="ugr.ref.aes.configuration_parameter_settings"><div class="titlepage"><div><div><h4 class="title">2.4.3.2. Configuration Parameter Settings</h4></div></div></div>
<p>For configuration parameters that are not part of any group, the
@@ -1748,7 +1748,7 @@ uima.tcas.Annotation.</pre><p>
<code class="literal"><configurationParameters></code> element and contains
the parameter settings for that group.</p>
- <div class="section" title="Example"><div class="titlepage"><div><div><h5 class="title" id="ugr.ref.xml.component_descriptor.aes.configuration_parameter_settings.example">Example</h5></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.configuration_parameter_settings.example"><div class="titlepage"><div><div><h5 class="title">Example</h5></div></div></div>
<p>Here are the settings that correspond to the parameter declarations in
@@ -1795,7 +1795,7 @@ uima.tcas.Annotation.</pre><p>
</div>
</div>
- <div class="section" title="2.4.3.3. Configuration Parameter Overrides"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.aggregate.configuration_parameter_overrides">2.4.3.3. Configuration Parameter Overrides</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.aggregate.configuration_parameter_overrides"><div class="titlepage"><div><div><h4 class="title">2.4.3.3. Configuration Parameter Overrides</h4></div></div></div>
<p>In an aggregate Analysis Engine Descriptor, each
@@ -1859,7 +1859,7 @@ uima.tcas.Annotation.</pre><p>
</div>
- <div class="section" title="2.4.3.4. External Configuration Parameter Overrides"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.external_configuration_parameter_overrides">2.4.3.4. External Configuration Parameter Overrides</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.external_configuration_parameter_overrides"><div class="titlepage"><div><div><h4 class="title">2.4.3.4. External Configuration Parameter Overrides</h4></div></div></div>
<p>
@@ -1933,7 +1933,7 @@ uima.tcas.Annotation.</pre><p>
These external settings consist of key - value pairs stored in a
file using the UTF-8 character encoding, and written in a style similar to that
of Java properties files.
- </p><div class="itemizedlist"><ul class="itemizedlist" type="circle" compact><li class="listitem" style="list-style-type: circle"><p>
+ </p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: circle; "><li class="listitem" style="list-style-type: circle"><p>
Leading whitespace is ignored.
</p></li><li class="listitem" style="list-style-type: circle"><p>
Comment lines start with '#' or '!'.
@@ -1992,7 +1992,7 @@ key9 : [ array element1\, with embedde
</p>
</div>
- <div class="section" title="2.4.3.5. Direct Access to External Configuration Parameters"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.external_configuration_parameter_access">2.4.3.5. Direct Access to External Configuration Parameters</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.external_configuration_parameter_access"><div class="titlepage"><div><div><h4 class="title">2.4.3.5. Direct Access to External Configuration Parameters</h4></div></div></div>
<p>
@@ -2030,7 +2030,7 @@ if (uimaContext != null) {
</p>
</div>
- <div class="section" title="2.4.3.6. Other Uses for External Configuration Parameters"><div class="titlepage"><div><div><h4 class="title" id="ugr.ref.xml.component_descriptor.aes.other_uses_for_external_configuration_parameters">2.4.3.6. Other Uses for External Configuration Parameters</h4></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.aes.other_uses_for_external_configuration_parameters"><div class="titlepage"><div><div><h4 class="title">2.4.3.6. Other Uses for External Configuration Parameters</h4></div></div></div>
<p>
Explicit references to shared configuration parameters can be specified as part of the
@@ -2044,7 +2044,7 @@ if (uimaContext != null) {
</div>
- <div class="section" title="2.5. Flow Controller Descriptors"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.ref.xml.component_descriptor.flow_controller">2.5. Flow Controller Descriptors</h2></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.flow_controller"><div class="titlepage"><div><div><h2 class="title" style="clear: both">2.5. Flow Controller Descriptors</h2></div></div></div>
<p>The basic structure of a Flow Controller Descriptor is as follows:
@@ -2089,7 +2089,7 @@ if (uimaContext != null) {
</div>
- <div class="section" title="2.6. Collection Processing Component Descriptors"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.ref.xml.component_descriptor.collection_processing_parts">2.6. Collection Processing Component Descriptors</h2></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.collection_processing_parts"><div class="titlepage"><div><div><h2 class="title" style="clear: both">2.6. Collection Processing Component Descriptors</h2></div></div></div>
<p>There are three types of Collection Processing Components – Collection
@@ -2097,7 +2097,7 @@ if (uimaContext != null) {
type of component has a corresponding descriptor. The structure of these descriptors
is very similar to that of primitive Analysis Engine Descriptors.</p>
- <div class="section" title="2.6.1. Collection Reader Descriptors"><div class="titlepage"><div><div><h3 class="title" id="ugr.ref.xml.component_descriptor.collection_processing_parts.collection_reader">2.6.1. Collection Reader Descriptors</h3></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.collection_processing_parts.collection_reader"><div class="titlepage"><div><div><h3 class="title">2.6.1. Collection Reader Descriptors</h3></div></div></div>
<p>The basic structure of a Collection Reader descriptor is as follows:
@@ -2181,7 +2181,7 @@ if (uimaContext != null) {
as in the Primitive Analysis Engine Descriptors (see <a class="xref" href="#ugr.ref.xml.component_descriptor.aes.primitive.external_resource_dependencies" title="2.4.1.8. External Resource Dependencies">Section 2.4.1.8, “External Resource Dependencies”</a> and <a class="xref" href="#ugr.ref.xml.component_descriptor.aes.primitive.resource_manager_configuration" title="2.4.1.9. Resource Manager Configuration">Section 2.4.1.9, “Resource Manager Configuration”</a>).</p>
</div>
- <div class="section" title="2.6.2. CAS Initializer Descriptors (deprecated)"><div class="titlepage"><div><div><h3 class="title" id="ugr.ref.xml.component_descriptor.collection_processing_parts.cas_initializer">2.6.2. CAS Initializer Descriptors (deprecated)</h3></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.collection_processing_parts.cas_initializer"><div class="titlepage"><div><div><h3 class="title">2.6.2. CAS Initializer Descriptors (deprecated)</h3></div></div></div>
<p>The basic structure of a CAS Initializer Descriptor is as follows:
@@ -2265,7 +2265,7 @@ if (uimaContext != null) {
as in the Primitive Analysis Engine Descriptors (see <a class="xref" href="#ugr.ref.xml.component_descriptor.aes.primitive.external_resource_dependencies" title="2.4.1.8. External Resource Dependencies">Section 2.4.1.8, “External Resource Dependencies”</a> and <a class="xref" href="#ugr.ref.xml.component_descriptor.aes.primitive.resource_manager_configuration" title="2.4.1.9. Resource Manager Configuration">Section 2.4.1.9, “Resource Manager Configuration”</a>).</p>
</div>
- <div class="section" title="2.6.3. CAS Consumer Descriptors"><div class="titlepage"><div><div><h3 class="title" id="ugr.ref.xml.component_descriptor.collection_processing_parts.cas_consumer">2.6.3. CAS Consumer Descriptors</h3></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.collection_processing_parts.cas_consumer"><div class="titlepage"><div><div><h3 class="title">2.6.3. CAS Consumer Descriptors</h3></div></div></div>
<p>The basic structure of a CAS Consumer Descriptor is as follows:
@@ -2322,7 +2322,7 @@ if (uimaContext != null) {
</div>
</div>
- <div class="section" title="2.7. Service Client Descriptors"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.ref.xml.component_descriptor.service_client">2.7. Service Client Descriptors</h2></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.service_client"><div class="titlepage"><div><div><h2 class="title" style="clear: both">2.7. Service Client Descriptors</h2></div></div></div>
<p>Service Client Descriptors specify only a location of a remote service. They are
@@ -2371,7 +2371,7 @@ if (uimaContext != null) {
<p>The parameters element is optional. If present, it can specify values for each
of the following:
</p>
- <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><code class="literal">VNS_HOST</code>: host name for the Vinci naming service.
+ <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="literal">VNS_HOST</code>: host name for the Vinci naming service.
</p></li><li class="listitem"><p><code class="literal">VNS_PORT</code>: port number for the Vinci naming service.
</p></li><li class="listitem"><p><code class="literal">GetMetaDataTimeout</code>: timeout period (in milliseconds) for
the GetMetaData call. If not specified, the default is 60 seconds. This may need
@@ -2392,7 +2392,7 @@ if (uimaContext != null) {
</div>
- <div class="section" title="2.8. Custom Resource Specifiers"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.ref.xml.component_descriptor.custom_resource_specifiers">2.8. Custom Resource Specifiers</h2></div></div></div>
+ <div class="section" id="ugr.ref.xml.component_descriptor.custom_resource_specifiers"><div class="titlepage"><div><div><h2 class="title" style="clear: both">2.8. Custom Resource Specifiers</h2></div></div></div>
<p>A Custom Resource Specifier allows you to plug in your own Java class as a UIMA Resource.
For example you can support a new service protocol by plugging in a Java class that implements
@@ -2426,10 +2426,10 @@ if (uimaContext != null) {
<code class="literal">getMetaData</code>, <code class="literal">processAndOutputNewCASes</code>,
<code class="literal">collectionProcessComplete</code>, and <code class="literal">destroy</code>.</p>
</div>
-<div class="footnotes"><br><hr width="100" align="left"><div class="footnote"><p><sup>[<a id="ftn.d5e71" href="#d5e71" class="para">1</a>] </sup>This component is deprecated and should not be use in new
- development.</p></div><div class="footnote"><p><sup>[<a id="ftn.d5e690" href="#d5e690" class="para">2</a>] </sup>Deprecated; use
+<div class="footnotes"><br><hr style="width:100; text-align:left;margin-left: 0"><div id="ftn.d5e71" class="footnote"><p><a href="#d5e71" class="para"><sup class="para">[1] </sup></a>This component is deprecated and should not be use in new
+ development.</p></div><div id="ftn.d5e690" class="footnote"><p><a href="#d5e690" class="para"><sup class="para">[2] </sup></a>Deprecated; use
UimaContext instead.</p></div></div></div>
- <div class="chapter" title="Chapter 3. Collection Processing Engine Descriptor Reference" id="ugr.ref.xml.cpe_descriptor"><div class="titlepage"><div><div><h2 class="title">Chapter 3. Collection Processing Engine Descriptor Reference</h2></div></div></div>
+ <div class="chapter" id="ugr.ref.xml.cpe_descriptor"><div class="titlepage"><div><div><h1 class="title">Chapter 3. Collection Processing Engine Descriptor Reference</h1></div></div></div>
@@ -2449,12 +2449,12 @@ if (uimaContext != null) {
tools, can be found 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.cpe" class="olink">Chapter 2, <i>Collection Processing Engine Developer's Guide</i></a>. Here we briefly summarize the CPE to define terms and
provide context for the later sections that describe the CPE Descriptor.</p>
- <div class="section" title="3.1. CPE Overview"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.ref.xml.cpe_descriptor.overview">3.1. CPE Overview</h2></div></div></div>
+ <div class="section" id="ugr.ref.xml.cpe_descriptor.overview"><div class="titlepage"><div><div><h2 class="title" style="clear: both">3.1. CPE Overview</h2></div></div></div>
- <div class="figure"><a name="ugr.ref.xml.cpe_descriptor.overview.fig.runtime"></a><div class="figure-contents">
+ <div class="figure" id="ugr.ref.xml.cpe_descriptor.overview.fig.runtime"><div class="figure-contents">
- <div class="mediaobject"><table border="0" summary="manufactured viewport for HTML img" cellspacing="0" cellpadding="0" width="574"><tr><td><img src="images/references/ref.xml.cpe_descriptor/image002.png" width="574" alt="CPE Runtime Overview diagram"></td></tr></table></div>
[... 1789 lines stripped ...]