Overview & Setup Overview & Setup
UIMA Overview Chapter 1, UIMA Overview
Apache UIMA Project Documentation Overview Section 1.1, “Apache UIMA Project Documentation Overview”
Overviews Section 1.1.1, “Overviews”
Eclipse Tooling Installation and Setup Section 1.1.2, “Eclipse Tooling Installation and Setup”
Tutorials and Developer's Guides Section 1.1.3, “Tutorials and Developer's Guides” ???TITLE??? ???TITLE??? ???TITLE??? ???TITLE??? ???TITLE??? ???TITLE??? ???TITLE???
Tools Users' Guides Section 1.1.4, “Tools Users' Guides” ???TITLE??? ???TITLE??? ???TITLE??? ???TITLE??? ???TITLE??? ???TITLE??? ???TITLE??? ???TITLE??? ???TITLE???
References Section 1.1.5, “References” ???TITLE??? ???TITLE??? ???TITLE??? ???TITLE??? ???TITLE??? ???TITLE??? ???TITLE???
How to use the Documentation Section 1.2, “How to use the Documentation”
Changes from Previous Versions Section 1.3, “Changes from Previous Versions”
Changes from IBM UIMA 2.0 to Apache UIMA 2.1 Section 1.3.1, “Changes from IBM UIMA 2.0 to Apache UIMA 2.1”
Java Package Name Changes Section 1.3.1.1, “Java Package Name Changes”
XML Descriptor Changes Section 1.3.1.2, “XML Descriptor Changes”
TCAS replaced by CAS Section 1.3.1.3, “TCAS replaced by CAS”
JCas Is Now an Interface Section 1.3.1.4, “JCas Is Now an Interface”
JAR File names Have Changed Section 1.3.1.5, “JAR File names Have Changed”
Semantic Search Engine Repackaged Section 1.3.1.6, “Semantic Search Engine Repackaged”
Changes from UIMA Version 1.x Section 1.3.2, “Changes from UIMA Version 1.x”
New Capabilities Section 1.3.2.1, “New Capabilities” New Primitive data types New Primitive data types Simpler Analysis Engines and CASes Simpler Analysis Engines and CASes Sofas and CAS Views simplified Sofas and CAS Views simplified Analysis Component generalized to support multiple new CAS outputs Analysis Component generalized to support multiple new CAS outputs User-customized Flow Controllers User-customized Flow Controllers
Other Changes Section 1.3.2.2, “Other Changes” UIMA Exceptions rationalized UIMA Exceptions rationalized Changes in Result Specifications Changes in Result Specifications Only one Capability Set Only one Capability Set
Backwards Compatibility Section 1.3.2.3, “Backwards Compatibility”
Migrating from IBM UIMA to Apache UIMA Section 1.4, “Migrating from IBM UIMA to Apache UIMA”
Running the Migration Utility Section 1.4.1, “Running the Migration Utility”
JCas Cover Classes for DocumentAnnotation Section 1.4.1.1, “JCas Cover Classes for DocumentAnnotation”
JCas.getDocumentAnnotation Section 1.4.1.2, “JCas.getDocumentAnnotation”
Manual Migration Section 1.4.2, “Manual Migration”
xi:include Section 1.4.2.1, “xi:include”
Duplicate Methods Taking CAS and TCAS as Arguments Section 1.4.2.2, “Duplicate Methods Taking CAS and TCAS as Arguments”
Use of Undocumented Methods from the com.ibm.uima.util package Section 1.4.2.3, “Undocumented Methods”
Use of UIMA Package Names for User Code Section 1.4.2.4, “Package Names”
CASException and CASRuntimeException now extend UIMA(Runtime)Exception Section 1.4.2.5, “Changes to CAS Exceptions”
Apache UIMA Summary Section 1.5, “Apache UIMA Summary”
General Section 1.5.1, “General”
Programming Language Support Section 1.5.2, “Programming Language Support”
Multi-Modal Support Section 1.5.3, “Multi-Modal Support”
Semantic Search Components Section 1.5.4, “Semantic Search Components”
Summary of Apache UIMA Capabilities Section 1.6, “Summary of Apache UIMA Capabilities”
UIMA Conceptual Overview Chapter 2, UIMA Conceptual Overview
UIMA Introduction Section 2.1, “UIMA Introduction” UIMA helps you build the bridge between the unstructured and structured worlds Figure 2.1, “UIMA helps you build the bridge between the unstructured and structured worlds”
The Architecture, the Framework and the SDK Section 2.2, “The Architecture, the Framework and the SDK”
Analysis Basics Section 2.3, “Analysis Basics”
Analysis Engines, Annotators & Results Section 2.3.1, “Analysis Engines, Annotators & Results” Objects represented in the Common Analysis Structure (CAS) Figure 2.2, “Objects represented in the Common Analysis Structure (CAS)”
Representing Analysis Results in the CAS Section 2.3.2, “Representing Analysis Results in the CAS”
The Annotation Type Section 2.3.2.1, “The Annotation Type”
Not Just Annotations Section 2.3.2.2, “Not Just Annotations”
Multiple Views within a CAS Section 2.3.2.3, “Multiple Views within a CAS”
Interacting with the CAS and External Resources Section 2.3.3, “Using CASes and External Resources”
Component Descriptors Section 2.3.4, “Component Descriptors”
Aggregate Analysis Engines Section 2.4, “Aggregate Analysis Engines” Sample Aggregate Analysis Engine Figure 2.3, “Sample Aggregate Analysis Engine”
Application Building and Collection Processing Section 2.5, “Application Building and Collection Processing”
Using the framework from an Application Section 2.5.1, “Using the framework from an Application” Using UIMA Framework to create and interact with an Analysis Engine Figure 2.4, “Using UIMA Framework to create and interact with an Analysis Engine”
Graduating to Collection Processing Section 2.5.2, “Graduating to Collection Processing” High-Level UIMA Component Architecture from Source to Sink Figure 2.5, “High-Level UIMA Component Architecture from Source to Sink” Collection Processing Manager in UIMA Framework Figure 2.6, “Collection Processing Manager in UIMA Framework”
Exploiting Analysis Results Section 2.6, “Exploiting Analysis Results”
Semantic Search Section 2.6.1, “Semantic Search”
Databases Section 2.6.2, “Databases”
Multimodal Processing in UIMA Section 2.7, “Multimodal Processing in UIMA” Multiple Sofas in support of multi-modal analysis of an audio Stream. Some engines work on the audio “view”, some on the text “view” and some on both. Figure 2.7, “Multiple Sofas in support of multi-modal analysis of an audio Stream. Some engines work on the audio “view”, some on the text “view” and some on both.”
Next Steps Section 2.8, “Next Steps”
Setting up the Eclipse IDE to work with UIMA Chapter 3, Setting up the Eclipse IDE to work with UIMA
Installation Section 3.1, “Installation”
Install Eclipse Section 3.1.1, “Install Eclipse”
Install additional Eclipse component: EMF Section 3.1.2, “Install additional Eclipse component: EMF”
EMF Installation Shortcut for Eclipse 3.2 Section 3.1.2.1, “EMF Installation Shortcut for Eclipse 3.2”
Install the UIMA SDK Section 3.1.3, “Install the UIMA SDK”
Install the UIMA Eclipse Plugins Section 3.1.4, “Install the UIMA Eclipse Plugins”
Start Eclipse Section 3.1.5, “Start Eclipse”
Special startup parameter for Eclipse: -clean Section 3.1.5.1, “Special startup parameter for Eclipse: -clean”
Setting up Eclipse to view Example Code Section 3.2, “Setting up Eclipse to view Example Code”
Running external tools from Eclipse Section 3.3, “Running external tools from Eclipse”
UIMA Frequently Asked Questions (FAQ's) Chapter 4, UIMA Frequently Asked Questions (FAQ's) ???TITLE??? What is UIMA? ???TITLE??? How do you pronounce UIMA? ???TITLE??? What's the difference between UIMA and the Apache UIMA? ???TITLE??? Does UIMA include a semantic search engine? ???TITLE??? What is an Annotation? ???TITLE??? What is the CAS? ???TITLE??? What does the CAS contain? ???TITLE??? Does the CAS only contain Annotations? ???TITLE??? Is the CAS just XML? ???TITLE??? What is a Type System? ???TITLE??? What is a Sofa? ???TITLE??? What's the difference between an Annotator and an Analysis Engine? ???TITLE??? Are UIMA analysis engines web services? ???TITLE??? Do Analysis Engines have to be "stateless"? ???TITLE??? Is engine meta-data compatible with web services and UDDI? ???TITLE??? How do you scale a UIMA application? ???TITLE??? What does it mean to embed UIMA in systems middleware? ???TITLE??? How is the CPM different from a CPE? ???TITLE??? What is Semantic Search and what is its relationship to UIMA? ???TITLE??? Is an XML Fragment Query valid XML? ???TITLE??? Does UIMA support modalities other than text? ???TITLE??? How does UIMA compare to other similar work? ???TITLE??? Is UIMA Open Source? ???TITLE??? What Java level and OS are required for the UIMA SDK? ???TITLE??? Can I build my UIM application on top of UIMA? ???TITLE??? Do any commercial products support the UIMA framework or include it as part of their product?
Glossary: Key Terms & Concepts Glossary Aggregate Analysis Engine Aggregate Analysis Engine Analysis Engine Analysis Engine Annotation Annotation Annotator Annotator Application Application Apache UIMA Java Framework Apache UIMA Java Framework Apache UIMA Software Development Kit (SDK) Apache UIMA Software Development Kit (SDK) CAS CAS CAS Consumer CAS Consumer CAS Initializer (deprecated) CAS Initializer (deprecated) CAS Multiplier CAS Multiplier CAS Processor CAS Processor CAS View CAS View CDE CDE Collection Processing Engine (CPE) Collection Processing Engine (CPE) Collection Processing Manager (CPM) Collection Processing Manager (CPM) Collection Reader Collection Reader Fact Search Fact Search Feature Feature Flow Controller Flow Controller Hybrid Analysis Engine Hybrid Analysis Engine Index Index JCas JCas Keyword Search Keyword Search Knowledge Base Knowledge Base Loosely-Coupled Analysis Engine Loosely-Coupled Analysis Engine PEAR PEAR Primitive Analysis Engine Primitive Analysis Engine Semantic Search Semantic Search Structured Information Structured Information Subject of Analysis (Sofa) Subject of Analysis (Sofa) Tightly-Coupled Analysis Engine Tightly-Coupled Analysis Engine Type Type Type System Type System Unstructured Information Unstructured Information UIMA UIMA UIMA Java Framework UIMA Java Framework UIMA SDK UIMA SDK XCAS XCAS XML Metadata Interchange (XMI) XML Metadata Interchange (XMI)