Modified: uima/site/trunk/uima-website/docs/d/uimaj-current/tutorials_and_users_guides.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimaj-current/tutorials_and_users_guides.html?rev=1904950&r1=1904949&r2=1904950&view=diff ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimaj-current/tutorials_and_users_guides.html (original) +++ uima/site/trunk/uima-website/docs/d/uimaj-current/tutorials_and_users_guides.html Mon Oct 31 13:15:29 2022 @@ -2,7 +2,7 @@ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>UIMA Tutorial and Developers' Guides</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 Tutorial and Developers' Guides" id="d5e1"><div xmlns:d="http://docbook.org/ns/docbook"; class="titlepage"><div><div><h1 class="title">UIMA Tutorial and Developers' Guides</h1></div><div><div class="authorgroup"> <h3 class="corpauthor">Written and maintained by the Apache UIMA™ Development Community</h3> - </div></div><div><p class="releaseinfo">Version 3.3.0</p></div><div><p class="copyright">Copyright © 2006, 2022 The Apache Software Foundation</p></div><div><p class="copyright">Copyright © 2004, 2006 International Business Machines Corporation</p></div><div><div class="legalnotice" title="Legal Notice"><a name="d5e8"></a> + </div></div><div><p class="releaseinfo">Version 3.3.1</p></div><div><p class="copyright">Copyright © 2006, 2022 The Apache Software Foundation</p></div><div><p class="copyright">Copyright © 2004, 2006 International Business Machines Corporation</p></div><div><div class="legalnotice" title="Legal Notice"><a name="d5e8"></a> <p> </p> <p title="License and Disclaimer"> <b>License and Disclaimer. </b> @@ -35,7 +35,7 @@ the trademark or service mark. </p> - </div></div><div><p class="pubdate">April, 2022</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#ugr.tug.aae">1. Annotator & AE Developer's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.aae.getting_started">1.1. Getting Started</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.aae.defining_types">1.1.1. Defining Types</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.generating_jcas_sources">1.1.2. Generating Java Source Files for CAS Types</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.developing_annotator_code">1.1.3. Developing Your Annotator Code</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.creating_xml_descriptor">1.1.4. Creating the XML Descriptor</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.testing_your_annotator">1.1.5. Testing Your Annotator</a></span></dt></dl></dd><dt><span class="section"><a h ref="#ugr.tug.aae.configuration_logging">1.2. Configuration and Logging</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.aae.configuration_parameters">1.2.1. Configuration Parameters</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.logging">1.2.2. Logging</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.aae.building_aggregates">1.3. Building Aggregate Analysis Engines</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.aae.combining_annotators">1.3.1. Combining Annotators</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.aaes_can_contain_cas_consumers">1.3.2. AAEs can also contain CAS Consumers</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.reading_results_previous_annotators">1.3.3. Reading the Results of Previous Annotators</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.aae.other_examples">1.4. Other examples</a></span></dt><dt><span class="section"><a href="#ugr.t ug.aae.additional_topics">1.5. Additional Topics</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.aae.contract_for_annotator_methods">1.5.1. Annotator Methods</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.reporting_errors_from_annotators">1.5.2. Reporting errors from Annotators</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.throwing_exceptions_from_annotators">1.5.3. Throwing Exceptions from Annotators</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.accessing_external_resource_files">1.5.4. Accessing External Resources</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.result_specification_setting">1.5.5. Result Specifications</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.classpath_when_using_jcas">1.5.6. Class path setup when using JCas</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.using_shell_scripts">1.5.7. Using the Shell Scripts</a></span></dt></dl></dd><dt><span clas s="section"><a href="#ugr.tug.aae.common_pitfalls">1.6. Common Pitfalls</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.viewing_UIMA_objects_in_eclipse_debugger">1.7. UIMA Objects in Eclipse Debugger</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.xml_intro_ae_descriptor">1.8. Analysis Engine XML Descriptor</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.aae.header_annotator_class_identification">1.8.1. Header and Annotator Class Identification</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.xml_intro_simple_metadata_attributes">1.8.2. Simple Metadata Attributes</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.xml_intro_type_system_definition">1.8.3. Type System Definition</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.xml_intro_capabilities">1.8.4. Capabilities</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.xml_intro.configuration_parameters">1.8.5. Configuration Parameters (Optional)</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#ugr.tug.cpe">2. CPE Developer's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.cpe.concepts">2.1. CPE Concepts</a></span></dt><dt><span class="section"><a href="#ugr.tug.cpe.configurator_and_viewer">2.2. CPE Configurator and CAS viewer</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.cpe.cpe_configurator">2.2.1. Using the CPE Configurator</a></span></dt><dt><span class="section"><a href="#ugr.tug.cpe.running_cpe_configurator_from_eclipse">2.2.2. Running the CPE Configurator from Eclipse</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.cpe.running_cpe_from_application">2.3. Running a CPE from Your Own Java Application</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.cpe.using_listeners">2.3.1. Using Listeners</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.cpe.developing_collection_processing_componen ts">2.4. Developing Collection Processing Components</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.cpe.collection_reader.developing">2.4.1. Developing Collection Readers</a></span></dt><dt><span class="section"><a href="#ugr.tug.cpe.cas_initializer.developing">2.4.2. Developing CAS + </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.tug.aae">1. Annotator & AE Developer's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.aae.getting_started">1.1. Getting Started</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.aae.defining_types">1.1.1. Defining Types</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.generating_jcas_sources">1.1.2. Generating Java Source Files for CAS Types</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.developing_annotator_code">1.1.3. Developing Your Annotator Code</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.creating_xml_descriptor">1.1.4. Creating the XML Descriptor</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.testing_your_annotator">1.1.5. Testing Your Annotator</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.aae.configuration_logging">1.2. Configuration and Logging</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.aae.configuration_parameters">1.2.1. Configuration Parameters</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.logging">1.2.2. Logging</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.aae.building_aggregates">1.3. Building Aggregate Analysis Engines</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.aae.combining_annotators">1.3.1. Combining Annotators</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.aaes_can_contain_cas_consumers">1.3.2. AAEs can also contain CAS Consumers</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.reading_results_previous_annotators">1.3.3. Reading the Results of Previous Annotators</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.aae.other_examples">1.4. Other examples</a></span></dt><dt><span class="section"><a href="#ugr .tug.aae.additional_topics">1.5. Additional Topics</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.aae.contract_for_annotator_methods">1.5.1. Annotator Methods</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.reporting_errors_from_annotators">1.5.2. Reporting errors from Annotators</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.throwing_exceptions_from_annotators">1.5.3. Throwing Exceptions from Annotators</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.accessing_external_resource_files">1.5.4. Accessing External Resources</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.result_specification_setting">1.5.5. Result Specifications</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.classpath_when_using_jcas">1.5.6. Class path setup when using JCas</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.using_shell_scripts">1.5.7. Using the Shell Scripts</a></span></dt></dl></dd><dt><span cl ass="section"><a href="#ugr.tug.aae.common_pitfalls">1.6. Common Pitfalls</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.viewing_UIMA_objects_in_eclipse_debugger">1.7. UIMA Objects in Eclipse Debugger</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.xml_intro_ae_descriptor">1.8. Analysis Engine XML Descriptor</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.aae.header_annotator_class_identification">1.8.1. Header and Annotator Class Identification</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.xml_intro_simple_metadata_attributes">1.8.2. Simple Metadata Attributes</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.xml_intro_type_system_definition">1.8.3. Type System Definition</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.xml_intro_capabilities">1.8.4. Capabilities</a></span></dt><dt><span class="section"><a href="#ugr.tug.aae.xml_intro.configuration_parameters">1.8.5. Configuration Paramete rs (Optional)</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#ugr.tug.cpe">2. CPE Developer's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.cpe.concepts">2.1. CPE Concepts</a></span></dt><dt><span class="section"><a href="#ugr.tug.cpe.configurator_and_viewer">2.2. CPE Configurator and CAS viewer</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.cpe.cpe_configurator">2.2.1. Using the CPE Configurator</a></span></dt><dt><span class="section"><a href="#ugr.tug.cpe.running_cpe_configurator_from_eclipse">2.2.2. Running the CPE Configurator from Eclipse</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.cpe.running_cpe_from_application">2.3. Running a CPE from Your Own Java Application</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.cpe.using_listeners">2.3.1. Using Listeners</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.cpe.developing_collection_processing_compon ents">2.4. Developing Collection Processing Components</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.cpe.collection_reader.developing">2.4.1. Developing Collection Readers</a></span></dt><dt><span class="section"><a href="#ugr.tug.cpe.cas_initializer.developing">2.4.2. Developing CAS Initializers</a></span></dt><dt><span class="section"><a href="#ugr.tug.cpe.cas_consumer.developing">2.4.3. Developing CAS Consumers</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.cpe.deploying_a_cpe">2.5. Deploying a CPE</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.cpe.managed_deployment">2.5.1. Deploying Managed CAS Processors</a></span></dt><dt><span class="section"><a href="#ugr.tug.cpe.deploying_nonmanaged_cas_processors">2.5.2. Deploying Non-managed CAS Processors</a></span></dt><dt><span class="section"><a href="#ugr.tug.cpe.integrated_deployment">2.5.3. Deploying Integrated CAS Processors</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.cpe.collection_processing_examples">2.6. Collection Processing Examples</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tug.application">3. Application Developer's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.appication.uimaframework_class">3.1. The UIMAFramework Class</a></span></dt><dt><span class="section"><a href="#ugr.tug.application.using_aes"> 3.2. Using Analysis Engines</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.application.instantiating_an_ae">3.2.1. Instantiating an Analysis Engine</a></span></dt><dt><span class="section"><a href="#ugr.tug.application.analyzing_text_documents">3.2.2. Analyzing Text Documents</a></span></dt><dt><span class="section"><a href="#ugr.tug.applications.analyzing_non_text_artifacts">3.2.3. Analyzing Non-Text Artifacts</a></span></dt><dt><span class="section"><a href="#ugr.tug.applications.accessing_analysis_results">3.2.4. Accessing Analysis Results</a></span></dt><dt><span class="section"><a href="#ugr.tug.applications.multi_threaded">3.2.5. Multi-threaded Applications</a></span></dt><dt><span class="section"><a href="#ugr.tug.application.using_multiple_aes">3.2.6. Multiple AEs & Creating Shared CASes</a></span></dt><dt><span class="section"><a href="#ugr.tug.application.saving_cases_to_file_systems">3.2.7. Saving CASes to file systems or general Streams</a></span> </dt></dl></dd><dt><span class="section"><a href="#ugr.tug.application.using_cpes">3.3. Using Collection Processing Engines</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.application.running_a_cpe_from_a_descriptor">3.3.1. Running a CPE from a Descriptor</a></span></dt><dt><span class="section"><a href="#ugr.tug.application.configuring_a_cpe_descriptor_programmatically">3.3.2. Configuring a CPE Descriptor Programmatically</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.application.setting_configuration_parameters">3.4. Setting Configuration Parameters</a></span></dt><dt><span class="section"><a href="#ugr.tug.application.integrating_text_analysis_and_search">3.5. Integrating Text Analysis and Search</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.application.building_an_index">3.5.1. Building an Index</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.application.remote_services">3.6. Working with Remote S ervices</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.application.how_to_deploy_a_vinci_service">3.6.1. Deploying as a Vinci Service</a></span></dt><dt><span class="section"><a href="#ugr.tug.application.how_to_call_a_uima_service">3.6.2. Calling a UIMA Service</a></span></dt><dt><span class="section"><a href="#ugr.tug.application.restrictions_on_remotely_deployed_services">3.6.3. Restrictions on remotely deployed services</a></span></dt><dt><span class="section"><a href="#ugr.tug.application.vns">3.6.4. The Vinci Naming Services (VNS)</a></span></dt><dt><span class="section"><a href="#ugr.tug.configuring_timeout_settings">3.6.5. Configuring Timeout Settings</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.application.increasing_performance_using_parallelism">3.7. Increasing performance using parallelism</a></span></dt><dt><span class="section"><a href="#ugr.tug.application.jmx">3.8. Monitoring AE Performance using JMX</a></span></dt><dt><spa n class="section"><a href="#tug.application.pto">3.9. Performance Tuning Options</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tug.fc">4. Flow Controller Developer's Guide</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.fc.developing_fc_code">4.1. Developing the Flow Controller Code</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.fc.fc_interface_overview">4.1.1. Flow Controller Interface Overview</a></span></dt><dt><span class="section"><a href="#ugr.tug.fc.example_code">4.1.2. Example Code</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.fc.creating_fc_descriptor">4.2. Creating the Flow Controller Descriptor</a></span></dt><dt><span class="section"><a href="#ugr.tug.fc.adding_fc_to_aggregate">4.3. Adding Flow Controller to an Aggregate</a></span></dt><dt><span class="section"><a href="#ugr.tug.fc.adding_fc_to_cpe">4.4. Adding Flow Controller to CPE</a></span></dt><dt><span class="section"><a href="#ugr.tug .fc.using_fc_with_cas_multipliers">4.5. Using Flow Controllers with CAS Multipliers</a></span></dt><dt><span class="section"><a href="#ugr.tug.fc.continuing_when_exceptions_occur">4.6. Continuing the Flow When Exceptions Occur</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tug.aas">5. Annotations, Artifacts & Sofas</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.aas.terminology">5.1. Terminology</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.aas.artifact">5.1.1. Artifact</a></span></dt><dt><span class="section"><a href="#ugr.tug.aas.sofa">5.1.2. Subject of Analysis — Sofa</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.aas.sofa_data_formats">5.2. Formats of Sofa Data</a></span></dt><dt><span class="section"><a href="#ugr.tug.aas.setting_accessing_sofa_data">5.3. Setting and Accessing Sofa Data</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.aas.setting_sofa_data">5.3.1. Setting Sofa Data</a></span></dt><dt><span class="section"><a href="#ugr.tug.aas.accessing_sofa_data">5.3.2. Accessing Sofa Data</a></span></dt><dt><span class="section"><a href="#ugr.tug.aas.accessing_sofa_data_using_java_stream">5.3.3. Accessing Sofa Data using a Java Stream</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.aas.sofa_fs">5.4. The Sofa Feature Structure</a></span></dt><dt><span class="section"><a href="#ugr.tug.aas.annotations">5.5. Annotations</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.aas.built_in_annotation_types">5.5.1. Built-in Annotation types</a></span></dt><dt><span class="section"><a href="#ugr.tug.aas.annotations_associated_sofa">5.5.2. Annotations have an associated Sofa</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.aas.annotationbase">5.6. AnnotationBase</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tug.mvs">6. Multiple CAS Views</a></span></dt><dd><dl><dt><span class="section" ><a href="#ugr.tug.mvs.cas_views_and_sofas">6.1. CAS Views and >Sofas</a></span></dt><dd><dl><dt><span class="section"><a >href="#ugr.tug.mvs.naming_views_sofas">6.1.1. Naming CAS Views and >Sofas</a></span></dt><dt><span class="section"><a >href="#ugr.tug.mvs.multi_view_and_single_view">6.1.2. Multi/Single View parts >in Applications</a></span></dt></dl></dd><dt><span class="section"><a >href="#ugr.tug.mvs.multi_view_components">6.2. Multi-View >Components</a></span></dt><dd><dl><dt><span class="section"><a >href="#ugr.tug.mvs.deciding_multi_view">6.2.1. Deciding: >Multi-View</a></span></dt><dt><span class="section"><a >href="#ugr.tug.mvs.additional_capabilities">6.2.2. Multi-View: additional >capabilities</a></span></dt><dt><span class="section"><a >href="#ugr.tug.mvs.component_xml_metadata">6.2.3. Component XML >metadata</a></span></dt></dl></dd><dt><span class="section"><a >href="#ugr.tug.mvs.sofa_capabilities_and_apis_for_apps">6.3. Sofa >Capabilities & APIs for Apps</a></span></dt><dt><s pan class="section"><a href="#ugr.tug.mvs.sofa_name_mapping">6.4. Sofa Name Mapping</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.mvs.name_mapping_aggregate">6.4.1. Name Mapping in an Aggregate Descriptor</a></span></dt><dt><span class="section"><a href="#ugr.tug.mvs.name_mapping_cpe">6.4.2. Name Mapping in a CPE Descriptor</a></span></dt><dt><span class="section"><a href="#ugr.tug.mvs.specifying_cas_view_for_process">6.4.3. CAS View received by Process</a></span></dt><dt><span class="section"><a href="#ugr.tug.mvs.name_mapping_application">6.4.4. Name Mapping in a UIMA Application</a></span></dt><dt><span class="section"><a href="#ugr.tug.mvs.name_mapping_remote_services">6.4.5. Name Mapping for Remote Services</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.mvs.jcas_extensions_for_multi_views">6.5. JCas extensions for Multiple Views</a></span></dt><dt><span class="section"><a href="#ugr.tug.mvs.sample_application">6.6. Sample Multi-View Application</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.mvs.sample_application.descriptor">6.6.1. Annotator Descriptor</a></span></dt><dt><span class="section"><a href="#ugr.tug.mvs.sample_application.setup">6.6.2. Application Setup</a></span></dt><dt><span class="section"><a href="#ugr.tug.mvs.sample_applic ation.annotator_processing">6.6.3. Annotator Processing</a></span></dt><dt><span class="section"><a href="#ugr.tug.mvs.sample_application.accessing_results">6.6.4. Accessing the results of analysis</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.mvs.views_api_summary">6.7. Views API Summary</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tug.cm">7. CAS Multiplier</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.cm.developing_multiplier_code">7.1. Developing the CAS Multiplier Code</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.cm.cm_interface_overview">7.1.1. CAS Multiplier Interface Overview</a></span></dt><dt><span class="section"><a href="#ugr.tug.cm.how_to_get_empty_cas_instance">7.1.2. Getting an empty CAS Instance</a></span></dt><dt><span class="section"><a href="#ugr.tug.cm.example_code">7.1.3. Example Code</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.cm.creating_cm_descriptor" >7.2. CAS Multiplier Descriptor</a></span></dt><dt><span class="section"><a >href="#ugr.tug.cm.using_cm_in_aae">7.3. Using CAS Multipliers in >Aggregates</a></span></dt><dd><dl><dt><span class="section"><a >href="#ugr.tug.cm.adding_cm_to_aggregate">7.3.1. Aggregate: Adding the CAS >Multiplier</a></span></dt><dt><span class="section"><a >href="#ugr.tug.cm.cm_and_fc">7.3.2. CAS Multipliers and Flow >Control</a></span></dt><dt><span class="section"><a >href="#ugr.tug.cm.aggregate_cms">7.3.3. Aggregate CAS >Multipliers</a></span></dt></dl></dd><dt><span class="section"><a >href="#ugr.tug.cm.using_cm_in_cpe">7.4. CAS Multipliers in >CPE's</a></span></dt><dt><span class="section"><a >href="#ugr.tug.cm.calling_cm_from_app">7.5. Applications: Calling CAS >Multipliers</a></span></dt><dd><dl><dt><span class="section"><a >href="#ugr.tug.cm.retrieving_output_cases">7.5.1. Output >CASes</a></span></dt><dt><span class="section"><a >href="#ugr.tug.cm.using_cm_with_other_aes">7.5.2. CAS Multipliers with other >AEs </a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tug.cm.using_cm_to_merge_cases">7.6. Merging with CAS Multipliers</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.cm.overview_of_how_to_merge_cases">7.6.1. CAS Merging Overview</a></span></dt><dt><span class="section"><a href="#ugr.tug.cm.example_cas_merger">7.6.2. Example CAS Merger</a></span></dt><dt><span class="section"><a href="#ugr.tug.cm.using_the_simple_text_merger_in_an_aggregate_ae">7.6.3. SimpleTextMerger in an Aggregate</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#ugr.tug.xmi_emf">8. XMI & EMF</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.xmi_emf.overview">8.1. Overview</a></span></dt><dt><span class="section"><a href="#ugr.tug.xmi_emf.converting_ecore_to_from_uima_type_system">8.2. Converting an Ecore Model to or from a UIMA Type System</a></span></dt><dt><span class="section"><a href="#ugr.tug.xmi_emf.using_xmi_cas_serialization">8.3. Using XMI CAS Serialization</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.xmi_emf.xml_character_issues">8.3.1. Character Encoding Issues with XML Serialization</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#ugr.tug.type_mapping">9. Managing different TypeSystems</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tug.type_mapping.type_merging">9.1. Annotators, Type Merging, and Remotes</a></span></dt><dt><span class="section"><a href="#ugr.tug.type_mapping.remote_support">9.2. Supporting Remote Annotators</a></span></dt><dt><span class="section"><a href="#ugr.tug.type_mapping.allowed_differences">9.3. Type filtering support in Binary Compressed Serialization/Deserialization</a></span></dt><dt><span class="section"><a href="#ugr.tug.type_mapping.compressed">9.4. Remote Services support with Compressed Binary Serialization</a></span></dt><dt><span class="section"><a href="#ugr.tug.type_filtering.compressed_file">9.5. Compressed B inary serialization to/from files</a></span></dt></dl></dd></dl></div>
Modified: uima/site/trunk/uima-website/docs/d/uimaj-current/tutorials_and_users_guides.pdf URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimaj-current/tutorials_and_users_guides.pdf?rev=1904950&r1=1904949&r2=1904950&view=diff ============================================================================== Binary files - no diff available. Modified: uima/site/trunk/uima-website/docs/d/uimaj-current/uimaj-core/api-change-report/japicmp.diff URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimaj-current/uimaj-core/api-change-report/japicmp.diff?rev=1904950&r1=1904949&r2=1904950&view=diff ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimaj-current/uimaj-core/api-change-report/japicmp.diff (original) +++ uima/site/trunk/uima-website/docs/d/uimaj-current/uimaj-core/api-change-report/japicmp.diff Mon Oct 31 13:15:29 2022 @@ -1,121 +1,5 @@ -Comparing source compatibility of /Users/bluefire/git/uima-uimaj/target/checkout/uimaj-core/target/uima-core.jar against /Users/bluefire/.m2/repository/org/apache/uima/uimaj-core/3.2.0/uimaj-core-3.2.0.jar +Comparing source compatibility of /Users/bluefire/git/uima-uimaj/target/checkout/uimaj-core/target/uima-core.jar against /Users/bluefire/.m2/repository/org/apache/uima/uimaj-core/3.3.0/uimaj-core-3.3.0.jar WARNING: You have ignored certain classes, i.e. superclasses and interfaces that could not be found on the classpath are ignored. Hence changes caused by these superclasses and interfaces are not reflected in the output. -+++ NEW INTERFACE: PUBLIC(+) ABSTRACT(+) org.apache.uima.analysis_component.CasProcessor (not serializable) - +++ CLASS FILE FORMAT VERSION: 52.0 <- n.a. - +++ NEW SUPERCLASS: java.lang.Object - +++ NEW METHOD: PUBLIC(+) org.apache.uima.analysis_component.CasProcessor andThen(org.apache.uima.analysis_component.CasProcessor) - +++ NEW METHOD: PUBLIC(+) ABSTRACT(+) void process(org.apache.uima.cas.CAS) - +++ NEW EXCEPTION: java.lang.Throwable - +++ NEW ANNOTATION: java.lang.FunctionalInterface -+++* NEW CLASS: PUBLIC(+) org.apache.uima.analysis_component.CasProcessorAnnotator (not serializable) - +++ CLASS FILE FORMAT VERSION: 52.0 <- n.a. - +++ NEW INTERFACE: org.apache.uima.analysis_engine.TextAnalysisEngine - +++ NEW INTERFACE: org.apache.uima.collection.CasConsumer - +++ NEW INTERFACE: org.apache.uima.collection.base_cpm.CasObjectProcessor - +++ NEW INTERFACE: org.apache.uima.analysis_engine.AnalysisEngine - +++ NEW INTERFACE: org.apache.uima.resource.Resource - +++ NEW INTERFACE: org.apache.uima.collection.base_cpm.CasProcessor - +++ NEW INTERFACE: org.apache.uima.resource.ConfigurableResource - +++ NEW SUPERCLASS: org.apache.uima.analysis_engine.impl.AnalysisEngineProcessorAdapter - +++ NEW CONSTRUCTOR: PUBLIC(+) CasProcessorAnnotator(org.apache.uima.analysis_component.CasProcessor) - +++ NEW METHOD: PUBLIC(+) boolean initialize(org.apache.uima.resource.ResourceSpecifier, java.util.Map) - +++ NEW EXCEPTION: org.apache.uima.resource.ResourceInitializationException - +++ NEW METHOD: PUBLIC(+) STATIC(+) org.apache.uima.analysis_component.CasProcessorAnnotator of(org.apache.uima.analysis_component.CasProcessor) - +++ NEW EXCEPTION: org.apache.uima.resource.ResourceInitializationException -+++ NEW INTERFACE: PUBLIC(+) ABSTRACT(+) org.apache.uima.analysis_component.JCasProcessor (not serializable) - +++ CLASS FILE FORMAT VERSION: 52.0 <- n.a. - +++ NEW SUPERCLASS: java.lang.Object - +++ NEW METHOD: PUBLIC(+) org.apache.uima.analysis_component.JCasProcessor andThen(org.apache.uima.analysis_component.JCasProcessor) - +++ NEW METHOD: PUBLIC(+) ABSTRACT(+) void process(org.apache.uima.jcas.JCas) - +++ NEW EXCEPTION: java.lang.Throwable - +++ NEW ANNOTATION: java.lang.FunctionalInterface -+++* NEW CLASS: PUBLIC(+) org.apache.uima.analysis_component.JCasProcessorAnnotator (not serializable) - +++ CLASS FILE FORMAT VERSION: 52.0 <- n.a. - +++ NEW INTERFACE: org.apache.uima.analysis_engine.TextAnalysisEngine - +++ NEW INTERFACE: org.apache.uima.collection.CasConsumer - +++ NEW INTERFACE: org.apache.uima.collection.base_cpm.CasObjectProcessor - +++ NEW INTERFACE: org.apache.uima.analysis_engine.AnalysisEngine - +++ NEW INTERFACE: org.apache.uima.resource.Resource - +++ NEW INTERFACE: org.apache.uima.collection.base_cpm.CasProcessor - +++ NEW INTERFACE: org.apache.uima.resource.ConfigurableResource - +++ NEW SUPERCLASS: org.apache.uima.analysis_engine.impl.AnalysisEngineProcessorAdapter - +++ NEW CONSTRUCTOR: PUBLIC(+) JCasProcessorAnnotator(org.apache.uima.analysis_component.JCasProcessor) - +++ NEW METHOD: PUBLIC(+) boolean initialize(org.apache.uima.resource.ResourceSpecifier, java.util.Map) - +++ NEW EXCEPTION: org.apache.uima.resource.ResourceInitializationException - +++ NEW METHOD: PUBLIC(+) STATIC(+) org.apache.uima.analysis_component.JCasProcessorAnnotator of(org.apache.uima.analysis_component.JCasProcessor) - +++ NEW EXCEPTION: org.apache.uima.resource.ResourceInitializationException -=== UNCHANGED INTERFACE: PUBLIC ABSTRACT org.apache.uima.analysis_engine.AnalysisEngine (not serializable) +*** MODIFIED CLASS: PUBLIC org.apache.uima.cas.CASRuntimeException (compatible) === CLASS FILE FORMAT VERSION: 52.0 <- 52.0 - === UNCHANGED FIELD: PUBLIC STATIC FINAL java.lang.String PARAM_CONFIG_PARAM_SETTINGS - +++ NEW ANNOTATION: java.lang.Deprecated - === UNCHANGED FIELD: PUBLIC STATIC FINAL java.lang.String PARAM_RESOURCE_MANAGER - +++ NEW ANNOTATION: java.lang.Deprecated -***! MODIFIED INTERFACE: PUBLIC ABSTRACT org.apache.uima.analysis_engine.AnalysisEngineServiceStub (not serializable) - === CLASS FILE FORMAT VERSION: 52.0 <- 52.0 - ===! UNCHANGED INTERFACE: org.apache.uima.resource.ResourceServiceStub - ***! MODIFIED METHOD: PUBLIC NON_ABSTRACT (<- ABSTRACT) void callBatchProcessComplete() - === UNCHANGED EXCEPTION: org.apache.uima.resource.ResourceServiceException - ***! MODIFIED METHOD: PUBLIC NON_ABSTRACT (<- ABSTRACT) void callCollectionProcessComplete() - === UNCHANGED EXCEPTION: org.apache.uima.resource.ResourceServiceException -=== UNCHANGED CLASS: PUBLIC ABSTRACT org.apache.uima.Constants (not serializable) - === CLASS FILE FORMAT VERSION: 52.0 <- 52.0 - === UNCHANGED FIELD: PUBLIC STATIC FINAL java.lang.String PROTOCOL_SOAP_WITH_ATTACHMENTS - +++ NEW ANNOTATION: java.lang.Deprecated - === UNCHANGED FIELD: PUBLIC STATIC FINAL java.lang.String PROTOCOL_SOAP - +++ NEW ANNOTATION: java.lang.Deprecated -*** MODIFIED INTERFACE: PUBLIC ABSTRACT org.apache.uima.resource.metadata.ConfigurationParameter (default serialVersionUID changed) - === CLASS FILE FORMAT VERSION: 52.0 <- 52.0 - +++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String TYPE_DOUBLE - +++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String TYPE_LONG -=== UNCHANGED INTERFACE: PUBLIC ABSTRACT org.apache.uima.resource.metadata.FsIndexCollection (compatible) - === CLASS FILE FORMAT VERSION: 52.0 <- 52.0 - === UNCHANGED METHOD: PUBLIC ABSTRACT void resolveImports(java.util.Collection, org.apache.uima.resource.ResourceManager) - +++ NEW ANNOTATION: java.lang.Deprecated - === UNCHANGED EXCEPTION: org.apache.uima.util.InvalidXMLException -=== UNCHANGED INTERFACE: PUBLIC ABSTRACT org.apache.uima.resource.metadata.TypePriorities (compatible) - === CLASS FILE FORMAT VERSION: 52.0 <- 52.0 - === UNCHANGED METHOD: PUBLIC ABSTRACT void resolveImports(java.util.Collection, org.apache.uima.resource.ResourceManager) - +++ NEW ANNOTATION: java.lang.Deprecated - === UNCHANGED EXCEPTION: org.apache.uima.util.InvalidXMLException -=== UNCHANGED INTERFACE: PUBLIC ABSTRACT org.apache.uima.resource.metadata.TypeSystemDescription (compatible) - === CLASS FILE FORMAT VERSION: 52.0 <- 52.0 - === UNCHANGED METHOD: PUBLIC ABSTRACT void resolveImports(java.util.Collection, org.apache.uima.resource.ResourceManager) - +++ NEW ANNOTATION: java.lang.Deprecated - === UNCHANGED EXCEPTION: org.apache.uima.util.InvalidXMLException -**** MODIFIED INTERFACE: PUBLIC ABSTRACT org.apache.uima.resource.RelativePathResolver (not serializable) - === CLASS FILE FORMAT VERSION: 52.0 <- 52.0 - === UNCHANGED METHOD: PUBLIC ABSTRACT java.lang.String getDataPath() - +++ NEW ANNOTATION: java.lang.Deprecated - +++* NEW METHOD: PUBLIC(+) ABSTRACT(+) java.util.List getDataPathElements() - === UNCHANGED METHOD: PUBLIC ABSTRACT void setDataPath(java.lang.String) - +++ NEW ANNOTATION: java.lang.Deprecated - === UNCHANGED EXCEPTION: java.net.MalformedURLException - +++* NEW METHOD: PUBLIC(+) ABSTRACT(+) void setDataPathElements(java.lang.String[]) - +++ NEW EXCEPTION: java.net.MalformedURLException - +++* NEW METHOD: PUBLIC(+) ABSTRACT(+) void setDataPathElements(java.io.File[]) - +++ NEW EXCEPTION: java.net.MalformedURLException -**** MODIFIED INTERFACE: PUBLIC ABSTRACT org.apache.uima.resource.ResourceManager (not serializable) - === CLASS FILE FORMAT VERSION: 52.0 <- 52.0 - === UNCHANGED METHOD: PUBLIC ABSTRACT java.lang.String getDataPath() - +++ NEW ANNOTATION: java.lang.Deprecated - +++* NEW METHOD: PUBLIC(+) ABSTRACT(+) java.util.List getDataPathElements() - === UNCHANGED METHOD: PUBLIC ABSTRACT void setDataPath(java.lang.String) - +++ NEW ANNOTATION: java.lang.Deprecated - === UNCHANGED EXCEPTION: java.net.MalformedURLException - +++* NEW METHOD: PUBLIC(+) ABSTRACT(+) void setDataPathElements(java.lang.String[]) - +++ NEW EXCEPTION: java.net.MalformedURLException - +++* NEW METHOD: PUBLIC(+) ABSTRACT(+) void setDataPathElements(java.io.File[]) - +++ NEW EXCEPTION: java.net.MalformedURLException -===* UNCHANGED INTERFACE: PUBLIC ABSTRACT org.apache.uima.resource.ResourceManagerPearWrapper (not serializable) - === CLASS FILE FORMAT VERSION: 52.0 <- 52.0 - ===* UNCHANGED INTERFACE: org.apache.uima.resource.ResourceManager -***! MODIFIED INTERFACE: PUBLIC ABSTRACT org.apache.uima.resource.ResourceServiceStub (not serializable) - === CLASS FILE FORMAT VERSION: 52.0 <- 52.0 - ***! MODIFIED METHOD: PUBLIC NON_ABSTRACT (<- ABSTRACT) void destroy() -***! MODIFIED CLASS: PUBLIC org.apache.uima.UimaContextHolder (not serializable) - === CLASS FILE FORMAT VERSION: 52.0 <- 52.0 - ***! MODIFIED CONSTRUCTOR: PRIVATE (<- PUBLIC) UimaContextHolder() -=== UNCHANGED INTERFACE: PUBLIC ABSTRACT org.apache.uima.util.Logger (not serializable) - === CLASS FILE FORMAT VERSION: 52.0 <- 52.0 - === UNCHANGED METHOD: PUBLIC ABSTRACT void setResourceManager(org.apache.uima.resource.ResourceManager) - +++ NEW ANNOTATION: java.lang.Deprecated + +++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JCAS_TYPE_NOT_IN_CAS_REGISTRY
