| Package | Description | 
|---|---|
| org.apache.uima | Apache UIMA | 
| org.apache.uima.cas | Common Analysis System(CAS) Interfaces | 
| org.apache.uima.cas.impl | Implementation and Low-Level API for the CAS Interfaces. | 
| org.apache.uima.examples | |
| org.apache.uima.impl | Apache UIMA internals | 
| org.apache.uima.jcas | Interfaces for accessing the JCAS. | 
| org.apache.uima.jcas.cas | JCAS model for built-in CAS types | 
| org.apache.uima.jcas.impl | Provides the classes that support the Java Cas Model (JCM). | 
| org.apache.uima.jcas.tcas | |
| org.apache.uima.json | |
| org.apache.uima.resource | Interfaces for  ResourcesandResourceSpecifiers. | 
| org.apache.uima.util.impl | 
| Class and Description | 
|---|
| FeatureStructureImplC Feature structure implementation (for non JCas and JCas)
 
 Each FS has 
   - int data 
     - used for boolean, byte, short, int, long, float, double data
       -- long and double use 2 int slots
     - may be null if all slots are in JCas cover objects as fields
   - ref data
     - used for references to other Java objects, such as 
       -- strings
       -- other feature structures
       -- arbitrary Java Objects
     - may be null if all slots are in JCas cover objects as fields
   - an id: an incrementing integer, starting at 1, per CAS, of all FSs created for that CAS
   - a ref to the casView where this FS was created
   - a ref to the TypeImpl for this class
     -- can't be static - may be multiple type systems in use | 
| Class and Description | 
|---|
| LowLevelCAS Defines the low-level CAS APIs. | 
| LowLevelIndex Low-level FS index object. | 
| LowLevelTypeSystem Low-level version of the type system APIs. | 
| Class and Description | 
|---|
| AllowPreexistingFS | 
| BinaryCasSerDes Binary (mostly non compressed) CAS deserialization The methods in this class were originally part
 of the CASImpl, and were moved here to this class for v3
 
 Binary non compressed CAS serialization is in class CASSerializer, but that class uses routines
 and data structures in this class. | 
| BinaryCasSerDes4.Compression | 
| BinaryCasSerDes4.CompressLevel Compression alternatives | 
| BinaryCasSerDes4.CompressStrat | 
| BinaryCasSerDes6 User callable serialization and deserialization of the CAS in a compressed Binary Format
 
 This serializes/deserializes the state of the CAS. | 
| BinaryCasSerDes6.CompressLevel Compression alternatives | 
| BinaryCasSerDes6.CompressStrat | 
| BinaryCasSerDes6.ReuseInfo Info reused for 
   1) multiple serializations of same cas to multiple targets (a speedup), or
   2) for delta cas serialization, where it represents the fsStartIndex info before any mods
      were done which could change that info, or 
   3) for deserializing with a delta cas, where it represents the fsStartIndex info at the time
      the CAS was serialized out.. | 
| CASCompleteSerializer This is a small object which contains 
   - CASMgrSerializer instance - a Java serializable form of the type system + index definitions
   - CASSerializer instance - a Java serializable form of the CAS including lists of which FSs are indexed | 
| CASImpl Implements the CAS interfaces. | 
| CASMgrSerializer Container for serialized CAS typing information. | 
| CASSerializer This object has 2 purposes. | 
| CasSerializerSupport CAS serializer support for XMI and JSON formats. | 
| CasSerializerSupport.CasSerializerSupportSerialize | 
| CasState states the CAS can be in | 
| CasTypeSystemMapper This class gets initialized with two type systems, and then provides resources to map type and
 feature codes between them. | 
| CommonSerDes.Header HEADERS
 Serialization versioning
   There are 1 or 2 words used for versioning. | 
| CopyOnWriteIndexPart common APIs supporting the copy on write aspect of index parts | 
| DebugFSLogicalStructure.IndexInfo Class holding information about an FSIndex
 
 Includes the "label" of the index, and a ref to the CAS this index contents are in. | 
| DebugFSLogicalStructure.ViewInfo Class holding info about a View/Sofa. | 
| FeatureImpl The implementation of features in the type system. | 
| FeatureStructureImpl Deprecated. 
 use TOP instead | 
| FeatureStructureImplC Feature structure implementation (for non JCas and JCas)
 
 Each FS has 
   - int data 
     - used for boolean, byte, short, int, long, float, double data
       -- long and double use 2 int slots
     - may be null if all slots are in JCas cover objects as fields
   - ref data
     - used for references to other Java objects, such as 
       -- strings
       -- other feature structures
       -- arbitrary Java Objects
     - may be null if all slots are in JCas cover objects as fields
   - an id: an incrementing integer, starting at 1, per CAS, of all FSs created for that CAS
   - a ref to the casView where this FS was created
   - a ref to the TypeImpl for this class
     -- can't be static - may be multiple type systems in use | 
| FeatureStructureImplC.PrintReferences | 
| FeatureValuePathImpl Contains CAS Type and Feature objects to represent a feature path of the form
 feature1/.../featureN. | 
| FSClassRegistry There is one **class** instance of this per UIMA core class loader. | 
| FSClassRegistry.JCasClassInfo One instance per JCas class defined for it, per class loader
   - per class loader, because different JCas class definitions for the same name are possible, per class loader
 
 Kept in maps, per class loader. | 
| FsGenerator3 A Functional Interface for generating V3 Java Feature Structures | 
| FsIndex_flat Common part of flattened indexes, used for both snapshot iterators and flattened sorted indexes
 
 built from passed in instance of FsIndex_iicp | 
| FsIndex_singletype The common (among all index kinds - set, sorted, bag) info for an index over 1 type (excluding
 subtypes)
 
 SubClasses FsIndex_bag, FsIndex_flat, FsIndex_set_sorted, define the actual index repository for
 each kind. | 
| FSIndexComparatorImpl Specifies the comparison to be used for an index, in terms of 
 - the keys and the typeorder, in an order 
 - the standard/reverse ordering | 
| FSIndexRepositoryImpl There is one instance of this class per CAS View. | 
| FsIterator_multiple_indexes Common code for both
   aggregation of indexes (e.g. | 
| FsIterator_singletype | 
| FsIterator_subtypes_snapshot | 
| LowLevelCAS Defines the low-level CAS APIs. | 
| LowLevelIndex Low-level FS index object. | 
| LowLevelIndexRepository Low-level index repository access. | 
| LowLevelIterator Low-level FS iterator. | 
| LowLevelIterator_empty An empty Low-level FS iterator | 
| LowLevelTypeSystem Low-level version of the type system APIs. | 
| MarkerImpl A MarkerImpl holds a high-water "mark" in the CAS, for all views. | 
| OutOfTypeSystemData This class is used by the XCASDeserializer to store feature structures that do not fit into the
 type system of the CAS it is deserializing into. | 
| SelectFSs_impl Collection of builder style methods to specify selection of FSs from indexes
 shift handled in this routine
 Comment codes:
   AI = implies AnnotationIndex
 
 Iterator varieties and impl
 
   bounded?  type      order not unambig? strict? skipEq    
             Priority? Needed? 
     no
   coveredBy
   covering
   sameas
 
   for not-bounded, 
     - ignore strict and skipEq
       -- except: preceding implies skipping annotations whose end > positioning begin
     - order-not-needed only applies if iicp size > 1
     - unambig ==> use Subiterator
         -- subiterator wraps: according to typePriority and order-not-needed
     - no Type Priority - need to pass in as arg to fsIterator_multiple_indexes
        == if no type priority, need to prevent rattling off the == type while compare is equal
        == affects both FsIterator_aggregation_common and FsIterator_subtypes_ordered
   for 3 other boundings:
     - use subiterator, pass in strict and skipeq
 
   finish this javadoc comment edit
   T extends FeatureStructure, not TOP, because of ref from FSIndex 
 which uses FeatureStructure for backwards compatibility | 
| SlotKinds.SlotKind | 
| SlotKindsConstants Users "implement" this interface to get access to these constants in their code | 
| Subiterator.BoundsUse | 
| TypeImpl The implementation of types in the type system. | 
| TypeImpl_annotBase A version of TypeImpl for the AnnotationBase type and its subtypes | 
| TypeImpl_list | 
| TypeImpl_primitive | 
| TypeImpl_string String or String Subtype | 
| TypeSystemConstants This interface defines static final constants for Type Systems
   For the built-in types and features:
     - the type and feature codes
     - the adjOffsets | 
| TypeSystemImpl Type system implementation. | 
| TypeSystemUtils.PathValid | 
| XmiCasSerializer CAS serializer for XMI format; writes a CAS in the XML Metadata Interchange (XMI) format. | 
| XmiSerializationSharedData A container for data that is shared between the  XmiCasSerializerand theXmiCasDeserializer. | 
| XmiSerializationSharedData.OotsElementData 
 Data structure holding all information about an XMI element containing an out-of-typesystem FS. | 
| XmiSerializationSharedData.XmiArrayElement Data structure holding the index and the xmi:id of an array or list element that is a reference
 to an out-of-typesystem FS. | 
| Class and Description | 
|---|
| AnnotationBaseImpl Deprecated. 
 use AnnotationBase instead | 
| AnnotationImpl Deprecated. 
 use Annotation instead | 
| CASImpl Implements the CAS interfaces. | 
| FeatureStructureImpl Deprecated. 
 use TOP instead | 
| FeatureStructureImplC Feature structure implementation (for non JCas and JCas)
 
 Each FS has 
   - int data 
     - used for boolean, byte, short, int, long, float, double data
       -- long and double use 2 int slots
     - may be null if all slots are in JCas cover objects as fields
   - ref data
     - used for references to other Java objects, such as 
       -- strings
       -- other feature structures
       -- arbitrary Java Objects
     - may be null if all slots are in JCas cover objects as fields
   - an id: an incrementing integer, starting at 1, per CAS, of all FSs created for that CAS
   - a ref to the casView where this FS was created
   - a ref to the TypeImpl for this class
     -- can't be static - may be multiple type systems in use | 
| TypeImpl The implementation of types in the type system. | 
| Class and Description | 
|---|
| CASImpl Implements the CAS interfaces. | 
| Class and Description | 
|---|
| CASImpl Implements the CAS interfaces. | 
| LowLevelCAS Defines the low-level CAS APIs. | 
| LowLevelIndexRepository Low-level index repository access. | 
| Class and Description | 
|---|
| AnnotationBaseImpl Deprecated. 
 use AnnotationBase instead | 
| BooleanArrayFSImpl Deprecated. 
 use BooleanArray instead | 
| ByteArrayFSImpl Deprecated. 
 use ByteArray instead | 
| CASImpl Implements the CAS interfaces. | 
| CasSerializerSupport.CasDocSerializer Use an inner class to hold the data for serializing a CAS. | 
| DoubleArrayFSImpl Deprecated. 
 use DoubleArray instead | 
| FeatureStructureImpl Deprecated. 
 use TOP instead | 
| FeatureStructureImplC Feature structure implementation (for non JCas and JCas)
 
 Each FS has 
   - int data 
     - used for boolean, byte, short, int, long, float, double data
       -- long and double use 2 int slots
     - may be null if all slots are in JCas cover objects as fields
   - ref data
     - used for references to other Java objects, such as 
       -- strings
       -- other feature structures
       -- arbitrary Java Objects
     - may be null if all slots are in JCas cover objects as fields
   - an id: an incrementing integer, starting at 1, per CAS, of all FSs created for that CAS
   - a ref to the casView where this FS was created
   - a ref to the TypeImpl for this class
     -- can't be static - may be multiple type systems in use | 
| FloatArrayFSImpl Deprecated. 
 use FloatArray instead | 
| FSGenerator Deprecated. 
 unused in v3, only present to avoid compile errors in unused v2 classes | 
| IntArrayFSImpl Deprecated. 
 use IntegerArray instead | 
| LongArrayFSImpl Deprecated. 
 use LongArray instead | 
| LowLevelCAS Defines the low-level CAS APIs. | 
| SelectFSs_impl Collection of builder style methods to specify selection of FSs from indexes
 shift handled in this routine
 Comment codes:
   AI = implies AnnotationIndex
 
 Iterator varieties and impl
 
   bounded?  type      order not unambig? strict? skipEq    
             Priority? Needed? 
     no
   coveredBy
   covering
   sameas
 
   for not-bounded, 
     - ignore strict and skipEq
       -- except: preceding implies skipping annotations whose end > positioning begin
     - order-not-needed only applies if iicp size > 1
     - unambig ==> use Subiterator
         -- subiterator wraps: according to typePriority and order-not-needed
     - no Type Priority - need to pass in as arg to fsIterator_multiple_indexes
        == if no type priority, need to prevent rattling off the == type while compare is equal
        == affects both FsIterator_aggregation_common and FsIterator_subtypes_ordered
   for 3 other boundings:
     - use subiterator, pass in strict and skipeq
 
   finish this javadoc comment edit
   T extends FeatureStructure, not TOP, because of ref from FSIndex 
 which uses FeatureStructure for backwards compatibility | 
| ShortArrayFSImpl Deprecated. 
 use ShortArray instead | 
| SofaFSImpl Deprecated. 
 use Sofa instead | 
| StringArrayFSImpl Deprecated. 
 use StringArray instead | 
| TypeImpl The implementation of types in the type system. | 
| TypeImpl_list | 
| XmiSerializationSharedData A container for data that is shared between the  XmiCasSerializerand theXmiCasDeserializer. | 
| Class and Description | 
|---|
| CASImpl Implements the CAS interfaces. | 
| LowLevelCAS Defines the low-level CAS APIs. | 
| LowLevelIndexRepository Low-level index repository access. | 
| Class and Description | 
|---|
| AnnotationBaseImpl Deprecated. 
 use AnnotationBase instead | 
| AnnotationImpl Deprecated. 
 use Annotation instead | 
| CASImpl Implements the CAS interfaces. | 
| FeatureStructureImpl Deprecated. 
 use TOP instead | 
| FeatureStructureImplC Feature structure implementation (for non JCas and JCas)
 
 Each FS has 
   - int data 
     - used for boolean, byte, short, int, long, float, double data
       -- long and double use 2 int slots
     - may be null if all slots are in JCas cover objects as fields
   - ref data
     - used for references to other Java objects, such as 
       -- strings
       -- other feature structures
       -- arbitrary Java Objects
     - may be null if all slots are in JCas cover objects as fields
   - an id: an incrementing integer, starting at 1, per CAS, of all FSs created for that CAS
   - a ref to the casView where this FS was created
   - a ref to the TypeImpl for this class
     -- can't be static - may be multiple type systems in use | 
| FSGenerator Deprecated. 
 unused in v3, only present to avoid compile errors in unused v2 classes | 
| TypeImpl The implementation of types in the type system. | 
| Class and Description | 
|---|
| TypeSystemImpl Type system implementation. | 
| XmiSerializationSharedData A container for data that is shared between the  XmiCasSerializerand theXmiCasDeserializer. | 
| Class and Description | 
|---|
| TypeSystemImpl Type system implementation. | 
| Class and Description | 
|---|
| FeatureImpl The implementation of features in the type system. | 
| SlotKinds.SlotKind | 
Copyright © 2006–2022 The Apache Software Foundation. All rights reserved.