| Package | Description | 
|---|---|
| org.apache.uima.analysis_engine.impl | |
| org.apache.uima.cas | Common Analysis System(CAS) Interfaces | 
| org.apache.uima.cas.admin | |
| org.apache.uima.cas.impl | Implementation and Low-Level API for the CAS Interfaces. | 
| 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.util | Utility classes and interfaces used by UIMA components. | 
| Modifier and Type | Field and Description | 
|---|---|
| static List<Type> | ResultSpecification_impl. EMPTY_TYPE_LISTused for empty type subsumption lists in subtype iterator | 
| Modifier and Type | Method and Description | 
|---|---|
| Type | CAS. getAnnotationType()Get the type object for the annotation type. | 
| Type | TypeSystem. getArrayType(Type componentType)Get or Create an array type with component type  componentType. | 
| default <T extends TOP> | CAS. getCasType(Class<T> clazz) | 
| Type | Type. getComponentType()For array types, returns the component type of the array type. | 
| Type | Feature. getDomain()Get the domain type for this feature. | 
| Type | TypeSystem. getParent(Type type)Get the parent type for input type. | 
| Type | Feature. getRange()Get the range type for this feature. | 
| Type | TypeSystem. getTopType()Get the top type, i.e., the root of the type system. | 
| default Type | FSIterator. getType() | 
| Type | FSIndex. getType()Return the type of feature structures this index contains. | 
| Type | FeatureStructure. getType()Get the type of this FS. | 
| Type | FeaturePath. getType(FeatureStructure fs)Returns the type of the feature path. | 
| Type | TypeSystem. getType(String typeName)Get a type object for a given type name. | 
| Type | TypeNameSpace. getType(String typeName) | 
| Modifier and Type | Method and Description | 
|---|---|
| Vector<Type> | TypeSystem. getDirectlySubsumedTypes(Type type)Deprecated. 
 Use  getDirectSubtypes(Type)instead. | 
| List<Type> | TypeSystem. getDirectSubtypes(Type type)Get a List of the types directly subsumed by a given type. | 
| List<Type> | TypeSystem. getProperlySubsumedTypes(Type type)Return the list of all types subsumed by the input type. | 
| Iterator<Type> | TypeSystem. getTypeIterator()Get an iterator over all types, in no particular order. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | FSTypeConstraint. add(Type type)Add a new type to this type constraint. | 
| <T extends AnnotationFS> | CAS. createAnnotation(Type type,
                int begin,
                int end)Create a new annotation. | 
| <T extends FeatureStructure> | CAS. createFS(Type type)Create a new FeatureStructure. | 
| default <T extends FeatureStructure> | CAS. emptyFSArray(Type type) | 
| <T extends FeatureStructure> | FSIndexRepository. getAllIndexedFS(Type aType)Gets an iterator over all indexed (in this View) FeatureStructures of the specified Type (and
 any of its subtypes). | 
| default <T extends TOP> | CAS. getAllIndexedFS(Type type)Gets an iterator over all indexed (in this CAS view) FeatureStructures of the specified Type
 (and any of its subtypes). | 
| <T extends AnnotationFS> | CAS. getAnnotationIndex(Type type)Get the standard annotation index restricted to a specific annotation type. | 
| Type | TypeSystem. getArrayType(Type componentType)Get or Create an array type with component type  componentType. | 
| Vector<Type> | TypeSystem. getDirectlySubsumedTypes(Type type)Deprecated. 
 Use  getDirectSubtypes(Type)instead. | 
| List<Type> | TypeSystem. getDirectSubtypes(Type type)Get a List of the types directly subsumed by a given type. | 
| <T extends FeatureStructure> | FSIndexRepository. getIndex(String label,
        Type type)Retrieve an index according to a label and a type. | 
| <T extends TOP> | FSIndexRepository. getIndexedFSs(Type type)Returns an unmodifiable collection of all the FSs of this type and its subtypes, that are
 indexed in this view, in an arbitrary order. | 
| default <T extends TOP> | CAS. getIndexedFSs(Type type)Returns an unmodifiable collection of all the FSs that are indexed in this view, in an
 arbitrary order. | 
| Type | TypeSystem. getParent(Type type)Get the parent type for input type. | 
| List<Type> | TypeSystem. getProperlySubsumedTypes(Type type)Return the list of all types subsumed by the input type. | 
| void | FSIndexRepository. removeAllExcludingSubtypes(Type type)Remove all instances of just this type, excluding subtypes, from all indexes in the repository
 view. | 
| void | FSIndexRepository. removeAllIncludingSubtypes(Type type)Remove all instances of type, including all subtypes from all indexes in the repository view. | 
| <N extends T> | FSIndex. select(Type type) | 
| default <T extends TOP> | CAS. select(Type type) | 
| default boolean | Type. subsumes(Type subtype) | 
| boolean | TypeSystem. subsumes(Type superType,
        Type subType)Does one type inherit from the other? | 
| default <U extends T> | FSIndex. subType(Type type) | 
| void | FeaturePath. typeInit(Type featurePathType)Check the feature path for the given type and initialize internal structures for faster access
 to the feature path value. | 
| Modifier and Type | Method and Description | 
|---|---|
| Type | TypeSystemMgr. addStringSubtype(String typeName,
                String[] stringList)Inherit from String. | 
| Type | TypeSystemMgr. addType(String typeName,
       Type mother)Add a new type to the type system. | 
| Type | FSIndexComparator. getType()Get the type of this comparator. | 
| Modifier and Type | Method and Description | 
|---|---|
| Feature | TypeSystemMgr. addFeature(String featureName,
          Type domainType,
          Type rangeType)Add an feature to the type system. | 
| Feature | TypeSystemMgr. addFeature(String featureName,
          Type domainType,
          Type rangeType,
          boolean multipleReferencesAllowed)Add an feature to the type system. | 
| Type | TypeSystemMgr. addType(String typeName,
       Type mother)Add a new type to the type system. | 
| boolean | LinearTypeOrder. lessThan(Type t1,
        Type t2)Compare two types. | 
| void | TypeSystemMgr. setFeatureFinal(Type type)Make type feature final in the sense that no new features can be added to this type. | 
| void | TypeSystemMgr. setInheritanceFinal(Type type)Block any further inheritance from this type. | 
| void | FSIndexComparator. setType(Type type)Set the type of this comparator. | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | TypeImplThe implementation of types in the type system. | 
| class  | TypeImpl_annotA version of TypeImpl for Annotations and subtypes of Annotations | 
| class  | TypeImpl_annotBaseA version of TypeImpl for the AnnotationBase type and its subtypes | 
| class  | TypeImpl_array | 
| class  | TypeImpl_list | 
| class  | TypeImpl_primitive | 
| class  | TypeImpl_stringString or String Subtype | 
| class  | TypeImpl_stringSubtype | 
| Modifier and Type | Method and Description | 
|---|---|
| Type | TypeSystemImpl. addStringSubtype(String typeName,
                String[] stringList) | 
| Type | CASImpl. getAnnotationType() | 
| Type | TypeSystemImpl. getArrayType(Type componentType) | 
| Type | TypeImpl_list. getCompoentType() | 
| Type | FeatureImpl. getDomain()Get the domain type for this feature. | 
| Type | TypeSystemImpl. getParent(Type t) | 
| Type | FeatureImpl. getRange()Get the range type for this feature. | 
| Type | LowLevelIterator_empty. getType() | 
| Type | FSIndexComparatorImpl. getType() | 
| Type | FsIndex_snapshot. getType() | 
| Type | FsIndex_singletype. getType() | 
| Type | FeatureStructureImplC. getType()Returns the UIMA TypeImpl value | 
| Type | TypeNameSpaceImpl. getType(String typeName) | 
| Type | LowLevelTypeSystem. ll_getTypeForCode(int typeCode)Get a type object for a given code. | 
| Type | TypeSystemImpl. ll_getTypeForCode(int typeCode) | 
| Modifier and Type | Method and Description | 
|---|---|
| Vector<Type> | TypeSystemImpl. getDirectlySubsumedTypes(Type type)Get a vector of the types directly subsumed by a given type. | 
| List<Type> | TypeSystemImpl. getDirectSubtypes(Type type) | 
| List<Type> | TypeSystemImpl. getProperlySubsumedTypes(Type type)Return the list of all types subsumed by the input type. | 
| Iterator<Type> | TypeSystemImpl. getTypeIterator()Get an iterator over all types, in no particular order. | 
| Iterator<Type> | TypeSystemImpl. iterator() | 
| Modifier and Type | Method and Description | 
|---|---|
| Feature | TypeSystemImpl. addFeature(String featureName,
          Type domainType,
          Type rangeType) | 
| Feature | TypeSystemImpl. addFeature(String shortFeatName,
          Type domainType,
          Type rangeType,
          boolean multipleReferencesAllowed) | 
| TypeImpl | TypeSystemImpl. addType(String typeName,
       Type superType)Add a new type to the type system. | 
| void | CASImpl. checkTypingConditions(Type domType,
                     Type ranType,
                     Feature feat)Check the range is appropriate for this type/feature. | 
| static int | TypeSystemUtils. classifyType(Type type)Classify types into FS type, array type etc. | 
| Annotation | CASImpl. createAnnotation(Type type,
                int begin,
                int end) | 
| <T extends FeatureStructure> | CASImpl. createFS(Type type)Create the appropriate Feature Structure Java instance - from whatever the generator for this
 type specifies. | 
| CommonArrayFS | CASImpl. emptyArray(Type type) | 
| <T extends FeatureStructure> | CASImpl. emptyFSArray(Type type) | 
| <T extends FeatureStructure> | FSIndexRepositoryImpl. getAllIndexedFS(Type type) | 
| <T extends AnnotationFS> | CASImpl. getAnnotationIndex(Type type) | 
| Type | TypeSystemImpl. getArrayType(Type componentType) | 
| Vector<Type> | TypeSystemImpl. getDirectlySubsumedTypes(Type type)Get a vector of the types directly subsumed by a given type. | 
| List<Type> | TypeSystemImpl. getDirectSubtypes(Type type) | 
| <T extends FeatureStructure> | FSIndexRepositoryImpl. getIndex(String label,
        Type type) | 
| <T extends TOP> | FSIndexRepositoryImpl. getIndexedFSs(Type type) | 
| Vector<Feature> | TypeSystemImpl. getIntroFeatures(Type type) | 
| Type | TypeSystemImpl. getParent(Type t) | 
| List<Type> | TypeSystemImpl. getProperlySubsumedTypes(Type type)Return the list of all types subsumed by the input type. | 
| default <U extends T> | LowLevelIndex. getSubIndex(Type type) | 
| boolean | CASImpl. isAbstractArrayType(Type type) | 
| boolean | TypeSystemImpl. isAnnotationBaseOrSubtype(Type type) | 
| boolean | TypeSystemImpl. isAnnotationOrSubtype(Type type) | 
| boolean | CASImpl. isAnnotationType(Type t) | 
| boolean | CASImpl. isArrayType(Type type) | 
| boolean | CASImpl. isBooleanArrayType(Type type) | 
| boolean | CASImpl. isBooleanType(Type type) | 
| boolean | CASImpl. isByteArrayType(Type type) | 
| boolean | CASImpl. isByteType(Type type) | 
| boolean | CASImpl. isDoubleArrayType(Type type) | 
| boolean | CASImpl. isDoubleType(Type type) | 
| boolean | CASImpl. isFloatArrayType(Type type) | 
| boolean | CASImpl. isFloatType(Type type) | 
| boolean | CASImpl. isFSArrayType(Type type) | 
| boolean | TypeSystemImpl. isInInt(Type rangeType) | 
| boolean | CASImpl. isIntArrayType(Type type) | 
| boolean | CASImpl. isIntType(Type type) | 
| boolean | CASImpl. isLongArrayType(Type type) | 
| boolean | CASImpl. isLongType(Type type) | 
| static TypeSystemUtils.PathValid | TypeSystemUtils. isPathValid(Type type,
           List<String> path)
 Given a starting Type and a list of features representing a feature path, checks if a feature
 path is valid for a given type. | 
| boolean | CASImpl. isPrimitiveArrayType(Type type) | 
| boolean | CASImpl. isShortArrayType(Type type) | 
| boolean | CASImpl. isShortType(Type type) | 
| boolean | CASImpl. isStringArrayType(Type type) | 
| boolean | CASImpl. isStringType(Type type) | 
| boolean | LinearTypeOrderBuilderImpl.TotalTypeOrder. lessThan(Type t1,
        Type t2) | 
| <T extends FeatureStructure> | FSIndexRepositoryImpl. ll_getAllIndexedFS(Type type) | 
| int | LowLevelTypeSystem. ll_getCodeForType(Type type)Get the code of an existing type object. | 
| int | TypeSystemImpl. ll_getCodeForType(Type type) | 
| TypeImpl | TypeSystemImpl. refreshType(Type t) | 
| void | FSIndexRepositoryImpl. removeAllExcludingSubtypes(Type type)Remove all instances of a particular type (but not its subtypes) from all indexes | 
| void | FSIndexRepositoryImpl. removeAllIncludingSubtypes(Type type)Remove all instances of a particular type (including its subtypes) from all indexes | 
| default <N extends T> | LowLevelIndex. select(Type type) | 
| void | TypeSystemImpl. setFeatureFinal(Type type) | 
| void | TypeSystemImpl. setInheritanceFinal(Type type) | 
| void | FSIndexComparatorImpl. setType(Type type) | 
| Stream<FsIndex_singletype<TOP>> | FSIndexRepositoryImpl. streamNonEmptyIndexes(Type type)Stream instances of all of the non-empty indexes themselves | 
| boolean | TypeSystemImpl. subsumes(Type superType,
        Type subType)Does one type inherit from the other?
 
 There are two versions. | 
| <N extends T> | SelectFSs_impl. type(Type uimaType) | 
| Constructor and Description | 
|---|
| FsIndex_singletype(CASImpl cas,
                  Type type,
                  int indexType,
                  FSIndexComparator comparatorForIndexSpecs)Constructor for FsIndex_singletype. | 
| IndexInfo(CAS cas,
         String indexName,
         Type type) | 
| Modifier and Type | Method and Description | 
|---|---|
| Type | JCas. getCasType(Class<? extends FeatureStructure> clazz)Return the UIMA Type object corresponding to this JCas's JCas cover class (Note: different
 JCas's, with different type systems, may share the same cover class impl) | 
| Type | JCas. getCasType(int i)Given Foo.type, return the corresponding CAS Type object. | 
| Type | JCas. getRequiredType(String s) | 
| Modifier and Type | Method and Description | 
|---|---|
| <T extends TOP> | JFSIndexRepository. getAllIndexedFS(Type aType)Gets an iterator over all indexed FeatureStructures of the specified Type (and any of its
 subtypes). | 
| default <T extends TOP> | JCas. getAllIndexedFS(Type type)Gets an iterator over all indexed FeatureStructures of the specified Type (and any of its
 subtypes). | 
| <T extends Annotation> | JCas. getAnnotationIndex(Type type)Get the standard annotation index restricted to a specific annotation type. | 
| default <T extends TOP> | JCas. getIndexedFSs(Type type)Returns an unmodifiable collection of all the FSs that are indexed in this view, in an
 arbitrary order. | 
| Feature | JCas. getRequiredFeature(Type t,
                  String s) | 
| default Feature | JCas. getRequiredFeatureDE(Type t,
                    String s,
                    String rangeName,
                    boolean featOkTst)Deprecated.  | 
| default <N extends TOP> | JCas. select(Type type) | 
| Modifier and Type | Field and Description | 
|---|---|
| Type | TOP_Type. casTypeDeprecated.  the Cas Type associated with this Java Cas Model class | 
| Modifier and Type | Method and Description | 
|---|---|
| <U extends T> | FSList. select(Type filterByType)Treat an FSArray as a source for SelectFSs. | 
| default <U extends T> | SelectViaCopyToArray. select(Type filterByType)Treat an FSArray as a source for SelectFSs. | 
| Constructor and Description | 
|---|
| AnnotationBase_Type(JCas jcas,
                   Type casType)Deprecated.  | 
| TOP_Type(JCas jcas,
        Type casType)Deprecated.  | 
| TOP_Type(JCas jcas,
        Type casType,
        boolean installGenerator)Deprecated.  | 
| Modifier and Type | Method and Description | 
|---|---|
| Type | JCasImpl. getCasType(Class<? extends FeatureStructure> clazz)Return the UIMA Type object corresponding to this JCas's JCas cover class (Note: different
 JCas's, with different type systems, may share the same cover class impl) | 
| Type | JCasImpl. getCasType(int i) | 
| Type | JCasImpl. getRequiredType(String s) | 
| Modifier and Type | Method and Description | 
|---|---|
| TOP | JCasImpl. createFS(Type type) | 
| <T extends TOP> | JFSIndexRepositoryImpl. getAllIndexedFS(Type aType) | 
| <T extends Annotation> | JCasImpl. getAnnotationIndex(Type type) | 
| Feature | JCasImpl. getRequiredFeature(Type t,
                  String s) | 
| Constructor and Description | 
|---|
| Annotation_Type(JCas jcas,
               Type casType)Deprecated.  | 
| Modifier and Type | Method and Description | 
|---|---|
| static String[] | TypeSystemUtil. getAllowedValuesForType(Type aType,
                       TypeSystem aTypeSystem)Gets the allowed values for a string subtype. | 
| static TypeDescription | TypeSystemUtil. type2TypeDescription(Type aType,
                    TypeSystem aTypeSystem)Convert a  Typeto an equivalentTypeDescription. | 
Copyright © 2006–2022 The Apache Software Foundation. All rights reserved.