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

- Packages that use CAS
  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.asb | Contains the Analysis Structure Broker (ASB) interface, along with supporting interfaces and exception classes.
  org.apache.uima.analysis_engine.asb.impl |
  org.apache.uima.analysis_engine.impl |
  org.apache.uima.analysis_engine.service.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.flow.impl |
  org.apache.uima.impl | Contains reference implementations of the interfaces in `org.apache.uima`.
  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.json |
  org.apache.uima.resource | Interfaces for `Resources` and `ResourceSpecifiers`.
  org.apache.uima.resource.impl |
  org.apache.uima.resource.metadata | Interfaces for objects that represent metadata for a Resource.
  org.apache.uima.resource.metadata.impl |
  org.apache.uima.uimacpp |
  org.apache.uima.util | Utility classes and interfaces used by UIMA components.

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

    Methods in org.apache.uima.analysis_component that return CAS
    Modifier and Type | Method and Description
    --- | ---
    `protected CAS` | CasMultiplier_ImplBase.`getEmptyCAS()` Gets an empty CAS that this CAS Multiplier can then populate.

    Methods in org.apache.uima.analysis_component that return types with arguments of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `Class<CAS>` | CasMultiplier_ImplBase.`getRequiredCasInterface()`
    `Class<CAS>` | CasAnnotator_ImplBase.`getRequiredCasInterface()`

    Methods in org.apache.uima.analysis_component with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `abstract void` | CasMultiplier_ImplBase.`process(CAS aCAS)` This method should be overriden by subclasses.
    `abstract void` | CasAnnotator_ImplBase.`process(CAS aCAS)` Inputs a CAS to the AnalysisComponent.

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

    Methods in org.apache.uima.analysis_engine that return CAS
    Modifier and Type | Method and Description
    --- | ---
    `CAS` | AnalysisProcessData.`getCAS()` Deprecated. Gets the Common Analysis System (`CAS`), from which the AnalysisEngine obtains the information to be processed, and to which the AnalysisEngine writes new annotation information.
    `CAS` | AnalysisEngine.`newCAS()` Creates a new Common Analysis System appropriate for this Analysis Engine.
    `CAS` | CasIterator.`next()` Gets the next CAS from the iterator.

    Methods in org.apache.uima.analysis_engine with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `void` | AnalysisEngineServiceStub.`callProcess(CAS aCAS)` Performs service call to process an entity.
    `ProcessTrace` | AnalysisEngine.`process(CAS aCAS)` Invokes this AnalysisEngine's analysis logic.
    `ProcessTrace` | AnalysisEngine.`process(CAS aCAS, ResultSpecification aResultSpec)` Invokes this AnalysisEngine's analysis logic.
    `void` | AnalysisEngine.`process(CAS aCAS, ResultSpecification aResultSpec, ProcessTrace aTrace)` Invokes this AnalysisEngine's analysis logic.
    `CasIterator` | AnalysisEngine.`processAndOutputNewCASes(CAS aCAS)` Processes a CAS, possibly producing multiple CASes as a result.

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

    Methods in org.apache.uima.analysis_engine.annotator with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `void` | GenericAnnotator.`process(CAS aCAS, ResultSpecification aResultSpec)` Deprecated. Invokes this annotator's analysis logic.
    `void` | TextAnnotator.`process(CAS aCAS, ResultSpecification aResultSpec)` Deprecated. Invokes this annotator's analysis logic.

  - ### Uses of CAS in org.apache.uima.analysis_engine.asb

    Methods in org.apache.uima.analysis_engine.asb with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `CasIterator` | ASB.`process(CAS aCAS)` Invokes the processing of the aggregate on the given input CAS.

  - ### Uses of CAS in org.apache.uima.analysis_engine.asb.impl

    Methods in org.apache.uima.analysis_engine.asb.impl with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `FlowContainer` | FlowControllerContainer.`computeFlow(CAS aCAS)` Invokes the FlowController's computeFlow method, returning a Flow object that routes the given CAS through this aggregate.
    `FlowContainer` | FlowContainer.`newCasProduced(CAS newCAS, String producedBy)`
    `CasIterator` | ASB_impl.`process(CAS aCAS)`

    Constructors in org.apache.uima.analysis_engine.asb.impl with parameters of type CAS
    Constructor and Description
    `FlowContainer(Flow aFlow, FlowControllerContainer aFlowControllerContainer, CAS aCAS)`

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

    Fields in org.apache.uima.analysis_engine.impl declared as CAS
    Modifier and Type | Field and Description
    --- | ---
    `protected CAS` | AnalysisProcessData_impl.`mCAS` Deprecated. The CAS owned by this AnalysisProcessData.

    Methods in org.apache.uima.analysis_engine.impl that return CAS
    Modifier and Type | Method and Description
    --- | ---
    `protected CAS` | UimacppAnalysisEngineImpl.`callAnalysisComponentNext()` Calls the Analysis Component's next() method.
    `protected CAS` | PrimitiveAnalysisEngine_impl.`callAnalysisComponentNext()` Calls the Analysis Component's next() method.
    `CAS` | AnalysisProcessData_impl.`getCAS()` Deprecated.
    `CAS` | PearAnalysisEngineWrapper.`newCAS()`
    `CAS` | AnalysisEngineImplBase.`newCAS()`
    `CAS` | EmptyCasIterator.`next()`

    Methods in org.apache.uima.analysis_engine.impl with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | UimacppAnalysisEngineImpl.`callAnalysisComponentProcess(CAS aCAS)` Calls the Analysis Component's process method.
    `protected void` | PrimitiveAnalysisEngine_impl.`callAnalysisComponentProcess(CAS aCAS)` Calls the Analysis Component's process method.
    `protected void` | UimacppAnalysisEngineImpl.`enableProhibitedAnnotatorCasFunctions(CAS aCAS, boolean aEnable)` Lock/unlock CAS functions to which Annotators should not have access
    `ProcessTrace` | MultiprocessingAnalysisEngine_impl.`process(CAS aCAS)`
    `ProcessTrace` | AnalysisEngineImplBase.`process(CAS aCAS)`
    `ProcessTrace` | MultiprocessingAnalysisEngine_impl.`process(CAS aCAS, ResultSpecification aResultSpec)`
    `ProcessTrace` | AnalysisEngineImplBase.`process(CAS aCAS, ResultSpecification aResultSpec)`
    `void` | MultiprocessingAnalysisEngine_impl.`process(CAS aCAS, ResultSpecification aResultSpec, ProcessTrace aTrace)`
    `void` | AnalysisEngineImplBase.`process(CAS aCAS, ResultSpecification aResultSpec, ProcessTrace aTrace)`
    `CasIterator` | UimacppAnalysisEngineImpl.`processAndOutputNewCASes(CAS aCAS)`
    `CasIterator` | MultiprocessingAnalysisEngine_impl.`processAndOutputNewCASes(CAS aCAS)`
    `CasIterator` | PrimitiveAnalysisEngine_impl.`processAndOutputNewCASes(CAS aCAS)`
    `CasIterator` | PearAnalysisEngineWrapper.`processAndOutputNewCASes(CAS aCAS)`
    `CasIterator` | AnalysisEngineImplBase.`processAndOutputNewCASes(CAS aCAS)`
    `CasIterator` | AggregateAnalysisEngine_impl.`processAndOutputNewCASes(CAS aCAS)`
    `void` | AnalysisEngineImplBase.`processCas(CAS aCAS)`
    `void` | AnalysisEngineImplBase.`processCas(CAS[] aCASes)`

    Constructors in org.apache.uima.analysis_engine.impl with parameters of type CAS
    Constructor and Description
    `AnalysisProcessData_impl(CAS aCAS, ProcessTrace aTrace)` Deprecated. Creates a new AnalysisProcessData_impl from exsiting `CAS`.
    `AnalysisProcessData_impl(CAS aCAS, Properties aPerformanceTuningSettings)` Deprecated. Creates a new AnalysisProcessData_impl from an exsiting `CAS`.

  - ### Uses of CAS in org.apache.uima.analysis_engine.service.impl

    Methods in org.apache.uima.analysis_engine.service.impl that return CAS
    Modifier and Type | Method and Description
    --- | ---
    `protected CAS` | AnalysisEngineService_impl.`getCasFromPool(int aTimeout)` Gets a CAS from the CAS Pool.

    Methods in org.apache.uima.analysis_engine.service.impl with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `CasIterator` | AnalysisEngineServiceAdapter.`processAndOutputNewCASes(CAS aCAS)`
    `void` | ServiceDataCargo.`unmarshalCas(CAS aCas, boolean aReplaceCasTypeSystem)` Unmarshalls the CAS data in this `ServiceDataCargo` into an existing `CAS` instance.

    Constructors in org.apache.uima.analysis_engine.service.impl with parameters of type CAS
    Constructor and Description
    `ServiceDataCargo(CAS aCAS, ProcessTrace aProcessTrace)` Creates a new `SerializableAnalysisProcessData` that contains the given `CAS` and `ProcessTrace`.

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

    Methods in org.apache.uima.cas that return CAS
    Modifier and Type | Method and Description
    --- | ---
    `CAS` | CAS.`createView(String localViewName)` Create a view and its underlying Sofa (subject of analysis).
    `CAS` | FeatureStructure.`getCAS()` Return the CAS that this FS belongs to.
    `CAS` | CAS.`getCurrentView()` Get the Cas view that the current component should use.
    `CAS` | AnnotationBaseFS.`getView()` Gets the CAS view associated with the Sofa that this Annotation is over.
    `CAS` | CAS.`getView(SofaFS aSofa)` Get the view for a Sofa (subject of analysis).
    `CAS` | CAS.`getView(String localViewName)` Get the view for a Sofa (subject of analysis).

    Methods in org.apache.uima.cas that return types with arguments of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `Iterator<CAS>` | CAS.`getViewIterator()` Get iterator over all views in this CAS.
    `Iterator<CAS>` | CAS.`getViewIterator(String localViewNamePrefix)` Get iterator over all views with the given name prefix.

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

    Methods in org.apache.uima.cas.admin that return CAS
    Modifier and Type | Method and Description
    --- | ---
    `CAS` | CASMgr.`getCAS()` Return a non-admin version of the CAS.

    Methods in org.apache.uima.cas.admin with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `void` | CASMgr.`setCAS(CAS cas)`

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

    Classes in org.apache.uima.cas.impl that implement CAS
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CASImpl` Implements the CAS interfaces.

    Fields in org.apache.uima.cas.impl declared as CAS
    Modifier and Type | Field and Description
    --- | ---
    `protected CAS` | DebugFSLogicalStructure.IndexInfo.`cas`

    Methods in org.apache.uima.cas.impl that return CAS
    Modifier and Type | Method and Description
    --- | ---
    `static CAS` | Serialization.`createCAS(CASMgr casMgr, CASSerializer casSer)` Deserialize the data in a CASSerializer into an existing CAS, return the currentview in that Cas.
    `CAS` | CASImpl.`createView(String aSofaID)`
    `CAS` | CASImpl.`getCAS()`
    `CAS` | FeatureStructureImplC.`getCAS()`
    `CAS` | CASImpl.`getCurrentView()`
    `CAS` | AnnotationBaseImpl.`getView()` see org.apache.uima.cas.AnnotationBase#getView()
    `CAS` | CASImpl.`getView(int sofaNum)`
    `CAS` | CASImpl.`getView(SofaFS aSofa)`
    `CAS` | CASImpl.`getView(String aSofaID)`

    Methods in org.apache.uima.cas.impl that return types with arguments of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `Iterator<CAS>` | CASImpl.`getViewIterator()`
    `Iterator<CAS>` | CASImpl.`getViewIterator(String localViewNamePrefix)`

    Methods in org.apache.uima.cas.impl with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `static void` | XmiCasDeserializer.`deserialize(InputStream aStream, CAS aCAS)` Deserializes a CAS from XMI.
    `static void` | XCASDeserializer.`deserialize(InputStream aStream, CAS aCAS)` Deserializes an XCAS from a stream.
    `static void` | XmiCasDeserializer.`deserialize(InputStream aStream, CAS aCAS, boolean aLenient)` Deserializes a CAS from XMI.
    `static void` | XCASDeserializer.`deserialize(InputStream aStream, CAS aCAS, boolean aLenient)` Deserializes an XCAS from a stream.
    `static void` | XmiCasDeserializer.`deserialize(InputStream aStream, CAS aCAS, boolean aLenient, XmiSerializationSharedData aSharedData)` Deserializes a CAS from XMI.
    `static void` | XmiCasDeserializer.`deserialize(InputStream aStream, CAS aCAS, boolean aLenient, XmiSerializationSharedData aSharedData, int aMergePoint)` Deserializes a CAS from XMI.
    `static void` | XmiCasDeserializer.`deserialize(InputStream aStream, CAS aCAS, boolean aLenient, XmiSerializationSharedData aSharedData, int aMergePoint, AllowPreexistingFS allowPreexistingFS)` Deserializes a CAS from XMI.
    `static SerialFormat` | Serialization.`deserializeCAS(CAS cas, InputStream istream)` Deserialize a CAS, in various binary formats, into an existing CAS Note: this form supports deserializing the following binary representations: - plain (uncompressed) - compressed, no type filtering (form 4), Delta and not-delta - compressed, no type filtering (form 6), not-delta only.
    `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 DebugFSLogicalStructure.IndexInfo[]` | DebugFSLogicalStructure.`getIndexes(CAS cas)`
    `static DebugFSLogicalStructure.ViewInfo[]` | DebugFSLogicalStructure.`getOtherViews(CAS cas)`
    `DefaultHandler` | XCASDeserializer.`getXCASHandler(CAS cas)` Create a default handler for deserializing an XCAS into the `cas` parameter.
    `DefaultHandler` | XCASDeserializer.`getXCASHandler(CAS cas, OutOfTypeSystemData outOfTypeSystemData)` Create a default handler for deserializing an XCAS into the `cas` parameter.
    `DefaultHandler` | XmiCasDeserializer.`getXmiCasHandler(CAS cas)` Create a default handler for deserializing a CAS from XMI.
    `DefaultHandler` | XmiCasDeserializer.`getXmiCasHandler(CAS cas, boolean lenient)` Create a default handler for deserializing a CAS from XMI.
    `DefaultHandler` | XmiCasDeserializer.`getXmiCasHandler(CAS cas, boolean lenient, XmiSerializationSharedData sharedData)` Create a default handler for deserializing a CAS from XMI.
    `DefaultHandler` | XmiCasDeserializer.`getXmiCasHandler(CAS cas, boolean lenient, XmiSerializationSharedData sharedData, int mergePoint)` Create a default handler for deserializing a CAS from XMI.
    `DefaultHandler` | XmiCasDeserializer.`getXmiCasHandler(CAS cas, boolean lenient, XmiSerializationSharedData sharedData, int mergePoint, AllowPreexistingFS allow)` Create a default handler for deserializing a CAS from XMI.
    `void` | XmiCasSerializer.`serialize(CAS cas, ContentHandler contentHandler)` Write the CAS data to a SAX content handler.
    `void` | XCASSerializer.`serialize(CAS cas, ContentHandler contentHandler)` Write the CAS data to a SAX content handler.
    `void` | XCASSerializer.`serialize(CAS cas, ContentHandler contentHandler, boolean encodeDoc)` Write the CAS data to a SAX content handler.
    `void` | XCASSerializer.`serialize(CAS cas, ContentHandler contentHandler, boolean encodeDoc, OutOfTypeSystemData outOfTypeSystemData)` Write the CAS data to a SAX content handler.
    `void` | XmiCasSerializer.`serialize(CAS cas, ContentHandler contentHandler, ErrorHandler errorHandler)` Write the CAS data to a SAX content handler.
    `void` | XmiCasSerializer.`serialize(CAS cas, ContentHandler contentHandler, ErrorHandler errorHandler, XmiSerializationSharedData sharedData)` Write the CAS data to a SAX content handler.
    `void` | XmiCasSerializer.`serialize(CAS cas, ContentHandler contentHandler, ErrorHandler errorHandler, XmiSerializationSharedData sharedData, Marker marker)` Write the CAS data to a SAX content handler.
    `static void` | XmiCasSerializer.`serialize(CAS aCAS, OutputStream aStream)` Serializes a CAS to an XMI stream.
    `static void` | XCASSerializer.`serialize(CAS aCAS, OutputStream aStream)` Serializes an XCAS to a stream.
    `static void` | XCASSerializer.`serialize(CAS aCAS, OutputStream aStream, boolean isFormattedOutput)` Serializes an XCAS to a stream.
    `static void` | XCASSerializer.`serialize(CAS aCAS, OutputStream aStream, boolean isFormattedOutput, boolean useXml_1_1)` Serializes an XCAS to a stream.
    `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 CASSerializer` | Serialization.`serializeCAS(CAS cas)` Convert a CAS to a CASSerializer object.
    `static void` | Serialization.`serializeCAS(CAS cas, OutputStream ostream)` Serialize a CAS including what's indexed, to an output stream Uses uncompressed binary serialization
    `static void` | Serialization.`serializeCAS(CAS cas, OutputStream ostream, Marker mark)` Serializes CAS data added or modified after the tracking Marker was created and writes it to the output stream in Delta CAS format using uncompressed binary format
    `static CASSerializer` | Serialization.`serializeNoMetaData(CAS cas)` Convert a CAS to a CASSerializer object.
    `static void` | Serialization.`serializeWithCompression(CAS cas, Object out)` Serialize in compressed binary form 4
    `static BinaryCasSerDes6.ReuseInfo` | Serialization.`serializeWithCompression(CAS cas, Object out, boolean includeTS, boolean includeTSI)` 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, Marker marker)` Serialize in compress binary form 4, only the delta part of a CAS
    `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.
    `void` | CASImpl.`setCAS(CAS cas)`

    Constructors in org.apache.uima.cas.impl with parameters of type CAS
    Constructor and Description
    `DefaultFSAnnotationComparator(CAS cas)`
    `IndexInfo(CAS cas, String indexName)`
    `IndexInfo(CAS cas, String indexName, Type type)`
    `ViewInfo(CAS cas)` Create information about a view for given CAS.

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

    Methods in org.apache.uima.collection with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `void` | StatusCallbackListener.`entityProcessComplete(CAS aCas, EntityProcessStatus aStatus)` Called when the processing of each entity has completed.
    `void` | CollectionReader.`getNext(CAS aCAS)` Gets the next element of the collection.
    `void` | CasInitializer.`initializeCas(Object aObj, CAS aCAS)` Deprecated. Reads content and metadata from an Object and initializes a `CAS`.
    `void` | CasConsumer_ImplBase.`processCas(CAS[] aCASes)`

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

    Methods in org.apache.uima.collection.base_cpm with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `void` | CasObjectProcessor.`processCas(CAS aCAS)` Process a single CAS.
    `void` | CasObjectProcessor.`processCas(CAS[] aCASes)` Processes multiple CASes.

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

    Methods in org.apache.uima.flow that return CAS
    Modifier and Type | Method and Description
    --- | ---
    `protected CAS` | CasFlow_ImplBase.`getCas()` Gets the CAS being routed by this Flow object.

    Methods in org.apache.uima.flow that return types with arguments of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `Class<CAS>` | CasFlowController_ImplBase.`getRequiredCasInterface()`

    Methods in org.apache.uima.flow with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `abstract Flow` | CasFlowController_ImplBase.`computeFlow(CAS aCAS)` This method must be overriden by subclasses.
    `protected Flow` | CasFlow_ImplBase.`newCasProduced(CAS newCas, String producedBy)` By default, throws an exception to indicate this this Flow object does not support new CASes being produced in the middle of the flow.
    `void` | CasFlow_ImplBase.`setCas(CAS aCAS)` Deprecated. this is automatically done by the framework after a new flow object is created

  - ### Uses of CAS in org.apache.uima.flow.impl

    Methods in org.apache.uima.flow.impl with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `Flow` | CapabilityLanguageFlowController.`computeFlow(CAS aCAS)`
    `Flow` | FixedFlowController.`computeFlow(CAS aCAS)`

  - ### Uses of CAS in org.apache.uima.impl

    Fields in org.apache.uima.impl with type parameters of type CAS
    Modifier and Type | Field and Description
    --- | ---
    `protected Set<CAS>` | UimaContext_ImplBase.`mOutstandingCASes` CASes that have been requested via `UimaContext_ImplBase.getEmptyCas(Class)` minus the number calls the framework has made to `UimaContext_ImplBase.returnedCAS(AbstractCas)` (which indicate that the AnalysisComponent has returned a CAS from its next() method or released the CAS.

    Methods in org.apache.uima.impl with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `static CASImpl` | Util.`getStartingView(CAS cas, boolean sofaAware, ComponentInfo componentInfo)`
    `static <T extends AbstractCas> T` | Util.`setupViewSwitchClassLoaders(CAS cas, boolean sofaAware, ComponentInfo componentInfo, ResourceManager resourceManager, Class<T> casInterface)`
    `static AbstractCas` | Util.`setupViewSwitchClassLoadersLockCas(CAS cas, boolean sofaAware, ComponentInfo componentInfo, ResourceManager resourceManager, Class<? extends AbstractCas> casInterface)`

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

    Methods in org.apache.uima.jcas that return CAS
    Modifier and Type | Method and Description
    --- | ---
    `CAS` | JCas.`getCas()`

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

    Methods in org.apache.uima.jcas.cas that return CAS
    Modifier and Type | Method and Description
    --- | ---
    `CAS` | TOP.`getCAS()`
    `CAS` | AnnotationBase.`getView()`
    `CAS` | AnnotationBase_Type.`getView(int addr)`

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

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

    Methods in org.apache.uima.jcas.impl with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `static void` | JCasImpl.`clearData(CAS cas)`

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

    Methods in org.apache.uima.json with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `static void` | JsonCasSerializer.`jsonSerialize(CAS aCAS, Object output)` Serializes a CAS using JSON
    `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).
    `void` | JsonCasSerializer.`serialize(CAS cas, JsonContentHandlerJacksonWrapper jch)` Serialize a Cas to an Output configured in the passed in JsonContentHandlerJacksonWrapper Constructs a new CasDocSerializer instance to do the serialization, configured using this class's Delta marker setting (if any)
    `void` | JsonCasSerializer.`serialize(CAS cas, JsonContentHandlerJacksonWrapper jch, XmiSerializationSharedData sharedData, Marker marker)`
    `void` | JsonCasSerializer.`serialize(CAS cas, Object output)` Serialize a Cas to an Output, using configurations set on this instance.
    `void` | JsonCasSerializer.`serialize(CAS cas, Object output, XmiSerializationSharedData sharedData, Marker marker)`

  - ### Uses of CAS in org.apache.uima.resource

    Methods in org.apache.uima.resource that return CAS
    Modifier and Type | Method and Description
    --- | ---
    `CAS` | CasManager.`createNewCas(Properties aPerformanceTuningSettings)` Create a new CAS using the CasDefinition stored in this CAS Manager.
    `CAS` | CasManager.`getCas(String aRequestorContextName)` Gets an empty CAS.

    Methods in org.apache.uima.resource with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `AbstractCas` | CasManager.`getCasInterface(CAS cas, Class<? extends AbstractCas> requiredInterface)` Gets a specified interface to a CAS.

  - ### Uses of CAS in org.apache.uima.resource.impl

    Methods in org.apache.uima.resource.impl that return CAS
    Modifier and Type | Method and Description
    --- | ---
    `CAS` | CasManager_impl.`createNewCas(Properties aPerformanceTuningSettings)`
    `CAS` | CasManager_impl.`getCas(String aRequestorContextName)`

    Methods in org.apache.uima.resource.impl that return types with arguments of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `protected Map<CAS,CasPool>` | CasManager_impl.`getCasToCasPoolMap()`

    Methods in org.apache.uima.resource.impl with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `AbstractCas` | CasManager_impl.`getCasInterface(CAS cas, Class<? extends AbstractCas> requiredInterface)` Gets a specified interface to a CAS.
    `static <T extends AbstractCas> T` | CasManager_impl.`getCasInterfaceStatic(CAS cas, Class<T> requiredInterface)` Gets a specified interface to a CAS.

  - ### Uses of CAS in org.apache.uima.resource.metadata

    Methods in org.apache.uima.resource.metadata with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | Precondition.`evaluate(CAS aCAS)` Determines if this precondition is satisfied by a CAS.

  - ### Uses of CAS in org.apache.uima.resource.metadata.impl

    Methods in org.apache.uima.resource.metadata.impl with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | SimplePrecondition_impl.`evaluate(CAS aCAS)`

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

    Methods in org.apache.uima.uimacpp that return CAS
    Modifier and Type | Method and Description
    --- | ---
    `protected CAS` | UimacppAnalysisComponent.`getEmptyCAS()`

    Methods in org.apache.uima.uimacpp that return types with arguments of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `Class<CAS>` | UimacppAnalysisComponent.`getRequiredCasInterface()`

    Methods in org.apache.uima.uimacpp with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `void` | UimacppEngine.`next(CAS segment)` next
    `void` | UimacppAnalysisComponent.`process(CAS aCAS)`
    `void` | UimacppAnalysisComponent.`process(CAS cas, ResultSpecification aResultSpec)`
    `void` | UimacppEngine.`process(ResultSpecification rs, CAS aCas, boolean casIsEmpty)` process the document.

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

    Methods in org.apache.uima.util that return CAS
    Modifier and Type | Method and Description
    --- | ---
    `static CAS` | CasCreationUtils.`createCas(AnalysisEngineDescription aDescription)` Creates a new CAS instance for an Analysis Engine.
    `static CAS` | CasCreationUtils.`createCas(AnalysisEngineDescription aDescription, Properties aPerformanceTuningSettings)` Creates a new CAS instance for an Analysis Engine.
    `static CAS` | CasCreationUtils.`createCas(AnalysisEngineMetaData aMetaData)` Creates a new CAS instance.
    `static CAS` | CasCreationUtils.`createCas(CasDefinition casDef, Properties performanceTuningSettings)` Create a CAS from a CAS Definition.
    `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)` Creates a new CAS instance for a collection of CAS Processors.
    `static CAS` | CasCreationUtils.`createCas(Collection<? extends MetaDataObject> aComponentDescriptionsOrMetaData, Properties aPerformanceTuningSettings)` Creates a new CAS instance for a collection of CAS Processors.
    `static CAS` | CasCreationUtils.`createCas(Collection<? extends MetaDataObject> aComponentDescriptionsOrMetaData, Properties aPerformanceTuningSettings, ResourceManager aResourceManager)` Creates a new CAS instance for a collection of CAS Processors.
    `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(ProcessingResourceMetaData aMetaData)` Creates a new CAS instance.
    `static CAS` | CasCreationUtils.`createCas(TypeSystemDescription aTypeSystem, TypePriorities aTypePriorities, FsIndexDescription[] aFsIndexes)` Creates a new CAS instance.
    `static CAS` | CasCreationUtils.`createCas(TypeSystemDescription aTypeSystem, TypePriorities aTypePriorities, FsIndexDescription[] aFsIndexes, Properties aPerformanceTuningSettings)` Creates a new CAS instance.
    `static CAS` | CasCreationUtils.`createCas(TypeSystemDescription aTypeSystem, TypePriorities aTypePriorities, FsIndexDescription[] aFsIndexes, Properties aPerformanceTuningSettings, ResourceManager aResourceManager)` Creates a new CAS instance.
    `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.
    `CAS` | CasPool.`getCas()` Checks out a CAS from the pool.
    `CAS` | CasPool.`getCas(long aTimeout)` Checks out a CAS from the pool.

    Methods in org.apache.uima.util that return types with arguments of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `protected Vector<CAS>` | CasPool.`getAllInstances()`
    `protected Vector<CAS>` | CasPool.`getFreeInstances()`

    Methods in org.apache.uima.util with parameters of type CAS
    Modifier and Type | Method and Description
    --- | ---
    `static void` | CasCopier.`copyCas(CAS aSrcCas, CAS aDestCas, boolean aCopySofa)` Does a complete deep copy of one CAS into another CAS.
    `static void` | CasCopier.`copyCas(CAS aSrcCas, CAS aDestCas, boolean aCopySofa, boolean lenient)` Does a complete deep copy of one CAS into another CAS.
    `void` | CasCopier.`copyCasView(CAS aSrcCasView, boolean aCopySofa)` Does a deep copy of the contents of one CAS View into another CAS's same-named-view If the destination view already exists in the destination CAS, then it will be the target of the copy.
    `void` | CasCopier.`copyCasView(CAS aSrcCasView, CAS aTgtCasView, boolean aCopySofa)` Does a deep copy of the contents of one CAS View into another CAS view, with a possibly different name.
    `void` | CasCopier.`copyCasView(CAS aSrcCasView, String aTgtCasViewName, boolean aCopySofa)` Does a deep copy of the contents of one CAS View into another CAS view, with a possibly different name.
    `void` | CasCopier.`copyCasView(String aSrcCasViewName, CAS aTgtCasView, boolean aCopySofa)` Does a deep copy of the contents of one CAS View into another CAS view, with a possibly different name.
    `static void` | XmlCasDeserializer.`deserialize(InputStream aStream, CAS aCAS)` Deserializes a CAS from a standoff-XML format.
    `static void` | XmlCasDeserializer.`deserialize(InputStream aStream, CAS aCAS, boolean aLenient)` Deserializes a CAS from XMI or XCAS.
    `String` | CasToInlineXml.`format(CAS aCAS)` Formats a CAS as a String.
    `String` | TCasToInlineXml.`format(CAS aCAS)` Deprecated.
    `String` | TCasFormatter.`format(CAS aCAS)` Produces a string representation of a CAS.
    `String` | CasToInlineXml.`format(CAS aCAS, FSMatchConstraint aFilter)` Formats a CAS as a String.
    `String` | TCasToInlineXml.`format(CAS aCAS, FSMatchConstraint aFilter)` Deprecated.
    `String` | TCasFormatter.`format(CAS aCAS, FSMatchConstraint aFilter)` Produces a string representation of a CAS.
    `String` | CasToInlineXml.`generateXML(CAS aCAS)` Generates inline XML from a CAS.
    `String` | TCasToInlineXml.`generateXML(CAS aCAS)` Deprecated.
    `String` | CasToInlineXml.`generateXML(CAS aCAS, FSMatchConstraint aFilter)` Generates inline XML from a CAS.
    `String` | TCasToInlineXml.`generateXML(CAS aCAS, FSMatchConstraint aFilter)` Deprecated.
    `void` | CasToInlineXml.`generateXML(CAS aCAS, FSMatchConstraint aFilter, ContentHandler aHandler)` Generates inline XML from a CAS using a passed in ContentHandler
    `static int` | ConsumerCasUtils.`getIntFeatValue(CAS aCasView, String aTypeS, String aFeatS)`
    `static String` | ConsumerCasUtils.`getStringFeatValue(CAS aCasView, String aTypeS, String aFeatS)`
    `static FeatureStructure` | ConsumerCasUtils.`getTcasFS(CAS aCasView, String aTypeS)`
    `static SerialFormat` | CasIOUtils.`load(InputStream casInputStream, CAS aCAS)` Loads a Cas from an Input Stream.
    `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 SerialFormat` | CasIOUtils.`load(InputStream casInputStream, InputStream tsiInputStream, CAS aCAS)` Loads a CAS from an Input Stream.
    `static SerialFormat` | CasIOUtils.`load(InputStream casInputStream, InputStream tsiInputStream, CAS aCAS, boolean leniently)` Loads a CAS from an Input Stream.
    `static SerialFormat` | CasIOUtils.`load(InputStream casInputStream, InputStream tsiInputStream, CAS aCAS, CasLoadMode casLoadMode)` Loads a CAS from an Input Stream.
    `static SerialFormat` | CasIOUtils.`load(URL casUrl, CAS aCAS)` Loads a Cas from a URL source.
    `static SerialFormat` | CasIOUtils.`load(URL casUrl, URL tsiUrl, CAS aCAS, boolean leniently)` Loads a CAS from a URL source.
    `static SerialFormat` | CasIOUtils.`load(URL casUrl, URL tsiUrl, CAS aCAS, CasLoadMode casLoadMode)` Loads a CAS from a URL source.
    `void` | CasPool.`releaseCas(CAS aCas)` Checks in a CAS to the pool.
    `static void` | CasIOUtils.`save(CAS aCas, OutputStream docOS, OutputStream tsiOS, SerialFormat format)` Write the CAS in the specified format.
    `static void` | CasIOUtils.`save(CAS aCas, OutputStream docOS, SerialFormat format)` Write the CAS in the specified format.
    `static void` | XmlCasSerializer.`serialize(CAS aCAS, OutputStream aStream)` Serializes a CAS to XMI format and writes it to an output stream.
    `static void` | XmlCasSerializer.`serialize(CAS aCAS, TypeSystem aTargetTypeSystem, OutputStream aStream)` Serializes a CAS to XMI format and writes it to an output stream.
    `static void` | CasIOUtils.`writeTypeSystem(CAS aCas, OutputStream aOS, boolean includeIndexDefs)`

    Constructors in org.apache.uima.util with parameters of type CAS
    Constructor and Description
    `CasCopier(CAS aSrcCas, CAS aDestCas)` Creates a new CasCopier that can be used to copy FeatureStructures from one CAS to another.
    `CasCopier(CAS aSrcCas, CAS aDestCas, boolean lenient)` Creates a new CasCopier that can be used to copy FeatureStructures from one CAS to another.

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