blob: d113527354415638e66a960fe078fbf01c51e6f2 [file] [log] [blame]
<div element="book" href="#d0e2" number="" lang="en"><ttl>UIMA Overview &amp; SDK Setup</ttl><xreftext>UIMA Overview &amp; SDK Setup</xreftext><div element="chapter" href="#ugr.project_overview" number="1" targetptr="ugr.project_overview"><ttl>UIMA Overview</ttl><xreftext>Chapter 1, <i xmlns:xlink="http://www.w3.org/1999/xlink">UIMA Overview</i></xreftext><div element="section" href="#ugr.project_overview_doc_overview" number="1.1" targetptr="ugr.project_overview_doc_overview"><ttl>Apache UIMA Project Documentation Overview</ttl><xreftext>Section 1.1, “Apache UIMA Project Documentation Overview”</xreftext><div element="section" href="#ugr.project_overview_overview" number="1.1.1" targetptr="ugr.project_overview_overview"><ttl>Overviews</ttl><xreftext>Section 1.1.1, “Overviews”</xreftext></div><div element="section" href="#ugr.project_overview_setup" number="1.1.2" targetptr="ugr.project_overview_setup"><ttl>Eclipse Tooling Installation and Setup</ttl><xreftext>Section 1.1.2, “Eclipse Tooling Installation and Setup”</xreftext></div><div element="section" href="#ugr.project_overview_tutorials_dev_guides" number="1.1.3" targetptr="ugr.project_overview_tutorials_dev_guides"><ttl>Tutorials and Developer's Guides</ttl><xreftext>Section 1.1.3, “Tutorials and Developer's Guides”</xreftext><obj element="row" href="#ugr.project_overview_tutorial_annotator" number="" targetptr="ugr.project_overview_tutorial_annotator"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_tutorial_cpe" number="" targetptr="ugr.project_overview_tutorial_cpe"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_tutorial_application_development" number="" targetptr="ugr.project_overview_tutorial_application_development"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_guide_flow_controller" number="" targetptr="ugr.project_overview_guide_flow_controller"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_guide_multiple_sofas" number="" targetptr="ugr.project_overview_guide_multiple_sofas"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_guide_multiple_views" number="" targetptr="ugr.project_overview_guide_multiple_views"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_guide_cas_multiplier" number="" targetptr="ugr.project_overview_guide_cas_multiplier"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_xmi_emf" number="" targetptr="ugr.project_overview_xmi_emf"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj></div><div element="section" href="#ugr.project_overview_tool_guides" number="1.1.4" targetptr="ugr.project_overview_tool_guides"><ttl>Tools Users' Guides</ttl><xreftext>Section 1.1.4, “Tools Users' Guides”</xreftext><obj element="row" href="#ugr.project_overview_tools_component_descriptor_editor" number="" targetptr="ugr.project_overview_tools_component_descriptor_editor"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_tools_cpe_configurator" number="" targetptr="ugr.project_overview_tools_cpe_configurator"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_tools_pear_packager" number="" targetptr="ugr.project_overview_tools_pear_packager"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_tools_pear_installer" number="" targetptr="ugr.project_overview_tools_pear_installer"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_tools_pear_merger" number="" targetptr="ugr.project_overview_tools_pear_merger"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_tools_document_analyzer" number="" targetptr="ugr.project_overview_tools_document_analyzer"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_tools_cas_visual_debugger" number="" targetptr="ugr.project_overview_tools_cas_visual_debugger"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_tools_jcasgen" number="" targetptr="ugr.project_overview_tools_jcasgen"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_tools_xml_cas_viewer" number="" targetptr="ugr.project_overview_tools_xml_cas_viewer"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj></div><div element="section" href="#ugr.project_overview_reference" number="1.1.5" targetptr="ugr.project_overview_reference"><ttl>References</ttl><xreftext>Section 1.1.5, “References”</xreftext><obj element="row" href="#ugr.project_overview_javadocs" number="" targetptr="ugr.project_overview_javadocs"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_xml_ref_component_descriptor" number="" targetptr="ugr.project_overview_xml_ref_component_descriptor"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_xml_ref_collection_processing_engine_descriptor" number="" targetptr="ugr.project_overview_xml_ref_collection_processing_engine_descriptor"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_cas" number="" targetptr="ugr.project_overview_cas"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_jcas" number="" targetptr="ugr.project_overview_jcas"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_ref_pear" number="" targetptr="ugr.project_overview_ref_pear"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj><obj element="row" href="#ugr.project_overview_xmi_cas_serialization" number="" targetptr="ugr.project_overview_xmi_cas_serialization"><ttl>???TITLE???</ttl><xreftext>???</xreftext></obj></div></div><div element="section" href="#ugr.project_overview_doc_use" number="1.2" targetptr="ugr.project_overview_doc_use"><ttl>How to use the Documentation</ttl><xreftext>Section 1.2, “How to use the Documentation”</xreftext></div><div element="section" href="#ugr.project_overview_changes_from_previous" number="1.3" targetptr="ugr.project_overview_changes_from_previous"><ttl>Changes from Previous Versions</ttl><xreftext>Section 1.3, “Changes from Previous Versions”</xreftext><div element="section" href="#ugr.project_overview_changes_from_2_0" number="1.3.1" targetptr="ugr.project_overview_changes_from_2_0"><ttl>Changes from IBM UIMA 2.0 to Apache UIMA 2.1</ttl><xreftext>Section 1.3.1, “Changes from IBM UIMA 2.0 to Apache UIMA 2.1”</xreftext><div element="section" href="#ugr.project_overview.migration_utility.java_package_name_changes" number="1.3.1.1" targetptr="ugr.project_overview.migration_utility.java_package_name_changes"><ttl>Java Package Name Changes</ttl><xreftext>Section 1.3.1.1, “Java Package Name Changes”</xreftext></div><div element="section" href="#ugr.project_overview.migration_utility.xml_descriptor_changes" number="1.3.1.2" targetptr="ugr.project_overview.migration_utility.xml_descriptor_changes"><ttl>XML Descriptor Changes</ttl><xreftext>Section 1.3.1.2, “XML Descriptor Changes”</xreftext></div><div element="section" href="#ugr.project_overview.migration_utility.tcas_replaced_by_cas" number="1.3.1.3" targetptr="ugr.project_overview.migration_utility.tcas_replaced_by_cas"><ttl>TCAS replaced by CAS</ttl><xreftext>Section 1.3.1.3, “TCAS replaced by CAS”</xreftext></div><div element="section" href="#ugr.project_overview.migration_utility.jcas_interface" number="1.3.1.4" targetptr="ugr.project_overview.migration_utility.jcas_interface"><ttl>JCas Is Now an Interface</ttl><xreftext>Section 1.3.1.4, “JCas Is Now an Interface”</xreftext></div><div element="section" href="#ugr.project_overview.migration_utility.jar_files" number="1.3.1.5" targetptr="ugr.project_overview.migration_utility.jar_files"><ttl>JAR File names Have Changed</ttl><xreftext>Section 1.3.1.5, “JAR File names Have Changed”</xreftext></div><div element="section" href="#ugr.ovv.search_engine_repackaged" number="1.3.1.6" targetptr="ugr.ovv.search_engine_repackaged"><ttl>Semantic Search Engine Repackaged</ttl><xreftext>Section 1.3.1.6, “Semantic Search Engine Repackaged”</xreftext></div></div><div element="section" href="#ugr.project_overview_changes_from_v1" number="1.3.2" targetptr="ugr.project_overview_changes_from_v1"><ttl>Changes from UIMA Version 1.x</ttl><xreftext>Section 1.3.2, “Changes from UIMA Version 1.x”</xreftext><div element="section" href="#ugr.project_overview_new_capabilities" number="1.3.2.1" targetptr="ugr.project_overview_new_capabilities"><ttl>New Capabilities</ttl><xreftext>Section 1.3.2.1, “New Capabilities”</xreftext><obj element="formalpara" href="#ugr.project_overview_new_data_types" number="" targetptr="ugr.project_overview_new_data_types"><ttl>New Primitive data types</ttl><xreftext>New Primitive data types</xreftext></obj><obj element="formalpara" href="#ugr.ovv.simpler_aes_and_cases" number="" targetptr="ugr.ovv.simpler_aes_and_cases"><ttl>Simpler Analysis Engines and CASes</ttl><xreftext>Simpler Analysis Engines and CASes</xreftext></obj><obj element="formalpara" href="#ugr.ovv.sofas_and_cas_views_simplified" number="" targetptr="ugr.ovv.sofas_and_cas_views_simplified"><ttl>Sofas and CAS Views simplified</ttl><xreftext>Sofas and CAS Views simplified</xreftext></obj><obj element="formalpara" href="#ugr.ovv.ae_support_multiple_new_cases" number="" targetptr="ugr.ovv.ae_support_multiple_new_cases"><ttl>Analysis Component generalized to support multiple new CAS
outputs</ttl><xreftext>Analysis Component generalized to support multiple new CAS
outputs</xreftext></obj><obj element="formalpara" href="#ugr.ovv.user_customized_fc" number="" targetptr="ugr.ovv.user_customized_fc"><ttl>User-customized Flow Controllers</ttl><xreftext>User-customized Flow Controllers</xreftext></obj></div><div element="section" href="#ugr.ovv.other_changes" number="1.3.2.2" targetptr="ugr.ovv.other_changes"><ttl>Other Changes</ttl><xreftext>Section 1.3.2.2, “Other Changes”</xreftext><obj element="formalpara" href="#ugr.ovv.exceptions_rationalized" number="" targetptr="ugr.ovv.exceptions_rationalized"><ttl>UIMA Exceptions rationalized</ttl><xreftext>UIMA Exceptions rationalized</xreftext></obj><obj element="formalpara" href="#ugr.ovv.result_specification" number="" targetptr="ugr.ovv.result_specification"><ttl>Changes in Result Specifications</ttl><xreftext>Changes in Result Specifications</xreftext></obj><obj element="formalpara" href="#ugr.ovv.one_capability_set" number="" targetptr="ugr.ovv.one_capability_set"><ttl>Only one Capability Set</ttl><xreftext>Only one Capability Set</xreftext></obj></div><div element="section" href="#ugr.project_overview_backwards_compatibility" number="1.3.2.3" targetptr="ugr.project_overview_backwards_compatibility"><ttl>Backwards Compatibility</ttl><xreftext>Section 1.3.2.3, “Backwards Compatibility”</xreftext></div></div></div><div element="section" href="#ugr.project_overview_migrating_from_ibm_uima" number="1.4" targetptr="ugr.project_overview_migrating_from_ibm_uima"><ttl>Migrating from IBM UIMA to Apache UIMA</ttl><xreftext>Section 1.4, “Migrating from IBM UIMA to Apache UIMA”</xreftext><div element="section" href="#ugr.project_overview_running_the_migration_utility" number="1.4.1" targetptr="ugr.project_overview_running_the_migration_utility"><ttl>Running the Migration Utility</ttl><xreftext>Section 1.4.1, “Running the Migration Utility”</xreftext><div element="section" href="#ugr.project_overview_running_the_migration_utility.jcas_for_document_annotation" number="1.4.1.1" targetptr="ugr.project_overview_running_the_migration_utility.jcas_for_document_annotation"><ttl>JCas Cover Classes for DocumentAnnotation</ttl><xreftext>Section 1.4.1.1, “JCas Cover Classes for DocumentAnnotation”</xreftext></div><div element="section" href="#ugr.project_overview_running_the_migration_utility.manual_migration_needed.getdocumentannotation" number="1.4.1.2" targetptr="ugr.project_overview_running_the_migration_utility.manual_migration_needed.getdocumentannotation"><ttl>JCas.getDocumentAnnotation</ttl><xreftext>Section 1.4.1.2, “JCas.getDocumentAnnotation”</xreftext></div></div><div element="section" href="#ugr.project_overview_rare_migration" number="1.4.2" targetptr="ugr.project_overview_rare_migration"><ttl>Manual Migration</ttl><xreftext>Section 1.4.2, “Manual Migration”</xreftext><div element="section" href="#ugr.project_overview.manual_migration_needed.xiinclude" number="1.4.2.1" targetptr="ugr.project_overview.manual_migration_needed.xiinclude"><ttl>xi:include</ttl><xreftext>Section 1.4.2.1, “xi:include”</xreftext></div><div element="section" href="#ugr.project_overview.manual_migration_needed.duplicate_methods_cas_tcas" number="1.4.2.2" targetptr="ugr.project_overview.manual_migration_needed.duplicate_methods_cas_tcas"><ttl>Duplicate Methods Taking CAS and TCAS as Arguments</ttl><xreftext>Section 1.4.2.2, “Duplicate Methods Taking CAS and TCAS as Arguments”</xreftext></div><div element="section" href="#ugr.project_overview.manual_migration_needed.undocumented_methods" number="1.4.2.3" targetptr="ugr.project_overview.manual_migration_needed.undocumented_methods"><ttl>Use of Undocumented Methods from the com.ibm.uima.util package</ttl><xreftext>Section 1.4.2.3, “Undocumented Methods”</xreftext></div><div element="section" href="#ugr.project_overview.manual_migration_needed.uima_package_names_in_user_code" number="1.4.2.4" targetptr="ugr.project_overview.manual_migration_needed.uima_package_names_in_user_code"><ttl>Use of UIMA Package Names for User Code</ttl><xreftext>Section 1.4.2.4, “Package Names”</xreftext></div><div element="section" href="#ugr.project_overview.manual_migration_needed.exceptions_extend_uima_exceptions" number="1.4.2.5" targetptr="ugr.project_overview.manual_migration_needed.exceptions_extend_uima_exceptions"><ttl>CASException and CASRuntimeException now extend UIMA(Runtime)Exception</ttl><xreftext>Section 1.4.2.5, “Changes to CAS Exceptions”</xreftext></div></div></div><div element="section" href="#ugr.project_overview_summary" number="1.5" targetptr="ugr.project_overview_summary"><ttl>Apache UIMA Summary</ttl><xreftext>Section 1.5, “Apache UIMA Summary”</xreftext><div element="section" href="#ugr.ovv.summary.general" number="1.5.1" targetptr="ugr.ovv.summary.general"><ttl>General</ttl><xreftext>Section 1.5.1, “General”</xreftext></div><div element="section" href="#ugr.ovv.summary.programming_language_support" number="1.5.2" targetptr="ugr.ovv.summary.programming_language_support"><ttl>Programming Language Support</ttl><xreftext>Section 1.5.2, “Programming Language Support”</xreftext></div><div element="section" href="#ugr.ovv.general.summary.multi_modal_support" number="1.5.3" targetptr="ugr.ovv.general.summary.multi_modal_support"><ttl>Multi-Modal Support</ttl><xreftext>Section 1.5.3, “Multi-Modal Support”</xreftext></div><div element="section" href="#ugr.ovv.summary.general.semantic_search_components" number="1.5.4" targetptr="ugr.ovv.summary.general.semantic_search_components"><ttl>Semantic Search Components</ttl><xreftext>Section 1.5.4, “Semantic Search Components”</xreftext></div></div><div element="section" href="#ugr.project_overview_summary_sdk_capabilities" number="1.6" targetptr="ugr.project_overview_summary_sdk_capabilities"><ttl>Summary of Apache UIMA Capabilities</ttl><xreftext>Section 1.6, “Summary of Apache UIMA Capabilities”</xreftext></div></div><div element="chapter" href="#ugr.ovv.conceptual" number="2" targetptr="ugr.ovv.conceptual"><ttl>UIMA Conceptual Overview</ttl><xreftext>Chapter 2, <i xmlns:xlink="http://www.w3.org/1999/xlink">UIMA Conceptual Overview</i></xreftext><div element="section" href="#ugr.ovv.conceptual.uima_introduction" number="2.1" targetptr="ugr.ovv.conceptual.uima_introduction"><ttl>UIMA Introduction</ttl><xreftext>Section 2.1, “UIMA Introduction”</xreftext><obj element="figure" href="#ugr.ovv.conceptual.fig.bridge" number="2.1" targetptr="ugr.ovv.conceptual.fig.bridge"><ttl>UIMA helps you build the bridge between the unstructured and structured
worlds</ttl><xreftext>Figure 2.1, “UIMA helps you build the bridge between the unstructured and structured
worlds”</xreftext></obj></div><div element="section" href="#ugr.ovv.conceptual.architecture_framework_sdk" number="2.2" targetptr="ugr.ovv.conceptual.architecture_framework_sdk"><ttl>The Architecture, the Framework and the SDK</ttl><xreftext>Section 2.2, “The Architecture, the Framework and the SDK”</xreftext></div><div element="section" href="#ugr.ovv.conceptual.analysis_basics" number="2.3" targetptr="ugr.ovv.conceptual.analysis_basics"><ttl>Analysis Basics</ttl><xreftext>Section 2.3, “Analysis Basics”</xreftext><div element="section" href="#ugr.ovv.conceptual.aes_annotators_and_analysis_results" number="2.3.1" targetptr="ugr.ovv.conceptual.aes_annotators_and_analysis_results"><ttl>Analysis Engines, Annotators &amp; Results</ttl><xreftext>Section 2.3.1, “Analysis Engines, Annotators &amp; Results”</xreftext><obj element="figure" href="#ugr.ovv.conceptual.metadata_in_cas" number="2.2" targetptr="ugr.ovv.conceptual.metadata_in_cas"><ttl>Objects represented in the Common Analysis Structure (CAS)</ttl><xreftext>Figure 2.2, “Objects represented in the Common Analysis Structure (CAS)”</xreftext></obj></div><div element="section" href="#ugr.ovv.conceptual.representing_results_in_cas" number="2.3.2" targetptr="ugr.ovv.conceptual.representing_results_in_cas"><ttl>Representing Analysis Results in the CAS</ttl><xreftext>Section 2.3.2, “Representing Analysis Results in the CAS”</xreftext><div element="section" href="#ugr.ovv.conceptual.annotation_type" number="2.3.2.1" targetptr="ugr.ovv.conceptual.annotation_type"><ttl>The Annotation Type</ttl><xreftext>Section 2.3.2.1, “The Annotation Type”</xreftext></div><div element="section" href="#ugr.ovv.conceptual.not_just_annotations" number="2.3.2.2" targetptr="ugr.ovv.conceptual.not_just_annotations"><ttl>Not Just Annotations</ttl><xreftext>Section 2.3.2.2, “Not Just Annotations”</xreftext></div><div element="section" href="#ugr.ovv.conceptual.multiple_views_within_a_cas" number="2.3.2.3" targetptr="ugr.ovv.conceptual.multiple_views_within_a_cas"><ttl>Multiple Views within a CAS</ttl><xreftext>Section 2.3.2.3, “Multiple Views within a CAS”</xreftext></div></div><div element="section" href="#ugr.ovv.conceptual.interacting_with_cas_and_external_resources" number="2.3.3" targetptr="ugr.ovv.conceptual.interacting_with_cas_and_external_resources"><ttl>Interacting with the CAS and External Resources</ttl><xreftext>Section 2.3.3, “Using CASes and External Resources”</xreftext></div><div element="section" href="#ugr.ovv.conceptual.component_descriptors" number="2.3.4" targetptr="ugr.ovv.conceptual.component_descriptors"><ttl>Component Descriptors</ttl><xreftext>Section 2.3.4, “Component Descriptors”</xreftext></div></div><div element="section" href="#ugr.ovv.conceptual.aggregate_analysis_engines" number="2.4" targetptr="ugr.ovv.conceptual.aggregate_analysis_engines"><ttl>Aggregate Analysis Engines</ttl><xreftext>Section 2.4, “Aggregate Analysis Engines”</xreftext><obj element="figure" href="#ugr.ovv.conceptual.sample_aggregate" number="2.3" targetptr="ugr.ovv.conceptual.sample_aggregate"><ttl>Sample Aggregate Analysis Engine</ttl><xreftext>Figure 2.3, “Sample Aggregate Analysis Engine”</xreftext></obj></div><div element="section" href="#ugr.ovv.conceptual.applicaiton_building_and_collection_processing" number="2.5" targetptr="ugr.ovv.conceptual.applicaiton_building_and_collection_processing"><ttl>Application Building and Collection Processing</ttl><xreftext>Section 2.5, “Application Building and Collection Processing”</xreftext><div element="section" href="#ugr.ovv.conceptual.using_framework_from_an_application" number="2.5.1" targetptr="ugr.ovv.conceptual.using_framework_from_an_application"><ttl>Using the framework from an Application</ttl><xreftext>Section 2.5.1, “Using the framework from an Application”</xreftext><obj element="figure" href="#ugr.ovv.conceptual.application_factory_ae" number="2.4" targetptr="ugr.ovv.conceptual.application_factory_ae"><ttl>Using UIMA Framework to create and interact with an Analysis Engine</ttl><xreftext>Figure 2.4, “Using UIMA Framework to create and interact with an Analysis Engine”</xreftext></obj></div><div element="section" href="#ugr.ovv.conceptual.graduating_to_collection_processing" number="2.5.2" targetptr="ugr.ovv.conceptual.graduating_to_collection_processing"><ttl>Graduating to Collection Processing</ttl><xreftext>Section 2.5.2, “Graduating to Collection Processing”</xreftext><obj element="figure" href="#ugr.ovv.conceptual.fig.cpe" number="2.5" targetptr="ugr.ovv.conceptual.fig.cpe"><ttl>High-Level UIMA Component Architecture from Source to Sink</ttl><xreftext>Figure 2.5, “High-Level UIMA Component Architecture from Source to Sink”</xreftext></obj><obj element="figure" href="#ugr.ovv.conceptual.fig.cpm" number="2.6" targetptr="ugr.ovv.conceptual.fig.cpm"><ttl>Collection Processing Manager in UIMA Framework</ttl><xreftext>Figure 2.6, “Collection Processing Manager in UIMA Framework”</xreftext></obj></div></div><div element="section" href="#ugr.ovv.conceptual.exploiting_analysis_results" number="2.6" targetptr="ugr.ovv.conceptual.exploiting_analysis_results"><ttl>Exploiting Analysis Results</ttl><xreftext>Section 2.6, “Exploiting Analysis Results”</xreftext><div element="section" href="#ugr.ovv.conceptual.semantic_search" number="2.6.1" targetptr="ugr.ovv.conceptual.semantic_search"><ttl>Semantic Search</ttl><xreftext>Section 2.6.1, “Semantic Search”</xreftext></div><div element="section" href="#ugr.ovv.conceptual.databases" number="2.6.2" targetptr="ugr.ovv.conceptual.databases"><ttl>Databases</ttl><xreftext>Section 2.6.2, “Databases”</xreftext></div></div><div element="section" href="#ugr.ovv.conceptual.multimodal_processing" number="2.7" targetptr="ugr.ovv.conceptual.multimodal_processing"><ttl>Multimodal Processing in UIMA</ttl><xreftext>Section 2.7, “Multimodal Processing in UIMA”</xreftext><obj element="figure" href="#ugr.ovv.conceptual.fig.multiple_sofas" number="2.7" targetptr="ugr.ovv.conceptual.fig.multiple_sofas"><ttl>Multiple Sofas in support of multi-modal analysis of an audio Stream. Some
engines work on the audio “<span class="quote">view</span>”, some on the text
<span class="quote">view</span>” and some on both.</ttl><xreftext>Figure 2.7, “Multiple Sofas in support of multi-modal analysis of an audio Stream. Some
engines work on the audio “<span class="quote">view</span>”, some on the text
<span class="quote">view</span>” and some on both.”</xreftext></obj></div><div element="section" href="#ugr.ovv.conceptual.next_steps" number="2.8" targetptr="ugr.ovv.conceptual.next_steps"><ttl>Next Steps</ttl><xreftext>Section 2.8, “Next Steps”</xreftext></div></div><div element="chapter" href="#ugr.ovv.eclipse_setup" number="3" targetptr="ugr.ovv.eclipse_setup"><ttl>Setting up the Eclipse IDE to work with UIMA</ttl><xreftext>Chapter 3, <i xmlns:xlink="http://www.w3.org/1999/xlink">Setting up the Eclipse IDE to work with UIMA</i></xreftext><div element="section" href="#ugr.ovv.eclipse_setup.installation" number="3.1" targetptr="ugr.ovv.eclipse_setup.installation"><ttl>Installation</ttl><xreftext>Section 3.1, “Installation”</xreftext><div element="section" href="#ugr.ovv.eclipse_setup.install_eclipse" number="3.1.1" targetptr="ugr.ovv.eclipse_setup.install_eclipse"><ttl>Install Eclipse</ttl><xreftext>Section 3.1.1, “Install Eclipse”</xreftext></div><div element="section" href="#ugr.ovv.eclipse_setup.install_emf" number="3.1.2" targetptr="ugr.ovv.eclipse_setup.install_emf"><ttl>Install additional Eclipse component: EMF</ttl><xreftext>Section 3.1.2, “Install additional Eclipse component: EMF”</xreftext><div element="section" href="#ugr.ovv.eclipse_setup.install_emf_shortcut" number="3.1.2.1" targetptr="ugr.ovv.eclipse_setup.install_emf_shortcut"><ttl>EMF Installation Shortcut for Eclipse 3.2</ttl><xreftext>Section 3.1.2.1, “EMF Installation Shortcut for Eclipse 3.2”</xreftext></div></div><div element="section" href="#ugr.ovv.eclipse_setup.install_uima_sdk" number="3.1.3" targetptr="ugr.ovv.eclipse_setup.install_uima_sdk"><ttl>Install the UIMA SDK</ttl><xreftext>Section 3.1.3, “Install the UIMA SDK”</xreftext></div><div element="section" href="#ugr.ovv.eclipse_setup.install_uima_eclipse_plugins" number="3.1.4" targetptr="ugr.ovv.eclipse_setup.install_uima_eclipse_plugins"><ttl>Install the UIMA Eclipse Plugins</ttl><xreftext>Section 3.1.4, “Install the UIMA Eclipse Plugins”</xreftext></div><div element="section" href="#ugr.ovv.eclipse_setup.start_eclipse" number="3.1.5" targetptr="ugr.ovv.eclipse_setup.start_eclipse"><ttl>Start Eclipse</ttl><xreftext>Section 3.1.5, “Start Eclipse”</xreftext><div element="section" href="#ugr.ovv.eclipse_setup.special_startup_parameter_clean" number="3.1.5.1" targetptr="ugr.ovv.eclipse_setup.special_startup_parameter_clean"><ttl>Special startup parameter for Eclipse: -clean</ttl><xreftext>Section 3.1.5.1, “Special startup parameter for Eclipse: -clean”</xreftext></div></div></div><div element="section" href="#ugr.ovv.eclipse_setup.example_code" number="3.2" targetptr="ugr.ovv.eclipse_setup.example_code"><ttl>Setting up Eclipse to view Example Code</ttl><xreftext>Section 3.2, “Setting up Eclipse to view Example Code”</xreftext></div><div element="section" href="#ugr.ovv.eclipse_setup.adding_source" number="3.3" targetptr="ugr.ovv.eclipse_setup.adding_source"><ttl>Adding the UIMA source code to the jar files</ttl><xreftext>Section 3.3, “Adding the UIMA source code to the jar files”</xreftext></div><div element="section" href="#ugr.ovv.eclipse_setup.linking_uima_javadocs" number="3.4" targetptr="ugr.ovv.eclipse_setup.linking_uima_javadocs"><ttl>Attaching UIMA Javadocs</ttl><xreftext>Section 3.4, “Attaching UIMA Javadocs”</xreftext></div><div element="section" href="#ugr.ovv.eclipse_setup.running_external_tools_from_eclipse" number="3.5" targetptr="ugr.ovv.eclipse_setup.running_external_tools_from_eclipse"><ttl>Running external tools from Eclipse</ttl><xreftext>Section 3.5, “Running external tools from Eclipse”</xreftext></div></div><div element="chapter" href="#ugr.faqs" number="4" targetptr="ugr.faqs"><ttl>UIMA Frequently Asked Questions (FAQ's)</ttl><xreftext>Chapter 4, <i xmlns:xlink="http://www.w3.org/1999/xlink">UIMA Frequently Asked Questions (FAQ's)</i></xreftext><obj element="varlistentry" href="#ugr.faqs.what_is_uima" number="" targetptr="ugr.faqs.what_is_uima"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>What is UIMA?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.pronounce" number="" targetptr="ugr.faqs.pronounce"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>How do you pronounce UIMA?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.difference_apache_uima" number="" targetptr="ugr.faqs.difference_apache_uima"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>What's the difference between UIMA and the Apache UIMA?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.include_semantic_search" number="" targetptr="ugr.faqs.include_semantic_search"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>
Does UIMA include a semantic search engine?
</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.what_is_an_annotation" number="" targetptr="ugr.faqs.what_is_an_annotation"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>What is an Annotation?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.what_is_the_cas" number="" targetptr="ugr.faqs.what_is_the_cas"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>What is the CAS?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.what_does_the_cas_contain" number="" targetptr="ugr.faqs.what_does_the_cas_contain"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>What does the CAS contain?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.only_annotations" number="" targetptr="ugr.faqs.only_annotations"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>Does the CAS only contain Annotations?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.just_xml" number="" targetptr="ugr.faqs.just_xml"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>Is the CAS just XML?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.what_is_a_type_system" number="" targetptr="ugr.faqs.what_is_a_type_system"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>What is a Type System?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.what_is_a_sofa" number="" targetptr="ugr.faqs.what_is_a_sofa"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>What is a Sofa?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.annotator_versus_ae" number="" targetptr="ugr.faqs.annotator_versus_ae"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>What's the difference between an Annotator and an Analysis
Engine?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.web_services" number="" targetptr="ugr.faqs.web_services"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>Are UIMA analysis engines web services?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.stateless_aes" number="" targetptr="ugr.faqs.stateless_aes"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>Do Analysis Engines have to be
"stateless"?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.uddi" number="" targetptr="ugr.faqs.uddi"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>Is engine meta-data compatible with web services and
UDDI?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.scaling" number="" targetptr="ugr.faqs.scaling"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>How do you scale a UIMA application?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.embedding" number="" targetptr="ugr.faqs.embedding"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>What does it mean to embed UIMA in systems middleware?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.cpm_versus_cpe" number="" targetptr="ugr.faqs.cpm_versus_cpe"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>How is the CPM different from a CPE?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.semantic_search" number="" targetptr="ugr.faqs.semantic_search"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>What is Semantic Search and what is its relationship to
UIMA?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.xml_fragment_not_xml" number="" targetptr="ugr.faqs.xml_fragment_not_xml"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>Is an XML Fragment Query valid XML?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.modalities_other_than_text" number="" targetptr="ugr.faqs.modalities_other_than_text"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>Does UIMA support modalities other than text?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.compare" number="" targetptr="ugr.faqs.compare"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>How does UIMA compare to other similar work?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.open_source" number="" targetptr="ugr.faqs.open_source"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>Is UIMA Open Source?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.levels_required" number="" targetptr="ugr.faqs.levels_required"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>What Java level and OS are required for the UIMA SDK?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.building_apps_on_top_of_uima" number="" targetptr="ugr.faqs.building_apps_on_top_of_uima"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>Can I build my UIM application on top of UIMA?</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.faqs.commercial_products" number="" targetptr="ugr.faqs.commercial_products"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>Do any commercial products support the UIMA framework or include
it as part of their product?</strong></span></xreftext></obj></div><div element="chapter" href="#ugr.issues" number="5" targetptr="ugr.issues"><ttl>Known Issues</ttl><xreftext>Chapter 5, <i xmlns:xlink="http://www.w3.org/1999/xlink">Known Issues</i></xreftext><obj element="varlistentry" href="#ugr.issues.cr_to_xml" number="" targetptr="ugr.issues.cr_to_xml"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>Sun Java 1.4.2_12 doesn't serialize CR characters to XML</strong></span></xreftext></obj><obj element="varlistentry" href="#ugr.issues.jcasgen_java_1.4" number="" targetptr="ugr.issues.jcasgen_java_1.4"><ttl>???TITLE???</ttl><xreftext><span class="bold"><strong>JCasGen merge facility supports Java levels 1.4 or earlier</strong></span></xreftext></obj></div><obj element="glossary" href="#ugr.glossary" number="" targetptr="ugr.glossary"><ttl>Glossary: Key Terms &amp; Concepts</ttl><xreftext>Glossary</xreftext></obj><obj element="glossentry" href="#ugr.glossary.aggregate" number="" targetptr="ugr.glossary.aggregate"><ttl>Aggregate Analysis Engine</ttl><xreftext>Aggregate Analysis Engine</xreftext></obj><obj element="glossentry" href="#ugr.glossary.analysis_engine" number="" targetptr="ugr.glossary.analysis_engine"><ttl>Analysis Engine</ttl><xreftext>Analysis Engine</xreftext></obj><obj element="glossentry" href="#ugr.glossary.annotation" number="" targetptr="ugr.glossary.annotation"><ttl>Annotation</ttl><xreftext>Annotation</xreftext></obj><obj element="glossentry" href="#ugr.glossary.annotator" number="" targetptr="ugr.glossary.annotator"><ttl>Annotator</ttl><xreftext>Annotator</xreftext></obj><obj element="glossentry" href="#ugr.glossary.application" number="" targetptr="ugr.glossary.application"><ttl>Application</ttl><xreftext>Application</xreftext></obj><obj element="glossentry" href="#ugr.glossary.apache_uima_java_framework" number="" targetptr="ugr.glossary.apache_uima_java_framework"><ttl>Apache UIMA Java Framework</ttl><xreftext>Apache UIMA Java Framework</xreftext></obj><obj element="glossentry" href="#ugr.glossary.apache_uima_sdk" number="" targetptr="ugr.glossary.apache_uima_sdk"><ttl>Apache UIMA Software Development Kit (SDK)</ttl><xreftext>Apache UIMA Software Development Kit (SDK)</xreftext></obj><obj element="glossentry" href="#ugr.glossary.cas" number="" targetptr="ugr.glossary.cas"><ttl>CAS</ttl><xreftext>CAS</xreftext></obj><obj element="glossentry" href="#ugr.glossary.cas_consumer" number="" targetptr="ugr.glossary.cas_consumer"><ttl>CAS Consumer</ttl><xreftext>CAS Consumer</xreftext></obj><obj element="glossentry" href="#ugr.glossary.cas_initializer" number="" targetptr="ugr.glossary.cas_initializer"><ttl>CAS Initializer (deprecated)</ttl><xreftext>CAS Initializer (deprecated)</xreftext></obj><obj element="glossentry" href="#ugr.glossary.cas_multiplier" number="" targetptr="ugr.glossary.cas_multiplier"><ttl>CAS Multiplier</ttl><xreftext>CAS Multiplier</xreftext></obj><obj element="glossentry" href="#ugr.glossary.cas_processor" number="" targetptr="ugr.glossary.cas_processor"><ttl>CAS Processor</ttl><xreftext>CAS Processor</xreftext></obj><obj element="glossentry" href="#ugr.glossary.cas_view" number="" targetptr="ugr.glossary.cas_view"><ttl>CAS View</ttl><xreftext>CAS View</xreftext></obj><obj element="glossentry" href="#ugr.glossary.cde" number="" targetptr="ugr.glossary.cde"><ttl>CDE</ttl><xreftext>CDE</xreftext></obj><obj element="glossentry" href="#ugr.glossary.cpe" number="" targetptr="ugr.glossary.cpe"><ttl>Collection Processing Engine (CPE)</ttl><xreftext>Collection Processing Engine (CPE)</xreftext></obj><obj element="glossentry" href="#ugr.glossary.cpm" number="" targetptr="ugr.glossary.cpm"><ttl>Collection Processing Manager (CPM)</ttl><xreftext>Collection Processing Manager (CPM)</xreftext></obj><obj element="glossentry" href="#ugr.glossary.collection_reader" number="" targetptr="ugr.glossary.collection_reader"><ttl>Collection Reader</ttl><xreftext>Collection Reader</xreftext></obj><obj element="glossentry" href="#ugr.glossary.fact_search" number="" targetptr="ugr.glossary.fact_search"><ttl>Fact Search</ttl><xreftext>Fact Search</xreftext></obj><obj element="glossentry" href="#ugr.glossary.feature" number="" targetptr="ugr.glossary.feature"><ttl>Feature</ttl><xreftext>Feature</xreftext></obj><obj element="glossentry" href="#ugr.glossary.flow_controller" number="" targetptr="ugr.glossary.flow_controller"><ttl>Flow Controller</ttl><xreftext>Flow Controller</xreftext></obj><obj element="glossentry" href="#ugr.glossary.hybrid_analysis_engine" number="" targetptr="ugr.glossary.hybrid_analysis_engine"><ttl>Hybrid Analysis Engine</ttl><xreftext>Hybrid Analysis Engine</xreftext></obj><obj element="glossentry" href="#ugr.glossary.index" number="" targetptr="ugr.glossary.index"><ttl>Index</ttl><xreftext>Index</xreftext></obj><obj element="glossentry" href="#ugr.glossary.jcas" number="" targetptr="ugr.glossary.jcas"><ttl>JCas</ttl><xreftext>JCas</xreftext></obj><obj element="glossentry" href="#ugr.glossary.keyword_search" number="" targetptr="ugr.glossary.keyword_search"><ttl>Keyword Search</ttl><xreftext>Keyword Search</xreftext></obj><obj element="glossentry" href="#ugr.glossary.knowledge_base" number="" targetptr="ugr.glossary.knowledge_base"><ttl>Knowledge Base</ttl><xreftext>Knowledge Base</xreftext></obj><obj element="glossentry" href="#ugr.glossary.loosely_coupled_analysis_engine" number="" targetptr="ugr.glossary.loosely_coupled_analysis_engine"><ttl>Loosely-Coupled Analysis Engine</ttl><xreftext>Loosely-Coupled Analysis Engine</xreftext></obj><obj element="glossentry" href="#ugr.glossary.ontology" number="" targetptr="ugr.glossary.ontology"><ttl/><xreftext/></obj><obj element="glossentry" href="#ugr.glossary.pear" number="" targetptr="ugr.glossary.pear"><ttl>PEAR</ttl><xreftext>PEAR</xreftext></obj><obj element="glossentry" href="#ugr.glossary.primitive_analysis_engine" number="" targetptr="ugr.glossary.primitive_analysis_engine"><ttl>Primitive Analysis Engine</ttl><xreftext>Primitive Analysis Engine</xreftext></obj><obj element="glossentry" href="#ugr.glossary.semantic_search" number="" targetptr="ugr.glossary.semantic_search"><ttl>Semantic Search</ttl><xreftext>Semantic Search</xreftext></obj><obj element="glossentry" href="#ugr.glossary.structured_information" number="" targetptr="ugr.glossary.structured_information"><ttl>Structured Information</ttl><xreftext>Structured Information</xreftext></obj><obj element="glossentry" href="#ugr.glossary.sofa" number="" targetptr="ugr.glossary.sofa"><ttl>Subject of Analysis (Sofa)</ttl><xreftext>Subject of Analysis (Sofa)</xreftext></obj><obj element="glossentry" href="#ugr.glossary.tightly_coupled_analysis_engine" number="" targetptr="ugr.glossary.tightly_coupled_analysis_engine"><ttl>Tightly-Coupled Analysis Engine</ttl><xreftext>Tightly-Coupled Analysis Engine</xreftext></obj><obj element="glossentry" href="#ugr.glossary.type" number="" targetptr="ugr.glossary.type"><ttl>Type</ttl><xreftext>Type</xreftext></obj><obj element="glossentry" href="#ugr.glossary.type_system" number="" targetptr="ugr.glossary.type_system"><ttl>Type System</ttl><xreftext>Type System</xreftext></obj><obj element="glossentry" href="#ugr.glossary.unstructured_information" number="" targetptr="ugr.glossary.unstructured_information"><ttl>Unstructured Information</ttl><xreftext>Unstructured Information</xreftext></obj><obj element="glossentry" href="#ugr.glossary.uima" number="" targetptr="ugr.glossary.uima"><ttl>UIMA</ttl><xreftext>UIMA</xreftext></obj><obj element="glossentry" href="#ugr.glossary.uima_java_framework" number="" targetptr="ugr.glossary.uima_java_framework"><ttl>UIMA Java Framework</ttl><xreftext>UIMA Java Framework</xreftext></obj><obj element="glossentry" href="#ugr.glossary.uima_sdk" number="" targetptr="ugr.glossary.uima_sdk"><ttl>UIMA SDK</ttl><xreftext>UIMA SDK</xreftext></obj><obj element="glossentry" href="#ugr.glossary.xcas" number="" targetptr="ugr.glossary.xcas"><ttl>XCAS</ttl><xreftext>XCAS</xreftext></obj><obj element="glossentry" href="#ugr.glossary.xmi" number="" targetptr="ugr.glossary.xmi"><ttl>XML Metadata Interchange (XMI)</ttl><xreftext>XML Metadata Interchange (XMI)</xreftext></obj></div>