## 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.cas | Common Analysis System (CAS) Interfaces.
  org.apache.uima.cas.admin |
  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.cas | JCAS model for built-in CAS types
  org.apache.uima.json |
  org.apache.uima.resource | Interfaces for `Resources` and `ResourceSpecifiers`.
  org.apache.uima.resource.metadata | Interfaces for objects that represent metadata for a Resource.
  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>` | CasAnnotator_ImplBase.`getRequiredCasInterface()`
    `Class<CAS>` | CasMultiplier_ImplBase.`getRequiredCasInterface()`

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

  - ### 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.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.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.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.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, org.apache.uima.cas.impl.XmiSerializationSharedData sharedData)` Serializes a Delta CAS to an output (File, Writer, or OutputStream).
    `void` | JsonCasSerializer.`serialize(CAS cas, org.apache.uima.json.impl.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, org.apache.uima.json.impl.JsonContentHandlerJacksonWrapper jch, org.apache.uima.cas.impl.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, org.apache.uima.cas.impl.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.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.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` | TCasFormatter.`format(CAS aCAS)` Produces a string representation of a CAS.
    `String` | TCasToInlineXml.`format(CAS aCAS)` Deprecated.
    `String` | CasToInlineXml.`format(CAS aCAS, FSMatchConstraint aFilter)` Formats a CAS as a String.
    `String` | TCasFormatter.`format(CAS aCAS, FSMatchConstraint aFilter)` Produces a string representation of a CAS.
    `String` | TCasToInlineXml.`format(CAS aCAS, FSMatchConstraint aFilter)` Deprecated.
    `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–2019 The Apache Software Foundation. All rights reserved.