Uses of Package
org.apache.uima.cas.impl
Package
Description
Apache UIMA
Common Analysis System(CAS) Interfaces
Implementation and Low-Level API for the CAS Interfaces.
Apache UIMA internals
Interfaces for accessing the JCAS.
JCAS model for built-in CAS types
Provides the classes that support the Java Cas Model (JCM).
Interfaces for
Resources
and ResourceSpecifiers
.-
ClassDescriptionFeature 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
-
ClassDescriptionDefines the low-level CAS APIs.Low-level FS index object.Low-level version of the type system APIs.
-
ClassDescriptionBinary (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.Compression alternativesUser callable serialization and deserialization of the CAS in a compressed Binary Format This serializes/deserializes the state of the CAS.Compression alternativesInfo 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..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 indexedImplements the CAS interfaces.Container for serialized CAS typing information.This object has 2 purposes.CAS serializer support for XMI and JSON formats.states the CAS can be inThis class gets initialized with two type systems, and then provides resources to map type and feature codes between them.HEADERS Serialization versioning There are 1 or 2 words used for versioning.common APIs supporting the copy on write aspect of index partsClass holding information about an FSIndex Includes the "label" of the index, and a ref to the CAS this index contents are in.Class holding info about a View/Sofa.The implementation of features in the type system.Deprecated.use TOP insteadFeature 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 useContains CAS Type and Feature objects to represent a feature path of the form feature1/.../featureN.There is one **class** instance of this per UIMA core class loader.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.A Functional Interface for generating V3 Java Feature StructuresCommon part of flattened indexes, used for both snapshot iterators and flattened sorted indexes built from passed in instance of FsIndex_iicpThe 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.Specifies the comparison to be used for an index, in terms of - the keys and the typeorder, in an order - the standard/reverse orderingThere is one instance of this class per CAS View.Common code for both aggregation of indexes (e.g.Defines the low-level CAS APIs.Low-level FS index object.Low-level index repository access.Low-level FS iterator.An empty Low-level FS iteratorLow-level version of the type system APIs.A MarkerImpl holds a high-water "mark" in the CAS, for all views.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.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 compatibilityUsers "implement" this interface to get access to these constants in their codeThe implementation of types in the type system.A version of TypeImpl for the AnnotationBase type and its subtypesString or String SubtypeThis interface defines static final constants for Type Systems For the built-in types and features: - the type and feature codes - the adjOffsetsType system implementation.CAS serializer for XMI format; writes a CAS in the XML Metadata Interchange (XMI) format.A container for data that is shared between the
XmiCasSerializer
and theXmiCasDeserializer
.Data structure holding all information about an XMI element containing an out-of-typesystem FS.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. -
ClassDescriptionDeprecated.use AnnotationBase insteadDeprecated.use Annotation insteadImplements the CAS interfaces.Deprecated.use TOP insteadFeature 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 useThe implementation of types in the type system.
-
-
ClassDescriptionImplements the CAS interfaces.Defines the low-level CAS APIs.Low-level index repository access.
-
ClassDescriptionDeprecated.use AnnotationBase insteadDeprecated.use BooleanArray insteadDeprecated.use ByteArray insteadImplements the CAS interfaces.Use an inner class to hold the data for serializing a CAS.Deprecated.use DoubleArray insteadDeprecated.use TOP insteadFeature 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 useDeprecated.use FloatArray insteadDeprecated.unused in v3, only present to avoid compile errors in unused v2 classesDeprecated.use IntegerArray insteadDeprecated.use LongArray insteadDefines the low-level CAS APIs.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 compatibilityDeprecated.use ShortArray insteadDeprecated.use Sofa insteadDeprecated.use StringArray insteadThe implementation of types in the type system.A container for data that is shared between the
XmiCasSerializer
and theXmiCasDeserializer
. -
ClassDescriptionImplements the CAS interfaces.Defines the low-level CAS APIs.Low-level index repository access.
-
ClassDescriptionDeprecated.use AnnotationBase insteadDeprecated.use Annotation insteadImplements the CAS interfaces.Deprecated.use TOP insteadFeature 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 useDeprecated.unused in v3, only present to avoid compile errors in unused v2 classesThe implementation of types in the type system.
-
ClassDescriptionType system implementation.A container for data that is shared between the
XmiCasSerializer
and theXmiCasDeserializer
. -
-