## Uses of Interface
org.apache.uima.cas.Type

- Packages that use Type
  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.examples |
  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 | JCAS model for built-in TCAS types
  org.apache.uima.util | Utility classes and interfaces used by UIMA components.

- - ### Uses of Type in org.apache.uima.analysis_engine.impl

    Fields in org.apache.uima.analysis_engine.impl with type parameters of type Type
    Modifier and Type | Field and Description
    --- | ---
    `static List<Type>` | ResultSpecification_impl.`EMPTY_TYPE_LIST` used for empty type subsumption lists in subtype iterator

  - ### Uses of Type in org.apache.uima.cas

    Methods in org.apache.uima.cas that return Type
    Modifier and Type | Method and Description
    --- | ---
    `Type` | CAS.`getAnnotationType()` Get the type object for the annotation type.
    `Type` | TypeSystem.`getArrayType(Type componentType)` Obtain an array type with component type `componentType`.
    `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.
    `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)`

    Methods in org.apache.uima.cas that return types with arguments of type Type
    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.

    Methods in org.apache.uima.cas with parameters of type Type
    Modifier and Type | Method and Description
    --- | ---
    `void` | FSTypeConstraint.`add(Type type)` Add a new type to this type constraint.
    `<T extends AnnotationFS> AnnotationFS` | CAS.`createAnnotation(Type type, int begin, int end)` Create a new annotation.
    `<T extends FeatureStructure> T` | CAS.`createFS(Type type)` Create a new FeatureStructure.
    `<T extends FeatureStructure> FSIterator<T>` | FSIndexRepository.`getAllIndexedFS(Type aType)` Gets an iterator over all indexed FeatureStructures of the specified Type (and any of its subtypes).
    `<T extends AnnotationFS> AnnotationIndex<T>` | CAS.`getAnnotationIndex(Type type)` Get the standard annotation index restricted to a specific annotation type.
    `Type` | TypeSystem.`getArrayType(Type componentType)` Obtain 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> FSIndex<T>` | FSIndexRepository.`getIndex(String label, Type type)` Retrieve an index according to a label and a type.
    `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.
    `boolean` | TypeSystem.`subsumes(Type superType, Type subType)` Does one type inherit from the other?
    `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.

  - ### Uses of Type in org.apache.uima.cas.admin

    Methods in org.apache.uima.cas.admin that return Type
    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.

    Methods in org.apache.uima.cas.admin with parameters of type Type
    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.

  - ### Uses of Type in org.apache.uima.cas.impl

    Classes in org.apache.uima.cas.impl that implement Type
    Modifier and Type | Class and Description
    --- | ---
    `class` | `StringTypeImpl` Class comment for StringTypeImpl.java goes here.
    `class` | `TypeImpl` The implementation of types in the type system.

    Methods in org.apache.uima.cas.impl that return Type
    Modifier and Type | Method and Description
    --- | ---
    `Type` | TypeSystemImpl.`addStringSubtype(String typeName, String[] stringList)`
    `Type` | TypeSystemImpl.`addTopType(String name)` Add a top type to the (empty) type system.
    `Type` | TypeSystemImpl.`addType(String typeName, Type mother)` Add a new type to the type system.
    `Type` | CASImpl.`getAnnotationType()`
    `Type` | TypeSystemImpl.`getArrayType(Type componentType)`
    `Type` | TypeImpl.`getComponentType()`
    `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` | TypeImpl.`getSuperType()` Get the super type.
    `Type` | TypeSystemImpl.`getTopType()` Get the top type, i.e., the root of the type system.
    `Type` | FSIndexComparatorImpl.`getType()`
    `Type` | FSLeafIndexImpl.`getType()`
    `Type` | AnnotationIndexImpl.`getType()`
    `Type` | FeatureStructureImpl.`getType()`
    `Type` | TypeNameSpaceImpl.`getType(String typeName)`
    `Type` | TypeSystemImpl.`getType(String typeName)` Get a type object for a given name.
    `Type` | LowLevelTypeSystem.`ll_getTypeForCode(int typeCode)` Get a type object for a given code.
    `Type` | TypeSystemImpl.`ll_getTypeForCode(int typeCode)`

    Methods in org.apache.uima.cas.impl that return types with arguments of type Type
    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)`
    `Iterator<Type>` | TypeSystemImpl.`getDirectSubtypesIterator(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.

    Methods in org.apache.uima.cas.impl with parameters of type Type
    Modifier and Type | Method and Description
    --- | ---
    `Feature` | TypeSystemImpl.`addFeature(String featureName, Type domainType, Type rangeType)`
    `Feature` | TypeSystemImpl.`addFeature(String featureName, Type domainType, Type rangeType, boolean multipleReferencesAllowed)`
    `Type` | TypeSystemImpl.`addType(String typeName, Type mother)` 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.
    `AnnotationFS` | CASImpl.`createAnnotation(Type type, int begin, int end)`
    `<T extends FeatureStructure> T` | CASImpl.`createFS(Type type)`
    `<T extends FeatureStructure> FSIterator<T>` | FSIndexRepositoryImpl.`getAllIndexedFS(Type type)`
    `<T extends AnnotationFS> AnnotationIndex<T>` | 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)`
    `Iterator<Type>` | TypeSystemImpl.`getDirectSubtypesIterator(Type type)`
    `<T extends FeatureStructure> FSIndex<T>` | FSIndexRepositoryImpl.`getIndex(String label, Type type)`
    `int` | FSIndexRepositoryImpl.`getIndexSize(Type type)`
    `org.apache.uima.internal.util.IntPointerIterator` | FSIndexRepositoryImpl.`getIntIteratorForIndex(String label, 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.
    `boolean` | CASImpl.`isAbstractArrayType(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` | 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)` Checks if a feature path is valid for a given type.
    `boolean` | CASImpl.`isShortArrayType(Type type)`
    `boolean` | CASImpl.`isShortType(Type type)`
    `boolean` | CASImpl.`isStringArrayType(Type type)`
    `boolean` | CASImpl.`isStringType(Type type)`
    `LowLevelIterator` | 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)`
    `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
    `void` | TypeSystemImpl.`setFeatureFinal(Type type)`
    `void` | TypeSystemImpl.`setInheritanceFinal(Type type)`
    `void` | FSIndexComparatorImpl.`setType(Type type)`
    `boolean` | TypeSystemImpl.`subsumes(Type superType, Type subType)` Does one type inherit from the other?

    Constructors in org.apache.uima.cas.impl with parameters of type Type
    Constructor and Description
    `FSLeafIndexImpl(CASImpl cas, Type type, int indexType)` Constructor for FSLeafIndexImpl.
    `FSRBTSetIndex(CASImpl cas, Type type, int indexType)` Constructor for FSRBTIndex.
    `IndexInfo(CAS cas, String indexName, Type type)`

  - ### Uses of Type in org.apache.uima.examples

    Constructors in org.apache.uima.examples with parameters of type Type
    Constructor and Description
    `SourceDocumentInformation_Type(JCas jcas, Type casType)` initialize variables to correspond with Cas Type and Features

  - ### Uses of Type in org.apache.uima.jcas

    Methods in org.apache.uima.jcas that return Type
    Modifier and Type | Method and Description
    --- | ---
    `Type` | JCas.`getCasType(int i)` Given Foo.type, return the corresponding CAS Type object.
    `Type` | JCas.`getRequiredType(String s)`

    Methods in org.apache.uima.jcas with parameters of type Type
    Modifier and Type | Method and Description
    --- | ---
    `<T extends TOP> FSIterator<T>` | JFSIndexRepository.`getAllIndexedFS(Type aType)` Gets an iterator over all indexed FeatureStructures of the specified Type (and any of its subtypes).
    `<T extends Annotation> AnnotationIndex<T>` | JCas.`getAnnotationIndex(Type type)` Get the standard annotation index restricted to a specific annotation type.
    `Feature` | JCas.`getRequiredFeature(Type t, String s)`
    `Feature` | JCas.`getRequiredFeatureDE(Type t, String s, String rangeName, boolean featOkTst)`

  - ### Uses of Type in org.apache.uima.jcas.cas

    Fields in org.apache.uima.jcas.cas declared as Type
    Modifier and Type | Field and Description
    --- | ---
    `Type` | TOP_Type.`casType` the Cas Type associated with this Java Cas Model class

    Constructors in org.apache.uima.jcas.cas with parameters of type Type
    Constructor and Description
    `AnnotationBase_Type(JCas jcas, Type casType)`
    `BooleanArray_Type(JCas jcas, Type casType)`
    `ByteArray_Type(JCas jcas, Type casType)`
    `CommonArray_Type(JCas jcas, Type casType)`
    `DoubleArray_Type(JCas jcas, Type casType)`
    `EmptyFloatList_Type(JCas jcas, Type casType)`
    `EmptyFSList_Type(JCas jcas, Type casType)`
    `EmptyIntegerList_Type(JCas jcas, Type casType)`
    `EmptyStringList_Type(JCas jcas, Type casType)`
    `FloatArray_Type(JCas jcas, Type casType)`
    `FloatList_Type(JCas jcas, Type casType)`
    `FSArray_Type(JCas jcas, Type casType)`
    `FSList_Type(JCas jcas, Type casType)`
    `IntegerArray_Type(JCas jcas, Type casType)`
    `IntegerList_Type(JCas jcas, Type casType)`
    `LongArray_Type(JCas jcas, Type casType)`
    `NonEmptyFloatList_Type(JCas jcas, Type casType)`
    `NonEmptyFSList_Type(JCas jcas, Type casType)`
    `NonEmptyIntegerList_Type(JCas jcas, Type casType)`
    `NonEmptyStringList_Type(JCas jcas, Type casType)`
    `ShortArray_Type(JCas jcas, Type casType)`
    `Sofa_Type(JCas jcas, Type casType)` initialize variables to correspond with Cas Type and Features
    `StringArray_Type(JCas jcas, Type casType)`
    `StringList_Type(JCas jcas, Type casType)`
    `TOP_Type(JCas jcas, Type casType)`
    `TOP_Type(JCas jcas, Type casType, boolean installGenerator)`

  - ### Uses of Type in org.apache.uima.jcas.impl

    Methods in org.apache.uima.jcas.impl that return Type
    Modifier and Type | Method and Description
    --- | ---
    `Type` | JCasImpl.`getCasType(Class<? extends TOP> 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)` Make the instance of the JCas xxx_Type class for this CAS.

    Methods in org.apache.uima.jcas.impl with parameters of type Type
    Modifier and Type | Method and Description
    --- | ---
    `<T extends TOP> FSIterator<T>` | JFSIndexRepositoryImpl.`getAllIndexedFS(Type aType)`
    `<T extends Annotation> AnnotationIndex<T>` | JCasImpl.`getAnnotationIndex(Type type)`
    `Feature` | JCasImpl.`getRequiredFeature(Type t, String s)`
    `Feature` | JCasImpl.`getRequiredFeatureDE(Type t, String s, String rangeName, boolean featOkTst)`

  - ### Uses of Type in org.apache.uima.jcas.tcas

    Constructors in org.apache.uima.jcas.tcas with parameters of type Type
    Constructor and Description
    `Annotation_Type(JCas jcas, Type casType)`
    `DocumentAnnotation_Type(JCas jcas, Type casType)`

  - ### Uses of Type in org.apache.uima.util

    Methods in org.apache.uima.util with parameters of type Type
    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 `Type` to an equivalent `TypeDescription`.

Copyright © 2006–2021 The Apache Software Foundation. All rights reserved.