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

- Packages that use TypeSystem
  Package | Description
  --- | ---
  org.apache.uima.analysis_component |
  org.apache.uima.analysis_engine | The Analysis Engine interface, along with supporting interfaces and exception classes.
  org.apache.uima.analysis_engine.annotator | The Annotator Interfaces, along with supporting interfaces and exception classes.
  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.collection | Classes and interfaces for collection processing.
  org.apache.uima.collection.base_cpm |
  org.apache.uima.flow |
  org.apache.uima.jcas | Interfaces for accessing the JCAS.
  org.apache.uima.jcas.impl | Provides the classes that support the Java Cas Model (JCM).
  org.apache.uima.json |
  org.apache.uima.uimacpp |
  org.apache.uima.util | Utility classes and interfaces used by UIMA components.

- - ### Uses of TypeSystem in org.apache.uima.analysis_component

    Methods in org.apache.uima.analysis_component with parameters of type TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `void` | CasMultiplier_ImplBase.`typeSystemInit(TypeSystem aTypeSystem)` Informs this annotator that the CAS TypeSystem has changed.
    `void` | CasAnnotator_ImplBase.`typeSystemInit(TypeSystem aTypeSystem)` Informs this annotator that the CAS TypeSystem has changed.

  - ### Uses of TypeSystem in org.apache.uima.analysis_engine

    Methods in org.apache.uima.analysis_engine that return TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `TypeSystem` | ResultSpecification.`getTypeSystem()` get the type system associated with this result specification.

    Methods in org.apache.uima.analysis_engine with parameters of type TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `void` | ResultSpecification.`compile(TypeSystem aTypeSystem)` Deprecated. as of 2.2.2 Now called automatically internally when needed
    `ResultSpecification` | AnalysisEngine.`createResultSpecification(TypeSystem aTypeSystem)` A factory method used to create an instance of `ResultSpecification` for use with this AnalysisEngine.
    `void` | ResultSpecification.`setTypeSystem(TypeSystem ts)` set the type system associated with this result specification.

  - ### Uses of TypeSystem in org.apache.uima.analysis_engine.annotator

    Methods in org.apache.uima.analysis_engine.annotator that return TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `protected TypeSystem` | Annotator_ImplBase.`getTypeSystem()` Deprecated. Gets the `TypeSystem` that was passed to the most recent call to `Annotator_ImplBase.typeSystemInit(TypeSystem)`.

    Methods in org.apache.uima.analysis_engine.annotator with parameters of type TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `void` | BaseAnnotator.`typeSystemInit(TypeSystem aTypeSystem)` Informs this annotator that the CAS TypeSystem has changed.
    `void` | Annotator_ImplBase.`typeSystemInit(TypeSystem aTypeSystem)` Deprecated. The only thing this implementation does is store the TypeSystem so that it can be accessed by the `Annotator_ImplBase.getTypeSystem()` method, and also so that it can be passed back to the `Annotator_ImplBase.typeSystemInit(TypeSystem)` method by the default implementation of `Annotator_ImplBase.reconfigure()`.

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

    Methods in org.apache.uima.analysis_engine.impl that return TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `TypeSystem` | ResultSpecification_impl.`getTypeSystem()`

    Methods in org.apache.uima.analysis_engine.impl with parameters of type TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `void` | ResultSpecification_impl.`compile(TypeSystem aTypeSystem)` Deprecated. no longer needed, remove call to this
    `ResultSpecification` | PearAnalysisEngineWrapper.`createResultSpecification(TypeSystem typeSystem)`
    `ResultSpecification` | AnalysisEngineImplBase.`createResultSpecification(TypeSystem aTypeSystem)`
    `void` | ResultSpecification_impl.`setTypeSystem(TypeSystem ts)`
    `void` | PearAnalysisEngineWrapper.`typeSystemInit(TypeSystem typeSystem)`
    `void` | AnalysisEngineImplBase.`typeSystemInit(TypeSystem aTypeSystem)` From the CAS Processor interface.

    Constructors in org.apache.uima.analysis_engine.impl with parameters of type TypeSystem
    Constructor and Description
    `ResultSpecification_impl(TypeSystem aTypeSystem)` Constructor specifying the type system this should always be used in preference to the 0 argument version if the type system is available.

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

    Methods in org.apache.uima.cas that return TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `TypeSystem` | CAS.`getTypeSystem()` Return the type system of this CAS instance.

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

    Subinterfaces of TypeSystem in org.apache.uima.cas.admin
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `TypeSystemMgr` Writable version of type system.

    Methods in org.apache.uima.cas.admin that return TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `TypeSystem` | TypeSystemMgr.`commit()` Commit the type system, and load JCas Classes from the UIMA Framework's classloader.
    `TypeSystem` | TypeSystemMgr.`commit(ClassLoader cl)` Commit the type system, and load JCas classes from the passed in classloader.

    Methods in org.apache.uima.cas.admin with parameters of type TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `static CASMgr` | CASFactory.`createCAS(int initialHeapSize, TypeSystem ts)` Create a new CASMgr object from a give type system.
    `static CASMgr` | CASFactory.`createCAS(int initialHeapSize, TypeSystem ts, boolean useJcasCache)`
    `static CASMgr` | CASFactory.`createCAS(TypeSystem ts)` Create a new CASMgr object from a give type system.
    `static CASMgr` | CASFactory.`createCAS(TypeSystem ts, boolean useJcasCache)`

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

    Classes in org.apache.uima.cas.impl that implement TypeSystem
    Modifier and Type | Class and Description
    --- | ---
    `class` | `TypeSystemImpl` Type system implementation.

    Methods in org.apache.uima.cas.impl that return TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `TypeSystem` | CASImpl.`getTypeSystem()`

    Methods in org.apache.uima.cas.impl with parameters of type TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `static void` | TypeSystemImpl.`compareTs(TypeSystem t1, TypeSystem t2)`
    `static LinearTypeOrder` | LinearTypeOrderBuilderImpl.`createTypeOrder(int[] typeList, TypeSystem ts)` The constructor for the total type order, called by the other constructor and also when doing a cas complete deserialization, or just deserializing the type system/index defs
    `static BinaryCasSerDes6` | Serialization.`deserializeCAS(CAS cas, InputStream istream, TypeSystem tgtTypeSystem, BinaryCasSerDes6.ReuseInfo reuseInfo)` Deserialize a CAS, in various binary formats, into an existing CAS Note: this form supports deserializing the following binary representations: - compressed, type filtering (form 6), delta and not-delta.
    `static BinaryCasSerDes6` | Serialization.`deserializeCAS(CAS cas, InputStream istream, TypeSystem tgtTypeSystem, BinaryCasSerDes6.ReuseInfo reuseInfo, AllowPreexistingFS allowPreexisting)` Deserialize a CAS, in various binary formats, into an existing CAS Note: this form supports deserializing the following binary representations: - compressed, type filtering (form 6), delta and not-delta.
    `static void` | XmiCasSerializer.`serialize(CAS aCAS, TypeSystem aTargetTypeSystem, OutputStream aStream)` Serializes a CAS to an XMI stream.
    `static void` | XmiCasSerializer.`serialize(CAS aCAS, TypeSystem aTargetTypeSystem, OutputStream aStream, boolean aPrettyPrint, XmiSerializationSharedData aSharedData)` Serializes a CAS to an XMI stream.
    `static void` | XmiCasSerializer.`serialize(CAS aCAS, TypeSystem aTargetTypeSystem, OutputStream aStream, boolean aPrettyPrint, XmiSerializationSharedData aSharedData, Marker aMarker)` Serializes a Delta CAS to an XMI stream.
    `static void` | XmiCasSerializer.`serialize(CAS aCAS, TypeSystem aTargetTypeSystem, OutputStream aStream, boolean aPrettyPrint, XmiSerializationSharedData aSharedData, Marker aMarker, boolean useXml_1_1)` Serializes a Delta CAS to an XMI stream.
    `static BinaryCasSerDes6.ReuseInfo` | Serialization.`serializeWithCompression(CAS cas, Object out, TypeSystem tgtTypeSystem)` Serialize in compressed binary with type filtering This method can use type filtering to omit sending those types and/or features not present in the target type system.
    `static void` | Serialization.`serializeWithCompression(CAS cas, Object out, TypeSystem tgtTypeSystem, Marker mark, BinaryCasSerDes6.ReuseInfo reuseInfo)` Delta Serialize in compressed form, with type filtering This method can use type filtering to omit sending those types and/or features not present in the target type system.
    `static void` | TypeSystem2Xml.`typeSystem2Xml(TypeSystem aTypeSystem, ContentHandler aContentHandler)` Traverses a TypeSystem and calls SAX events on the specified ContentHandler.
    `static void` | TypeSystem2Xml.`typeSystem2Xml(TypeSystem aTypeSystem, OutputStream aOutputStream)` Converts a TypeSystem object to XML.

    Constructors in org.apache.uima.cas.impl with parameters of type TypeSystem
    Constructor and Description
    `LinearTypeOrderBuilderImpl(TypeSystem ts)`
    `XCASDeserializer(TypeSystem ts)`
    `XCASDeserializer(TypeSystem ts, UimaContext uimaContext)` Create a new deserializer from a type system.
    `XCASSerializer(TypeSystem ts)`
    `XCASSerializer(TypeSystem ts, UimaContext uimaContext)`
    `XmiCasDeserializer(TypeSystem ts)`
    `XmiCasDeserializer(TypeSystem ts, UimaContext uimaContext)` Create a new deserializer from a type system.
    `XmiCasSerializer(TypeSystem ts)` Creates a new XmiCasSerializer.
    `XmiCasSerializer(TypeSystem ts, Map<String,String> nsUriToSchemaLocationMap)` Creates a new XmiCasSerializer.
    `XmiCasSerializer(TypeSystem ts, Map<String,String> nsUriToSchemaLocationMap, boolean isFormattedOutput)` Creates a new XmiCasSerializer
    `XmiCasSerializer(TypeSystem ts, UimaContext uimaContext)` Deprecated. Use `XmiCasSerializer(TypeSystem)` instead. The UimaContext reference is never used by this implementation.
    `XmiCasSerializer(TypeSystem ts, UimaContext uimaContext, Map<String,String> nsUriToSchemaLocationMap)` Deprecated. Use `XmiCasSerializer(TypeSystem, Map)` instead. The UimaContext reference is never used by this implementation.

  - ### Uses of TypeSystem in org.apache.uima.collection

    Methods in org.apache.uima.collection with parameters of type TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `void` | CasInitializer.`typeSystemInit(TypeSystem aTypeSystem)` Deprecated. Informs this CasInitializer that the CAS TypeSystem has changed.
    `void` | CasInitializer_ImplBase.`typeSystemInit(TypeSystem arg0)` Deprecated.
    `void` | CasConsumer_ImplBase.`typeSystemInit(TypeSystem arg0)`
    `void` | CollectionReader_ImplBase.`typeSystemInit(TypeSystem aTypeSystem)` Default implementation of typeSystemInit, which calls the CAS Initializer's typeSystemInit method if a CAS Initializer is present.
    `void` | CollectionReader.`typeSystemInit(TypeSystem aTypeSystem)` Informs this CollectionReader that the CAS TypeSystem has changed.

  - ### Uses of TypeSystem in org.apache.uima.collection.base_cpm

    Methods in org.apache.uima.collection.base_cpm with parameters of type TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `void` | CasObjectProcessor.`typeSystemInit(TypeSystem aTypeSystem)` Informs this CasConsumer that the CAS TypeSystem has changed.

  - ### Uses of TypeSystem in org.apache.uima.flow

    Methods in org.apache.uima.flow with parameters of type TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `void` | CasFlowController_ImplBase.`typeSystemInit(TypeSystem aTypeSystem)` This method may be overriden by subclasses.

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

    Methods in org.apache.uima.jcas that return TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `TypeSystem` | JCas.`getTypeSystem()` Return the type system of this CAS instance.

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

    Methods in org.apache.uima.jcas.impl that return TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `TypeSystem` | JCasImpl.`getTypeSystem()`

  - ### Uses of TypeSystem in org.apache.uima.json

    Methods in org.apache.uima.json with parameters of type TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `static void` | JsonCasSerializer.`jsonSerialize(CAS aCAS, TypeSystem aTargetTypeSystem, Object output)` Serializes a CAS to an output (File, OutputStream, XMI stream, or Writer).
    `static void` | JsonCasSerializer.`jsonSerialize(CAS aCAS, TypeSystem aTargetTypeSystem, Object output, boolean aPrettyPrint, Marker aMarker, XmiSerializationSharedData sharedData)` Serializes a Delta CAS to an output (File, Writer, or OutputStream).

  - ### Uses of TypeSystem in org.apache.uima.uimacpp

    Methods in org.apache.uima.uimacpp with parameters of type TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `void` | UimacppAnalysisComponent.`typeSystemInit(TypeSystem ts)`

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

    Methods in org.apache.uima.util with parameters of type TypeSystem
    Modifier and Type | Method and Description
    --- | ---
    `static CAS` | CasCreationUtils.`createCas(CasDefinition casDef, Properties performanceTuningSettings, TypeSystem typeSystem)` Create a CAS from a CAS Definition, but reuse the provided TypeSystem object.
    `static CAS` | CasCreationUtils.`createCas(Collection<? extends MetaDataObject> aComponentDescriptionsOrMetaData, TypeSystem aTypeSystem, Properties aPerformanceTuningSettings)` Creates a new CAS instance for a collection of CAS Processors, which.
    `static CAS` | CasCreationUtils.`createCas(Collection<? extends MetaDataObject> aComponentDescriptionsOrMetaData, TypeSystem aTypeSystem, Properties aPerformanceTuningSettings, ResourceManager aResourceManager)` Creates a new CAS instance for a collection of CAS Processors, which.
    `static CAS` | CasCreationUtils.`createCas(TypeSystem aTypeSystem, TypePriorities aTypePriorities, FsIndexDescription[] aFsIndexes, Properties aPerformanceTuningSettings)` Creates a new CAS instance that reuses an existing type system.
    `static CAS` | CasCreationUtils.`createCas(TypeSystem aTypeSystem, TypePriorities aTypePriorities, FsIndexDescription[] aFsIndexes, Properties aPerformanceTuningSettings, ResourceManager aResourceManager)` Creates a new CAS instance that reuses an existing type system.
    `static String[]` | TypeSystemUtil.`getAllowedValuesForType(Type aType, TypeSystem aTypeSystem)` Gets the allowed values for a string subtype.
    `static SerialFormat` | CasIOUtils.`load(InputStream casInputStream, CAS aCAS, TypeSystem typeSystem)` This load variant can be used for loading Form 6 compressed CASes where the type system to use to deserialize is provided as an argument.
    `static void` | XmlCasSerializer.`serialize(CAS aCAS, TypeSystem aTargetTypeSystem, OutputStream aStream)` Serializes a CAS to XMI format and writes it to an output stream.
    `static TypeDescription` | TypeSystemUtil.`type2TypeDescription(Type aType, TypeSystem aTypeSystem)` Convert a `Type` to an equivalent `TypeDescription`.
    `static TypeSystemDescription` | TypeSystemUtil.`typeSystem2TypeSystemDescription(TypeSystem aTypeSystem)` Convert a `TypeSystem` to an equivalent `TypeSystemDescription`.

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