Apache UIMA SDK Reference Apache UIMA SDK Reference

Javadocs Chapter 1, Javadocs

Component Descriptor Reference Chapter 2, Component Descriptor Reference

Notation Section 2.1, “Notation”

Imports Section 2.2, “Imports” ???TITLE??? Section 2.2, “Imports”

Type System Descriptors Section 2.3, “Type System Descriptors”

Imports the section called “Imports”

Types the section called “Types”

Features the section called “Features”

String Subtypes the section called “String Subtypes”

Analysis Engine Descriptors Section 2.4, “Analysis Engine Descriptors”

Primitive Analysis Engine Descriptors the section called “Primitive Analysis Engine Descriptors”

Basic Structure the section called “Basic Structure”

Analysis Engine MetaData the section called “Analysis Engine MetaData”

Configuration Parameter Declaration the section called “Configuration Parameter Declaration”

Example the section called “Example”

Configuration Parameter Settings the section called “Configuration Parameter Settings”

Example the section called “Example”

Type System Definition the section called “Type System Definition”

Type Priority Definition the section called “Type Priority Definition”

Index Definition the section called “Index Definition”

Capabilities the section called “Capabilities”

OperationalProperties the section called “OperationalProperties”

External Resource Dependencies the section called “External Resource Dependencies”

Resource Manager Configuration the section called “Resource Manager Configuration”

Environment Variable References the section called “Environment Variable References”

Aggregate Analysis Engine Descriptors the section called “Aggregate Analysis Engine Descriptors”

Delegate Analysis Engine Specifiers the section called “Delegate Analysis Engine Specifiers”

FlowController the section called “FlowController”

FlowConstraintsr the section called “FlowConstraintsr”

Fixed Flow the section called “Fixed Flow”

Capability Language Flow the section called “Capability Language Flow”

Configuration Parameter Overrides the section called “Configuration Parameter Overrides”

External Resource Bindings the section called “External Resource Bindings”

Sofa Mappings the section called “Sofa Mappings”

Flow Controller Descriptors Section 2.5, “Flow Controller Descriptors”

Collection Processing Component Descriptors Section 2.6, “Collection Processing Component Descriptors”

Collection Reader Descriptors the section called “Collection Reader Descriptors”

CAS Initializer Descriptors (deprecated) the section called “CAS Initializer Descriptors (deprecated)”

CAS Consumer Descriptors the section called “CAS Consumer Descriptors”

Service Client Descriptors Section 2.7, “Service Client Descriptors”

Collection Processing Engine Descriptor Reference Chapter 3, Collection Processing Engine Descriptor Reference

CPE Overview Section 3.1, “CPE Overview” CPE Runtime Overview Figure 3.1, “CPE Runtime Overview”

Notation Section 3.2, “Notation”

Imports Section 3.3, “Imports”

CPE Descriptor Section 3.4, “CPE Descriptor”

Collection Reader the section called “Collection Reader”

Error handling for Collection Readers the section called “Error handling for Collection Readers”

CAS Processors the section called “CAS Processors”

Specifying an Individual CAS Processor the section called “Specifying an Individual CAS Processor”

<descriptor> Element the section called “<descriptor> Element”

<configurationParameterSettings> Element the section called “<configurationParameterSettings> Element”

<sofaNameMappings> Element the section called “<sofaNameMappings> Element”

<runInSeparateProcess> Element the section called “<runInSeparateProcess> Element”

<deploymentParameters> Element the section called “<deploymentParameters> Element”

<filter> Element the section called “<filter> Element”

<errorHandling> Element the section called “<errorHandling> Element”

Retry action taken on a timeout the section called “Retry action taken on a timeout”

<checkpoint> Element the section called “<checkpoint> Element”

CPE Operational Parameters the section called “CPE Operational Parameters”

Resource Manager Configuration the section called “Resource Manager Configuration”

Example CPE Descriptor the section called “Example CPE Descriptor”

CAS Reference Chapter 4, CAS Reference

JavaDocs Section 4.1, “JavaDocs”

CAS Overview Section 4.2, “CAS Overview”

The Type System the section called “The Type System”

Creating, accessing and manipulating data the section called “Creating, accessing and manipulating data”

Creating and using indexes the section called “Creating and using indexes”

Built-in CAS Types Section 4.3, “Built-in CAS Types”

Accessing the type system Section 4.4, “Accessing the type system”

TypeSystemPrinter example the section called “TypeSystemPrinter example”

Using the CAS APIs to create and modify feature structures the section called “Using the CAS APIs to create and modify feature structures”

Creating feature structures Section 4.5, “Creating feature structures”

Accessing or modifying features of feature structures Section 4.6, “Accessing or modifying features of feature structures”

Indexes and Iterators Section 4.7, “Indexes and Iterators”

Iterators the section called “Iterators”

Special iterators for Annotation types the section called “Special iterators for Annotation types”

Constraints and Filtered iterators the section called “Constraints and Filtered iterators”

The CAS APIs – a guide to the JavaDocs Section 4.8, “The CAS APIs – a guide to the JavaDocs”

APIs in the CAS package the section called “APIs in the CAS package” CAS Object hierarchy Figure 4.1, “CAS Object hierarchy”

JCas Reference Chapter 5, JCas Reference

Name Spaces Section 5.1, “Name Spaces”

XML description element is copied into generated Java code Section 5.2, “XML description element is copied into generated Java code”

Mapping built-in CAS types to Java types Section 5.3, “Mapping built-in CAS types to Java types”

Augmenting the generated Java Code Section 5.4, “Augmenting the generated Java Code”

Keeping hand-coded augmentations when regenerating the section called “Keeping hand-coded augmentations when regenerating”

Additional Constructors the section called “Additional Constructors”

Using readObject the section called “Using readObject”

Modifying generated items the section called “Modifying generated items”

Merging types from different type system specifications Section 5.5, “Merging types from different type system specifications”

Aggregate AEs and CPEs as sources of types the section called “Aggregate AEs and CPEs as sources of types”

JCasGen support for type merging the section called “JCasGen support for type merging”

Using JCas within an Annotator Section 5.6, “Using JCas within an Annotator”

Creating new instances using the Java “new” operator the section called “Creating new instances using the Java “new” operator”

Getters and Setters the section called “Getters and Setters”

Obtaining references to Indexes the section called “Obtaining references to Indexes”

Adding (and removing) instances to (from) indexes the section called “Adding (and removing) instances to (from) indexes”

Using Iterators the section called “Using Iterators”

Class Loaders in UIMA the section called “Class Loaders in UIMA”

Use of Class Loaders is optional the section called “Use of Class Loaders is optional”

Issues around DocumentAnnotation the section called “Issues around DocumentAnnotation”

Issues accessing JCas objects outside of UIMA Engine Components the section called “Issues accessing JCas objects outside of UIMA Engine Components”

Setting up Classpath for JCas Section 5.7, “Setting up Classpath for JCas”

PEAR Reference Chapter 6, PEAR Reference

Packaging a UIMA component Section 6.1, “Packaging a UIMA component”

Creating the PEAR structure the section called “Creating the PEAR structure” The PEAR Structure Figure 6.1, “The PEAR Structure”

Populating the PEAR structure the section called “Populating the PEAR structure”

Standard Type the section called “Standard Type”

Service Type the section called “Service Type”

Network Type the section called “Network Type”

Creating the installation descriptor the section called “Creating the installation descriptor”

Documented template for the installation descriptor: the section called “Documented template for the installation descriptor:”

The SUBMITTED_COMPONENT section the section called “The SUBMITTED_COMPONENT section”

The ID, NAME, and DESC tags the section called “The ID, NAME, and DESC tags”

Tags related to deployment types the section called “Tags related to deployment types”

Standard Type the section called “Standard Type”

Service Type the section called “Service Type”

Network Type the section called “Network Type”

The Collection Reader and CAS Consumer tags the section called “The Collection Reader and CAS Consumer tags”

The INSTALLATION section the section called “The INSTALLATION section”

Packaging the PEAR structure into one file the section called “Packaging the PEAR structure into one file”

Installing a PEAR fiel the section called “Installing a PEAR fiel”

XMI CAS Serialization Reference Chapter 7, XMI CAS Serialization Reference

XMI Tag Section 7.1, “XMI Tag”

Feature Structures Section 7.2, “Feature Structures”

Primitive Features Section 7.3, “Primitive Features”

Reference Features Section 7.4, “Reference Features”

Array and List Features Section 7.5, “Array and List Features”

Arrays and Lists as Multi-Valued Properties the section called “Arrays and Lists as Multi-Valued Properties”

Arrays and Lists as First-Class Objects the section called “Arrays and Lists as First-Class Objects”

Null Array/List Elements" Section 7.6, “Null Array/List Elements"”

Subjects of Analysis (Sofas) and Views Section 7.7, “Subjects of Analysis (Sofas) and Views”

Linking an XMI Document to its Ecore Type System Section 7.8, “Linking an XMI Document to its Ecore Type System”