UIMA References
UIMA References
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
Section 2.3.1, “Imports”
Types
Section 2.3.2, “Types”
Features
Section 2.3.3, “Features”
String Subtypes
Section 2.3.4, “String Subtypes”
Analysis Engine Descriptors
Section 2.4, “Analysis Engine Descriptors”
Primitive Analysis Engine Descriptors
Section 2.4.1, “Primitive Analysis Engine Descriptors”
Basic Structure
Section 2.4.1.1, “Basic Structure”
Analysis Engine MetaData
Section 2.4.1.2, “Analysis Engine MetaData”
Configuration Parameter Declaration
Section 2.4.1.3, “Configuration Parameter Declaration”
Example
the section called “Example”
Configuration Parameter Settings
Section 2.4.1.4, “Configuration Parameter Settings”
Example
the section called “Example”
Type System Definition
Section 2.4.1.5, “Type System Definition”
Type Priority Definition
Section 2.4.1.6, “Type Priority Definition”
Index Definition
Section 2.4.1.7, “Index Definition”
Capabilities
Section 2.4.1.8, “Capabilities”
OperationalProperties
Section 2.4.1.9, “OperationalProperties”
External Resource Dependencies
Section 2.4.1.10, “External Resource Dependencies”
Resource Manager Configuration
Section 2.4.1.11, “Resource Manager Configuration”
Environment Variable References
Section 2.4.1.12, “Environment Variable References”
Aggregate Analysis Engine Descriptors
Section 2.4.2, “Aggregate Analysis Engine Descriptors”
Delegate Analysis Engine Specifiers
Section 2.4.2.1, “Delegate Analysis Engine Specifiers”
FlowController
Section 2.4.2.2, “FlowController”
FlowConstraints
Section 2.4.2.3, “FlowConstraints”
Fixed Flow
the section called “Fixed Flow”
Capability Language Flow
the section called “Capability Language Flow”
Configuration Parameter Overrides
Section 2.4.2.4, “Configuration Parameter Overrides”
External Resource Bindings
Section 2.4.2.5, “External Resource Bindings”
Sofa Mappings
Section 2.4.2.6, “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
Section 2.6.1, “Collection Reader Descriptors”
CAS Initializer Descriptors (deprecated)
Section 2.6.2, “CAS Initializer Descriptors (deprecated)”
CAS Consumer Descriptors
Section 2.6.3, “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 Overview
Section 3.4, “CPE Descriptor Overview”
Collection Reader
Section 3.5, “Collection Reader”
Error handling for Collection Readers
Section 3.5.1, “Error handling for Collection Readers”
CAS Processors
Section 3.6, “CAS Processors”
Specifying an Individual CAS Processor
Section 3.6.1, “Specifying an Individual CAS Processor”
<descriptor> Element
Section 3.6.1.1, “<descriptor> Element”
<configurationParameterSettings> Element
Section 3.6.1.2, “<configurationParameterSettings> Element”
<sofaNameMappings> Element
Section 3.6.1.3, “<sofaNameMappings> Element”
<runInSeparateProcess> Element
Section 3.6.1.4, “<runInSeparateProcess> Element”
<deploymentParameters> Element
Section 3.6.1.5, “<deploymentParameters> Element”
<filter> Element
Section 3.6.1.6, “<filter> Element”
<errorHandling> Element
Section 3.6.1.7, “<errorHandling> Element”
Retry action taken on a timeout
the section called “Retry action taken on a timeout”
<checkpoint> Element
Section 3.6.1.8, “<checkpoint> Element”
CPE Operational Parameters
Section 3.7, “CPE Operational Parameters”
Resource Manager Configuration
Section 3.8, “Resource Manager Configuration”
Example CPE Descriptor
Section 3.9, “Example CPE Descriptor”
CAS Reference
Chapter 4, CAS Reference
JavaDocs
Section 4.1, “JavaDocs”
CAS Overview
Section 4.2, “CAS Overview”
The Type System
Section 4.2.1, “The Type System”
Creating, accessing and manipulating data
Section 4.2.2, “Creating/Accessing/Changing data”
Creating and using indexes
Section 4.2.3, “Creating and using indexes”
Built-in CAS Types
Section 4.3, “Built-in CAS Types”
???TITLE???
Section 4.3, “Built-in CAS Types”
Accessing the type system
Section 4.4, “Accessing the type system”
TypeSystemPrinter example
Section 4.4.1, “TypeSystemPrinter example”
Using the CAS APIs to create and modify feature structures
Section 4.4.2, “Using CAS APIs: 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”
Indexes and Iterators
Section 4.7, “Indexes and Iterators”
Built-in Indexes
Section 4.7.1, “Built-in Indexes”
Adding Feature Structures to the Indexes
Section 4.7.2, “Adding Feature Structures to the Indexes”
Iterators
Section 4.7.3, “Iterators”
Special iterators for Annotation types
Section 4.7.4, “Special iterators for Annotation types”
Constraints and Filtered iterators
Section 4.7.5, “Constraints and Filtered iterators”
The CAS API's – a guide to the JavaDocs
Section 4.8, “CAS API's JavaDocs”
APIs in the CAS package
Section 4.8.1, “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”
The XML description element is copied into generated Java code
Section 5.2, “Use of XML Description”
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
Section 5.4.1, “Keeping hand-coded augmentations when regenerating”
Additional Constructors
Section 5.4.2, “Additional Constructors”
Using readObject
Section 5.4.2.1, “Using readObject”
Modifying generated items
Section 5.4.3, “Modifying generated items”
Merging types from different type system specifications
Section 5.5, “Merging Types”
Aggregate AEs and CPEs as sources of types
Section 5.5.1, “Aggregate AEs and CPEs as sources of types”
JCasGen support for type merging
Section 5.5.2, “JCasGen support for type merging”
Impact of Type Merging on Composability of Annotators
Section 5.5.3, “Type Merging impacts on Composability”
Adding Features to DocumentAnnotation
Section 5.5.4, “Adding Features to DocumentAnnotation”
Using JCas within an Annotator
Section 5.6, “Using JCas within an Annotator”
Creating new instances using the Java “new” operator
Section 5.6.1, “Creating new instances”
Getters and Setters
Section 5.6.2, “Getters and Setters”
Obtaining references to Indexes
Section 5.6.3, “Obtaining references to Indexes”
Adding (and removing) instances to (from) indexes
Section 5.6.4, “Updating Indexes”
Using Iterators
Section 5.6.5, “Using Iterators”
Class Loaders in UIMA
Section 5.6.6, “Class Loaders in UIMA”
Use of Class Loaders is optional
Section 5.6.6.1, “Use of Class Loaders is optional”
Issues accessing JCas objects outside of UIMA Engine Components
Section 5.6.7, “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
Section 6.1.1, “Creating the PEAR structure”
The PEAR Structure
Figure 6.1, “The PEAR Structure”
Populating the PEAR structure
Section 6.1.2, “Populating the PEAR structure”
Standard Type
Section 6.1.2.1, “Standard Type”
Service Type
Section 6.1.2.2, “Service Type”
Network Type
Section 6.1.2.3, “Network Type”
Creating the installation descriptor
Section 6.1.3, “Creating the installation descriptor”
Documented template for the installation descriptor:
Section 6.1.4, “Installation Descriptor: template”
The SUBMITTED_COMPONENT section
Section 6.1.4.1, “The SUBMITTED_COMPONENT section”
The ID, NAME, and DESC tags
Section 6.1.4.2, “The ID, NAME, and DESC tags”
Tags related to deployment types
Section 6.1.4.3, “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
Section 6.1.4.4, “The Collection Reader and CAS Consumer tags”
The INSTALLATION section
Section 6.1.4.5, “The INSTALLATION section”
Packaging the PEAR structure into one file
Section 6.1.5, “Packaging the PEAR structure into one file”
Installing a PEAR package
Section 6.2, “Installing a PEAR package”
Installing a PEAR file using the PEAR APIs
Section 6.2.1, “Installing a PEAR file using the PEAR APIs”
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
Section 7.5.1, “Arrays and Lists as Multi-Valued Properties”
Arrays and Lists as First-Class Objects
Section 7.5.2, “Arrays and Lists as First-Class Objects”
Null Array/List Elements
Section 7.5.3, “Null Array/List Elements”
Subjects of Analysis (Sofas) and Views
Section 7.6, “Subjects of Analysis (Sofas) and Views”
Linking an XMI Document to its Ecore Type System
Section 7.7, “Linking XMI docs to Ecore Type System”