UIMA Overview & SDK SetupUIMA Overview & SDK Setup
UIMA OverviewChapter 1, UIMA Overview
Apache UIMA Project Documentation OverviewSection 1.1, “Apache UIMA Project Documentation Overview”
OverviewsSection 1.1.1, “Overviews”
Eclipse Tooling Installation and SetupSection 1.1.2, “Eclipse Tooling Installation and Setup”
Tutorials and Developer's GuidesSection 1.1.3, “Tutorials and Developer's Guides”???TITLE?????????TITLE?????????TITLE?????????TITLE?????????TITLE?????????TITLE?????????TITLE?????????TITLE??????
Tools Users' GuidesSection 1.1.4, “Tools Users' Guides”???TITLE?????????TITLE?????????TITLE?????????TITLE?????????TITLE?????????TITLE?????????TITLE?????????TITLE?????????TITLE??????
ReferencesSection 1.1.5, “References”???TITLE?????????TITLE?????????TITLE?????????TITLE?????????TITLE?????????TITLE?????????TITLE??????
How to use the DocumentationSection 1.2, “How to use the Documentation”
Changes from Previous Major VersionsSection 1.3, “Changes from Previous Major Versions”
Changes from IBM UIMA 2.0 to Apache UIMA 2.1Section 1.3.1, “Changes from IBM UIMA 2.0 to Apache UIMA 2.1”
Java Package Name ChangesSection 1.3.1.1, “Java Package Name Changes”
XML Descriptor ChangesSection 1.3.1.2, “XML Descriptor Changes”
TCAS replaced by CASSection 1.3.1.3, “TCAS replaced by CAS”
JCas Is Now an InterfaceSection 1.3.1.4, “JCas Is Now an Interface”
JAR File names Have ChangedSection 1.3.1.5, “JAR File names Have Changed”
Semantic Search Engine RepackagedSection 1.3.1.6, “Semantic Search Engine Repackaged”
Changes from UIMA Version 1.xSection 1.3.2, “Changes from UIMA Version 1.x”
New CapabilitiesSection 1.3.2.1, “New Capabilities”New Primitive data typesNew Primitive data typesSimpler Analysis Engines and CASesSimpler Analysis Engines and CASesSofas and CAS Views simplifiedSofas and CAS Views simplifiedAnalysis Component generalized to support multiple new CAS outputsAnalysis Component generalized to support multiple new CAS outputsUser-customized Flow ControllersUser-customized Flow Controllers
Other ChangesSection 1.3.2.2, “Other Changes”UIMA Exceptions rationalizedUIMA Exceptions rationalizedChanges in Result SpecificationsChanges in Result SpecificationsOnly one Capability SetOnly one Capability Set
Backwards CompatibilitySection 1.3.2.3, “Backwards Compatibility”
Migrating from IBM UIMA to Apache UIMASection 1.4, “Migrating from IBM UIMA to Apache UIMA”
Running the Migration UtilitySection 1.4.1, “Running the Migration Utility”
JCas Cover Classes for DocumentAnnotationSection 1.4.1.1, “JCas Cover Classes for DocumentAnnotation”
JCas.getDocumentAnnotationSection 1.4.1.2, “JCas.getDocumentAnnotation”
Manual MigrationSection 1.4.2, “Manual Migration”
xi:includeSection 1.4.2.1, “xi:include”
Duplicate Methods Taking CAS and TCAS as ArgumentsSection 1.4.2.2, “Duplicate Methods Taking CAS and TCAS as Arguments”
Use of Undocumented Methods from the com.ibm.uima.util packageSection 1.4.2.3, “Undocumented Methods”
Use of UIMA Package Names for User CodeSection 1.4.2.4, “Package Names”
CASException and CASRuntimeException now extend UIMA(Runtime)ExceptionSection 1.4.2.5, “Changes to CAS Exceptions”
Apache UIMA SummarySection 1.5, “Apache UIMA Summary”
GeneralSection 1.5.1, “General”
Programming Language SupportSection 1.5.2, “Programming Language Support”
Multi-Modal SupportSection 1.5.3, “Multi-Modal Support”
Semantic Search ComponentsSection 1.5.4, “Semantic Search Components”
Summary of Apache UIMA CapabilitiesSection 1.6, “Summary of Apache UIMA Capabilities”
UIMA Conceptual OverviewChapter 2, UIMA Conceptual Overview
UIMA IntroductionSection 2.1, “UIMA Introduction”UIMA helps you build the bridge between the unstructured and structured worldsFigure 2.1, “UIMA helps you build the bridge between the unstructured and structured worlds”
The Architecture, the Framework and the SDKSection 2.2, “The Architecture, the Framework and the SDK”
Analysis BasicsSection 2.3, “Analysis Basics”
Analysis Engines, Annotators & ResultsSection 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 CASSection 2.3.2, “Representing Analysis Results in the CAS”
The Annotation TypeSection 2.3.2.1, “The Annotation Type”
Not Just AnnotationsSection 2.3.2.2, “Not Just Annotations”
Multiple Views within a CASSection 2.3.2.3, “Multiple Views within a CAS”
Interacting with the CAS and External ResourcesSection 2.3.3, “Using CASes and External Resources”
Component DescriptorsSection 2.3.4, “Component Descriptors”
Aggregate Analysis EnginesSection 2.4, “Aggregate Analysis Engines”Sample Aggregate Analysis EngineFigure 2.3, “Sample Aggregate Analysis Engine”
Application Building and Collection ProcessingSection 2.5, “Application Building and Collection Processing”
Using the framework from an ApplicationSection 2.5.1, “Using the framework from an Application”Using UIMA Framework to create and interact with an Analysis EngineFigure 2.4, “Using UIMA Framework to create and interact with an Analysis Engine”
Graduating to Collection ProcessingSection 2.5.2, “Graduating to Collection Processing”High-Level UIMA Component Architecture from Source to SinkFigure 2.5, “High-Level UIMA Component Architecture from Source to Sink”Collection Processing Manager in UIMA FrameworkFigure 2.6, “Collection Processing Manager in UIMA Framework”
Exploiting Analysis ResultsSection 2.6, “Exploiting Analysis Results”
Semantic SearchSection 2.6.1, “Semantic Search”
DatabasesSection 2.6.2, “Databases”
Multimodal Processing in UIMASection 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 StepsSection 2.8, “Next Steps”
Setting up the Eclipse IDE to work with UIMAChapter 3, Setting up the Eclipse IDE to work with UIMA
InstallationSection 3.1, “Installation”
Install EclipseSection 3.1.1, “Install Eclipse”
Installing the UIMA Eclipse PluginsSection 3.1.2, “Installing the UIMA Eclipse Plugins”
Manual Install additional Eclipse component: EMFSection 3.1.3, “Manual Install additional Eclipse component: EMF”
EMF Installation Shortcut for Eclipse 3.2Section 3.1.3.1, “EMF Installation Shortcut for Eclipse 3.2”
Install the UIMA SDKSection 3.1.4, “Install the UIMA SDK”
Installing the UIMA Eclipse Plugins, manuallySection 3.1.5, “Installing the UIMA Eclipse Plugins, manually”
Start EclipseSection 3.1.6, “Start Eclipse”
Special startup parameter for Eclipse: -cleanSection 3.1.6.1, “Special startup parameter for Eclipse: -clean”
Setting up Eclipse to view Example CodeSection 3.2, “Setting up Eclipse to view Example Code”
Adding the UIMA source code to the jar filesSection 3.3, “Adding the UIMA source code to the jar files”
Attaching UIMA JavadocsSection 3.4, “Attaching UIMA Javadocs”
Running external tools from EclipseSection 3.5, “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?
Known IssuesChapter 5, Known Issues???TITLE???Sun Java 1.4.2_12 doesn't serialize CR characters to XML???TITLE???JCasGen merge facility only supports Java levels 1.4 or earlier???TITLE???Descriptor editor in Eclipse tooling does not work with libgcj 4.1.2
Glossary: Key Terms & ConceptsGlossaryAggregate Analysis EngineAggregate Analysis EngineAnalysis EngineAnalysis EngineAnnotationAnnotationAnnotatorAnnotatorApplicationApplicationApache UIMA Java FrameworkApache UIMA Java FrameworkApache UIMA Software Development Kit (SDK)Apache UIMA Software Development Kit (SDK)CASCASCAS ConsumerCAS ConsumerCAS Initializer (deprecated)CAS Initializer (deprecated)CAS MultiplierCAS MultiplierCAS ProcessorCAS ProcessorCAS ViewCAS ViewCDECDECollection Processing Engine (CPE)Collection Processing Engine (CPE)Collection Processing Manager (CPM)Collection Processing Manager (CPM)Collection ReaderCollection ReaderFact SearchFact SearchFeatureFeatureFlow ControllerFlow ControllerHybrid Analysis EngineHybrid Analysis EngineIndexIndexJCasJCasKeyword SearchKeyword SearchKnowledge BaseKnowledge BaseLoosely-Coupled Analysis EngineLoosely-Coupled Analysis EnginePEARPEARPrimitive Analysis EnginePrimitive Analysis EngineSemantic SearchSemantic SearchStructured InformationStructured InformationSubject of Analysis (Sofa)Subject of Analysis (Sofa)Tightly-Coupled Analysis EngineTightly-Coupled Analysis EngineTypeTypeType SystemType SystemUnstructured InformationUnstructured InformationUIMAUIMAUIMA Java FrameworkUIMA Java FrameworkUIMA SDKUIMA SDKXCASXCASXML Metadata Interchange (XMI)XML Metadata Interchange (XMI)