Uses of Interface
org.apache.uima.cas.CAS
Packages that use CAS
Package
Description
The Analysis Engine interface, along with supporting
interfaces and exception classes.
The Annotator Interfaces, along with supporting interfaces
and exception classes.
Contains the Analysis Structure Broker (ASB) interface, along with supporting
interfaces and exception classes.
Common Analysis System (CAS) Interfaces.
Implementation and Low-Level API for the CAS Interfaces.
Classes and interfaces for collection processing.
Contains reference implementations of the interfaces in
org.apache.uima
.Interfaces for accessing the JCAS.
JCAS model for built-in CAS types
Provides the classes that support the Java Cas Model (JCM).
Interfaces for
Resources
and ResourceSpecifiers
.Interfaces for objects that represent metadata for a
Resource.
Classes for the JCasGen tool
Utility classes and interfaces used by UIMA components.
-
Uses of CAS in org.apache.uima.adapter.vinci
Fields in org.apache.uima.adapter.vinci declared as CASMethods in org.apache.uima.adapter.vinci that return CASMethods in org.apache.uima.adapter.vinci with parameters of type CASModifier and TypeMethodDescriptionvoid
VinciAnalysisEngineServiceStub.callProcess
(CAS aCAS) void
VinciBinaryAnalysisEngineServiceStub.callProcess
(CAS aCAS) void
VinciAnalysisEngineServiceStub.callProcessCas
(CAS aCAS) private void
The actual process call.Constructors in org.apache.uima.adapter.vinci with parameters of type CASModifierConstructorDescriptionCASTransportable
(CAS cas, OutOfTypeSystemData outOfTypeSystemData, UimaContext uimaContext, boolean includeDocText) This constructor is used on the client side, where we have a dedicated CAS instance for the request. -
Uses of CAS in org.apache.uima.analysis_component
Methods in org.apache.uima.analysis_component that return CASModifier and TypeMethodDescriptionprotected final 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 CASModifier and TypeMethodDescriptionCasAnnotator_ImplBase.getRequiredCasInterface()
CasMultiplier_ImplBase.getRequiredCasInterface()
Methods in org.apache.uima.analysis_component with parameters of type CASModifier and TypeMethodDescriptionprivate void
CasAnnotator_ImplBase.checkTypeSystemChange
(CAS aCAS) Checks it the type system of the given CAS is different from the last type system this component was operating on.private void
CasMultiplier_ImplBase.checkTypeSystemChange
(CAS aCAS) Checks it the type system of the given CAS is different from the last type system this component was operating on.abstract void
Inputs a CAS to the AnalysisComponent.abstract void
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 CASModifier and TypeMethodDescriptionAnalysisProcessData.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.AnalysisEngine.newCAS()
Creates a new Common Analysis System appropriate for this Analysis Engine.CasIterator.next()
Gets the next CAS from the iterator.Methods in org.apache.uima.analysis_engine with parameters of type CASModifier and TypeMethodDescriptionvoid
AnalysisEngineServiceStub.callProcess
(CAS aCAS) Performs service call to process an entity.Invokes this AnalysisEngine's analysis logic.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.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 CASModifier and TypeMethodDescriptionvoid
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 CASModifier and TypeMethodDescriptionInvokes the processing of the aggregate on the given input CAS. -
Uses of CAS in org.apache.uima.analysis_engine.asb.impl
Fields in org.apache.uima.analysis_engine.asb.impl declared as CASModifier and TypeFieldDescription(package private) CAS
ASB_impl.AggregateCasIterator.mInputCas
The CAS that was input to the Aggregate AE's process method.(package private) CAS
ASB_impl.AggregateCasIterator.nextCas
Holds the next CAS to be returned, if it is known.(package private) CAS
ASB_impl.StackFrame.originalCas
The CAS that was passed as input to the CasMultiplier.Fields in org.apache.uima.analysis_engine.asb.impl with type parameters of type CASModifier and TypeFieldDescriptionASB_impl.AggregateCasIterator.activeCASes
Set of CASes that are in circulation (that is, they have been passed to FlowController and the FlowController hasn't yet returned a FinalStep for them).Methods in org.apache.uima.analysis_engine.asb.impl that return CASModifier and TypeMethodDescriptionASB_impl.AggregateCasIterator.next()
Gets the next output CAS.private CAS
ASB_impl.AggregateCasIterator.processUntilNextOutputCas()
This is the main execution control method for the aggregate AE.Methods in org.apache.uima.analysis_engine.asb.impl with parameters of type CASModifier and TypeMethodDescriptionFlowControllerContainer.computeFlow
(CAS aCAS) Invokes the FlowController's computeFlow method, returning a Flow object that routes the given CAS through this aggregate.FlowContainer.newCasProduced
(CAS newCAS, String producedBy) Constructors in org.apache.uima.analysis_engine.asb.impl with parameters of type CASModifierConstructorDescriptionAggregateCasIterator
(CAS inputCas) Creates a new AggregateCasIterator for the given input CAS.FlowContainer
(Flow aFlow, FlowControllerContainer aFlowControllerContainer, CAS aCAS) (package private)
StackFrame
(CasIterator casIterator, CAS originalCas, FlowContainer originalCasFlow, String lastAeKey) (package private)
StackFrame
(CasIterator casIterator, CAS originalCas, FlowContainer originalCasFlow, String lastAeKey, ParallelStep incompleteParallelStep) -
Uses of CAS in org.apache.uima.analysis_engine.impl
Fields in org.apache.uima.analysis_engine.impl declared as CASModifier and TypeFieldDescriptionprotected CAS
AnalysisProcessData_impl.mCAS
Deprecated.The CAS owned by this AnalysisProcessData.private CAS
PrimitiveAnalysisEngine_impl.AnalysisComponentCasIterator.mInputCas
Methods in org.apache.uima.analysis_engine.impl that return CASModifier and TypeMethodDescriptionprotected CAS
PrimitiveAnalysisEngine_impl.callAnalysisComponentNext()
Calls the Analysis Component's next() method.protected CAS
UimacppAnalysisEngineImpl.callAnalysisComponentNext()
Calls the Analysis Component's next() method.AnalysisProcessData_impl.getCAS()
Deprecated.AnalysisEngineImplBase.newCAS()
PearAnalysisEngineWrapper.newCAS()
EmptyCasIterator.next()
PrimitiveAnalysisEngine_impl.AnalysisComponentCasIterator.next()
UimacppAnalysisEngineImpl.TafAnalysisComponentCasIterator.next()
Methods in org.apache.uima.analysis_engine.impl with parameters of type CASModifier and TypeMethodDescriptionprotected void
PrimitiveAnalysisEngine_impl.callAnalysisComponentProcess
(CAS aCAS) Calls the Analysis Component's process method.protected void
UimacppAnalysisEngineImpl.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 accessAnalysisEngineImplBase.process
(CAS aCAS, ResultSpecification aResultSpec) void
AnalysisEngineImplBase.process
(CAS aCAS, ResultSpecification aResultSpec, ProcessTrace aTrace) MultiprocessingAnalysisEngine_impl.process
(CAS aCAS, ResultSpecification aResultSpec) void
MultiprocessingAnalysisEngine_impl.process
(CAS aCAS, ResultSpecification aResultSpec, ProcessTrace aTrace) AggregateAnalysisEngine_impl.processAndOutputNewCASes
(CAS aCAS) AnalysisEngineImplBase.processAndOutputNewCASes
(CAS aCAS) MultiprocessingAnalysisEngine_impl.processAndOutputNewCASes
(CAS aCAS) PearAnalysisEngineWrapper.processAndOutputNewCASes
(CAS aCAS) PrimitiveAnalysisEngine_impl.processAndOutputNewCASes
(CAS aCAS) UimacppAnalysisEngineImpl.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 CASModifierConstructorDescription(package private)
AnalysisComponentCasIterator
(AnalysisComponent aAnalysisComponent, CAS aInputCas) AnalysisProcessData_impl
(CAS aCAS, Properties aPerformanceTuningSettings) Deprecated.Creates a new AnalysisProcessData_impl from an exsitingCAS
.AnalysisProcessData_impl
(CAS aCAS, ProcessTrace aTrace) Deprecated.Creates a new AnalysisProcessData_impl from exsitingCAS
. -
Uses of CAS in org.apache.uima.analysis_engine.impl.compatibility
Methods in org.apache.uima.analysis_engine.impl.compatibility that return types with arguments of type CASModifier and TypeMethodDescriptionCasConsumerAdapter.getRequiredCasInterface()
Get the CAS interface required by this CasConsumer. -
Uses of CAS in org.apache.uima.analysis_engine.service.impl
Methods in org.apache.uima.analysis_engine.service.impl that return CASModifier and TypeMethodDescriptionprotected 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 CASModifier and TypeMethodDescriptionAnalysisEngineServiceAdapter.processAndOutputNewCASes
(CAS aCAS) void
ServiceDataCargo.unmarshalCas
(CAS aCas, boolean aReplaceCasTypeSystem) Unmarshalls the CAS data in thisServiceDataCargo
into an existingCAS
instance.Constructors in org.apache.uima.analysis_engine.service.impl with parameters of type CASModifierConstructorDescriptionServiceDataCargo
(CAS aCAS, ProcessTrace aProcessTrace) Creates a newSerializableAnalysisProcessData
that contains the givenCAS
andProcessTrace
. -
Uses of CAS in org.apache.uima.cas
Methods in org.apache.uima.cas that return CASModifier and TypeMethodDescriptionCAS.createView
(String localViewName) Create a view and its underlying Sofa (subject of analysis).FeatureStructure.getCAS()
Return the CAS that this FS belongs to.CAS.getCurrentView()
Get the Cas view that the current component should use.AnnotationBaseFS.getView()
Gets the CAS view associated with the Sofa that this Annotation is over.Get the view for a Sofa (subject of analysis).Get the view for a Sofa (subject of analysis).Methods in org.apache.uima.cas that return types with arguments of type CASModifier and TypeMethodDescriptionCAS.getViewIterator()
Get iterator over all views in this 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 CASMethods in org.apache.uima.cas.admin with parameters of type CAS -
Uses of CAS in org.apache.uima.cas.impl
Classes in org.apache.uima.cas.impl that implement CASFields in org.apache.uima.cas.impl declared as CASModifier and TypeFieldDescriptionprotected CAS
DebugFSLogicalStructure.IndexInfo.cas
private CAS
DebugFSLogicalStructure.ViewInfo.cas
Fields in org.apache.uima.cas.impl with type parameters of type CASModifier and TypeFieldDescriptionCASImpl.SharedViewData.sofaNbr2ViewMap
XCASDeserializer.XCASDeserializerHandler.views
XmiCasDeserializer.XmiCasDeserializerHandler.views
Methods in org.apache.uima.cas.impl that return CASModifier and TypeMethodDescriptionstatic CAS
Serialization.createCAS
(CASMgr casMgr, CASSerializer casSer) Deserialize the data in a CASSerializer into an existing CAS, return the currentview in that Cas.CASImpl.createView
(String aSofaID) CASImpl.getCAS()
FeatureStructureImplC.getCAS()
CASImpl.getCurrentView()
(package private) CAS
CASImpl.getInitialView()
AnnotationBaseImpl.getView()
see org.apache.uima.cas.AnnotationBase#getView()CASImpl.getView
(int sofaNum) private CAS
CASImpl.getViewFromSofaNbr
(int nbr) Methods in org.apache.uima.cas.impl that return types with arguments of type CASModifier and TypeMethodDescriptionCASImpl.getViewIterator()
CASImpl.getViewIterator
(String localViewNamePrefix) Methods in org.apache.uima.cas.impl with parameters of type CASModifier and TypeMethodDescriptionstatic void
XCASDeserializer.deserialize
(InputStream aStream, CAS aCAS) Deserializes an XCAS from a stream.static void
XCASDeserializer.deserialize
(InputStream aStream, CAS aCAS, boolean aLenient) Deserializes an XCAS from a stream.static void
XmiCasDeserializer.deserialize
(InputStream aStream, CAS aCAS) Deserializes a CAS from XMI.static void
XmiCasDeserializer.deserialize
(InputStream aStream, CAS aCAS, boolean aLenient) Deserializes a CAS from XMI.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) XCASDeserializer.getXCASHandler
(CAS cas) Create a default handler for deserializing an XCAS into thecas
parameter.XCASDeserializer.getXCASHandler
(CAS cas, OutOfTypeSystemData outOfTypeSystemData) Create a default handler for deserializing an XCAS into thecas
parameter.XmiCasDeserializer.getXmiCasHandler
(CAS cas) Create a default handler for deserializing a CAS from XMI.XmiCasDeserializer.getXmiCasHandler
(CAS cas, boolean lenient) Create a default handler for deserializing a CAS from XMI.XmiCasDeserializer.getXmiCasHandler
(CAS cas, boolean lenient, XmiSerializationSharedData sharedData) Create a default handler for deserializing a CAS from XMI.XmiCasDeserializer.getXmiCasHandler
(CAS cas, boolean lenient, XmiSerializationSharedData sharedData, int mergePoint) Create a default handler for deserializing a CAS from XMI.XmiCasDeserializer.getXmiCasHandler
(CAS cas, boolean lenient, XmiSerializationSharedData sharedData, int mergePoint, AllowPreexistingFS allow) Create a default handler for deserializing a CAS from XMI.(package private) void
CASImpl.refreshView
(CAS cas, SofaFS aSofa) 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.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.static void
XmiCasSerializer.serialize
(CAS aCAS, OutputStream aStream) Serializes a CAS to an XMI 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.void
XmiCasSerializer.serialize
(CAS cas, ContentHandler contentHandler) Write the CAS data to a SAX content handler.(package private) void
XmiCasSerializer.serialize
(CAS cas, ContentHandler contentHandler, XmiCasSerializer.XmiDocSerializer ser) 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 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 serializationstatic 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 formatstatic 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 4static void
Serialization.serializeWithCompression
(CAS cas, Object out, Marker marker) Serialize in compress binary form 4, only the delta part of a CASstatic 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
private void
CASImpl.setViewForSofaNbr
(int nbr, CAS view) Constructors in org.apache.uima.cas.impl with parameters of type CAS -
Uses of CAS in org.apache.uima.collection
Methods in org.apache.uima.collection with parameters of type CASModifier and TypeMethodDescriptionvoid
StatusCallbackListener.entityProcessComplete
(CAS aCas, EntityProcessStatus aStatus) Called when the processing of each entity has completed.void
Gets the next element of the collection.void
CasInitializer.initializeCas
(Object aObj, CAS aCAS) Deprecated.Reads content and metadata from an Object and initializes aCAS
.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 CASModifier and TypeMethodDescriptionvoid
CasObjectProcessor.processCas
(CAS aCAS) Process a single CAS.void
CasObjectProcessor.processCas
(CAS[] aCASes) Processes multiple CASes. -
Uses of CAS in org.apache.uima.collection.impl
Methods in org.apache.uima.collection.impl with parameters of type CASModifier and TypeMethodDescriptionCasConverter.casContainerToCasData
(CAS aContainer) Convert CAS Container (aka CAS Object) to CAS Datavoid
CasConverter.casDataToCasContainer
(CasData aData, CAS aContainer, boolean aLenient) Convert CAS Data to CAS Container (aka CAS Object) -
Uses of CAS in org.apache.uima.collection.impl.cpm
Methods in org.apache.uima.collection.impl.cpm with parameters of type CASModifier and TypeMethodDescriptionvoid
StatusCallbackListenerImpl.entityProcessComplete
(CAS aCas, EntityProcessStatus aStatus) Called when the processing of a Document is completed. -
Uses of CAS in org.apache.uima.collection.impl.cpm.container
Methods in org.apache.uima.collection.impl.cpm.container with parameters of type CASModifier and TypeMethodDescriptionvoid
CasObjectNetworkCasProcessorImpl.processCas
(CAS aCAS) Uses configured transport to delegate given CAS to the remote servicevoid
CasObjectNetworkCasProcessorImpl.processCas
(CAS[] aCASes) Uses configured transport to delegate given CASes to the remote service -
Uses of CAS in org.apache.uima.collection.impl.cpm.container.deployer.socket
Methods in org.apache.uima.collection.impl.cpm.container.deployer.socket that return CASModifier and TypeMethodDescriptionInvokes fenced CasProcessor.Methods in org.apache.uima.collection.impl.cpm.container.deployer.socket with parameters of type CAS -
Uses of CAS in org.apache.uima.collection.impl.cpm.engine
Fields in org.apache.uima.collection.impl.cpm.engine declared as CASModifier and TypeFieldDescriptionprivate CAS[]
WorkUnit.cas
private CAS[]
NonThreadedProcessingUnit.casCache
private CAS[]
ProcessingUnit.casCache
private CAS[]
ArtifactProducer.casList
protected CAS[]
NonThreadedProcessingUnit.casList
protected CAS[]
ProcessingUnit.casList
protected CAS
NonThreadedProcessingUnit.conversionCas
protected CAS
ProcessingUnit.conversionCas
protected CAS[]
NonThreadedProcessingUnit.conversionCasArray
protected CAS[]
ProcessingUnit.conversionCasArray
Methods in org.apache.uima.collection.impl.cpm.engine that return CASModifier and TypeMethodDescriptionCPECasPool.getCas()
Checks out a CAS from the pool.CPECasPool.getCas
(long aTimeout) Returns a Cas instance from the pool.CAS[]
WorkUnit.getCas()
CPECasPool.getCheckedOutCas
(int aIndex) Returns a CAS found in a given position in the list.Methods in org.apache.uima.collection.impl.cpm.engine with parameters of type CASModifier and TypeMethodDescriptionstatic void
CPMEngine.callEntityProcessCompleteWithCAS
(StatusCallbackListener statCL, CAS cas, EntityProcessStatus eps) Internal use only, public for crss package access.static int
ConsumerCasUtils.getIntFeatValue
(CAS aCasView, String aTypeS, String aFeatS) Returns an int value of a given Feature Structurestatic String
ConsumerCasUtils.getStringFeatValue
(CAS aCasView, String aTypeS, String aFeatS) Returns a string value of a given Feature Structurestatic FeatureStructure
Returns a Feature Structure of a given typevoid
ArtifactProducer.invalidate
(CAS[] aCasList) void
BoundedWorkQueue.invalidate
(CAS[] aCasObjectList) void
SequencedQueue.invalidate
(CAS[] aCasObjectList) void
CPMEngine.invalidateCASes
(CAS[] aCASList) private void
ProcessingUnit.maybeLogFinest
(String msgBundleId, CAS[] casCache) private void
ProcessingUnit.maybeLogFinest
(String msgBundleId, ProcessingContainer container, CasProcessor processor, CAS[] casCache) private void
ArtifactProducer.notifyListeners
(CAS aCas, Exception anException) Notify registered callback listeners of a given exception.void
CPECasPool.releaseCas
(CAS aCas) Checks in a CAS to the pool.void
CPMEngine.releaseCASes
(CAS[] aCASList) Releases given cases back to pool.void
-
Uses of CAS in org.apache.uima.collection.impl.cpm.utils
Methods in org.apache.uima.collection.impl.cpm.utils with parameters of type CASModifier and TypeMethodDescriptionstatic ChunkMetadata
CPMUtils.getChunkMetadata
(CAS aCas) Extract metadata associated with chunk from a given CAS.static int
CPMUtils.getFeatureAsInt
(CAS aCas, Feature aFeature, String aName) static String
CPMUtils.getFeatureAsString
(CAS aCas, Feature aFeature, String aName) Returns a value associated with a given feature -
Uses of CAS in org.apache.uima.flow
Fields in org.apache.uima.flow declared as CASMethods in org.apache.uima.flow that return CASModifier and TypeMethodDescriptionprotected 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 CASMethods in org.apache.uima.flow with parameters of type CASModifier and TypeMethodDescriptionprivate void
CasFlowController_ImplBase.checkTypeSystemChange
(CAS aCAS) 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
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 CASModifier and TypeMethodDescriptionCapabilityLanguageFlowController.computeFlow
(CAS aCAS) FixedFlowController.computeFlow
(CAS aCAS) FixedFlowController.FixedFlowObject.newCasProduced
(CAS newCas, String producedBy) -
Uses of CAS in org.apache.uima.impl
Fields in org.apache.uima.impl with type parameters of type CASModifier and TypeFieldDescriptionUimaContext_ImplBase.mOutstandingCASes
CASes that have been requested viaUimaContext_ImplBase.getEmptyCas(Class)
minus the number calls the framework has made toUimaContext_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 CASModifier and TypeMethodDescriptionstatic CASImpl
Util.getStartingView
(CAS cas, boolean sofaAware, ComponentInfo componentInfo) static <T extends AbstractCas>
TUtil.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 -
Uses of CAS in org.apache.uima.jcas.cas
Methods in org.apache.uima.jcas.cas that return CAS -
Uses of CAS in org.apache.uima.jcas.impl
Methods in org.apache.uima.jcas.impl that return CASMethods in org.apache.uima.jcas.impl with parameters of type CAS -
Uses of CAS in org.apache.uima.json
Methods in org.apache.uima.json with parameters of type CASModifier and TypeMethodDescriptionstatic void
JsonCasSerializer.jsonSerialize
(CAS aCAS, Object output) Serializes a CAS using JSONstatic 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
Serialize a Cas to an Output, using configurations set on this instance.void
JsonCasSerializer.serialize
(CAS cas, Object output, XmiSerializationSharedData sharedData, Marker marker) 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) -
Uses of CAS in org.apache.uima.resource
Methods in org.apache.uima.resource that return CASModifier and TypeMethodDescriptionCasManager.createNewCas
(Properties aPerformanceTuningSettings) Create a new CAS using the CasDefinition stored in this CAS Manager.Gets an empty CAS.Methods in org.apache.uima.resource with parameters of type CASModifier and TypeMethodDescriptionCasManager.getCasInterface
(CAS cas, Class<? extends AbstractCas> requiredInterface) Gets a specified interface to a CAS. -
Uses of CAS in org.apache.uima.resource.impl
Fields in org.apache.uima.resource.impl with type parameters of type CASModifier and TypeFieldDescriptionCasManager_impl.mCasToCasPoolMap
private final Map
<CAS, UimaContext> CasManager_impl.mCasToUimaContextMap
Methods in org.apache.uima.resource.impl that return CASModifier and TypeMethodDescriptionCasManager_impl.createNewCas
(Properties aPerformanceTuningSettings) Methods in org.apache.uima.resource.impl that return types with arguments of type CASMethods in org.apache.uima.resource.impl with parameters of type CASModifier and TypeMethodDescriptionCasManager_impl.getCasInterface
(CAS cas, Class<? extends AbstractCas> requiredInterface) Gets a specified interface to a CAS.static <T extends AbstractCas>
TCasManager_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 -
Uses of CAS in org.apache.uima.resource.metadata.impl
Methods in org.apache.uima.resource.metadata.impl with parameters of type CAS -
Uses of CAS in org.apache.uima.test.junit_extension
Methods in org.apache.uima.test.junit_extension that return CASModifier and TypeMethodDescriptionAnnotatorTester.createCAS()
Creates a new fresh CAS instance which can be used for testing.static CAS
AnnotatorTester.getCASfromXCAS
(File tsFile, File xcasFile) create a CAS object from the given XCAS and typesystem filesAnnotatorTester.performTest
(String text, String language) performs a test on the initialized annotator.static CAS
AnnotatorTester.performTest
(String descFilePath, String text, String language) performs a test with a special annotator configuration.AnnotatorTester.performTest
(CAS cas) performs a test on the initialized annotator.Methods in org.apache.uima.test.junit_extension with parameters of type CASModifier and TypeMethodDescriptionstatic void
AnnotatorTester.checkResult
(CAS cas, String[] AnnotationTypes, File refFile, File testFile) checkResult compares the analyzed document with the reference output.AnnotatorTester.performTest
(CAS cas) performs a test on the initialized annotator.void
AnnotationWriter.processCas
(CAS aCAS) private HashMap
AnnotationWriter.processTofs
(CAS aCAS, String[] someTofs) processTofs() writes als specified types an features to a HashMap. -
Uses of CAS in org.apache.uima.tools
Methods in org.apache.uima.tools with parameters of type CASModifier and TypeMethodDescriptionvoid
RunAE.entityProcessComplete
(CAS aCas, EntityProcessStatus aStatus) -
Uses of CAS in org.apache.uima.tools.components
Methods in org.apache.uima.tools.components with parameters of type CASModifier and TypeMethodDescriptionvoid
void
void
InlineXmlCasConsumer.processCas
(CAS aCAS) Processes the CasContainer which was populated by the TextAnalysisEngines.void
XCasWriterCasConsumer.processCas
(CAS aCAS) Processes the CasContainer which was populated by the TextAnalysisEngines.void
XmiWriterCasConsumer.processCas
(CAS aCAS) Processes the CAS which was populated by the TextAnalysisEngines.private void
Serialize a CAS to a file in XCAS formatprivate void
Serialize a CAS to a file in XMI format -
Uses of CAS in org.apache.uima.tools.cpm
Methods in org.apache.uima.tools.cpm with parameters of type CASModifier and TypeMethodDescriptionvoid
CpmPanel.StatusCallbackListenerImpl.entityProcessComplete
(CAS aCas, EntityProcessStatus aStatus) -
Uses of CAS in org.apache.uima.tools.cvd
Fields in org.apache.uima.tools.cvd declared as CASMethods in org.apache.uima.tools.cvd that return CASMethods in org.apache.uima.tools.cvd with parameters of type CAS -
Uses of CAS in org.apache.uima.tools.docanalyzer
Fields in org.apache.uima.tools.docanalyzer declared as CASModifier and TypeFieldDescriptionprivate CAS
AnnotationViewerDialog.cas
protected CAS
DocumentAnalyzer.cas
Methods in org.apache.uima.tools.docanalyzer that return CASModifier and TypeMethodDescriptionprotected CAS
DocumentAnalyzer.createCasFromDescriptor
(String aDescriptorFile) Creates a CAS from an descriptor.Methods in org.apache.uima.tools.docanalyzer with parameters of type CASModifier and TypeMethodDescriptionvoid
DocumentAnalyzer.entityProcessComplete
(CAS aCas, EntityProcessStatus aStatus) Constructors in org.apache.uima.tools.docanalyzer with parameters of type CASModifierConstructorDescriptionAnnotationViewerDialog
(JFrame aParentFrame, String aDialogTitle, PrefsMediator med, File aStyleMapFile, String aPerformanceStats, TypeSystem aTypeSystem, String[] aTypesToDisplay, boolean generatedStyleMap, CAS cas) AnnotationViewerDialog
(JFrame aParentFrame, String aDialogTitle, PrefsMediator med, File aStyleMapFile, String aPerformanceStats, TypeSystem aTypeSystem, String[] aTypesToDisplay, String interactiveTempFN, boolean javaViewerRBisSelected, boolean javaViewerUCRBisSelected, boolean xmlRBisSelected, CAS cas) Create an AnnotationViewer Dialog -
Uses of CAS in org.apache.uima.tools.jcasgen
Fields in org.apache.uima.tools.jcasgen declared as CAS -
Uses of CAS in org.apache.uima.tools.stylemap
Methods in org.apache.uima.tools.stylemap with parameters of type CASModifier and TypeMethodDescriptionprivate JTree
AnnotationFeaturesViewer.generateTreeView
(AnalysisEngineDescription analysisEngine, AnalysisEngineMetaData aeMetaData, CAS cas) private String[]
AnnotationFeaturesViewer.getFeatureNamesForType
(String aTypeName, CAS cas) StyleMapEditor.launchEditor
(AnalysisEngineMetaData aAnalysisEngineMetaData, String aStyleMapXml, CAS cas) Displays the StyleMapEditor GUI and allows the user to edit a style map.private boolean
Displays the Style Map Editor GUI and allows the user to interact with it.void
AnnotationFeaturesViewer.populate
(AnalysisEngineDescription analysisEngine, AnalysisEngineMetaData aeMetaData, CAS cas) Constructors in org.apache.uima.tools.stylemap with parameters of type CAS -
Uses of CAS in org.apache.uima.tools.viewer
Fields in org.apache.uima.tools.viewer declared as CASMethods in org.apache.uima.tools.viewer with parameters of type CASModifier and TypeMethodDescriptionprivate TreeNode
Builds a tree from a CAS.void
Sets the CAS to be viewed.Constructors in org.apache.uima.tools.viewer with parameters of type CAS -
Uses of CAS in org.apache.uima.uimacpp
Fields in org.apache.uima.uimacpp declared as CASMethods in org.apache.uima.uimacpp that return CASMethods in org.apache.uima.uimacpp that return types with arguments of type CASMethods in org.apache.uima.uimacpp with parameters of type CASModifier and TypeMethodDescriptionvoid
nextvoid
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
Fields in org.apache.uima.util declared as CASModifier and TypeFieldDescriptionprivate CAS
XmlCasDeserializer.XmlCasDeserializerHandler.mCAS
private final CAS
CasCopier.originalSrcCas
private final CAS
CasCopier.originalTgtCas
Fields in org.apache.uima.util with type parameters of type CASMethods in org.apache.uima.util that return CASModifier and TypeMethodDescriptionstatic 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
(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
(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 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
(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.private static CAS
CasCreationUtils.doCreateCas
(TypeSystem aTypeSystem, TypeSystemDescription aTypeSystemDesc, TypePriorities aTypePriorities, FsIndexDescription[] aFsIndexes, Properties aPerformanceTuningSettings, ResourceManager aResourceManager) Method that does the work for creating a new CAS instance.CasPool.getCas()
Checks out a CAS from the pool.CasPool.getCas
(long aTimeout) Checks out a CAS from the pool.private CAS
CasPool.getCasAfterPermitAcquired()
Methods in org.apache.uima.util that return types with arguments of type CASModifier and TypeMethodDescriptionCasPool.fillPool
(int aNumInstances, Collection<? extends ProcessingResourceMetaData> mdList, Properties performanceTuningSettings, ResourceManager resourceManager) CasPool.fillPool
(int aNumInstances, CasDefinition casDef, Properties performanceTuningSettings) CasPool.fillPool
(int aNumInstances, CasManager casManager, Properties performanceTuningSettings) CasPool.getAllInstances()
CasPool.getFreeInstances()
Methods in org.apache.uima.util with parameters of type CASModifier and TypeMethodDescriptionprivate boolean
CasCopier.casViewsInSameCas
(CAS c1, CAS c2) Change from https://issues.apache.org/jira/browse/UIMA-3112 : requires that the CAS returned from the getLowLevelCAS() be castable to CASImplstatic void
Does a complete deep copy of one CAS into another CAS.static void
Does a complete deep copy of one CAS into another CAS.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.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, 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
(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.private void
CasCopier.copyCasViewDifferentCASs
(CAS aSrcCasView, CAS aTgtCasView, boolean aCopySofa) 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.Formats a CAS as a String.CasToInlineXml.format
(CAS aCAS, FSMatchConstraint aFilter) Formats a CAS as a String.Produces a string representation of a CAS.TCasFormatter.format
(CAS aCAS, FSMatchConstraint aFilter) Produces a string representation of a CAS.Deprecated.TCasToInlineXml.format
(CAS aCAS, FSMatchConstraint aFilter) Deprecated.CasToInlineXml.generateXML
(CAS aCAS) Generates inline XML from a CAS.CasToInlineXml.generateXML
(CAS aCAS, FSMatchConstraint aFilter) Generates inline XML from a CAS.void
CasToInlineXml.generateXML
(CAS aCAS, FSMatchConstraint aFilter, ContentHandler aHandler) Generates inline XML from a CAS using a passed in ContentHandlerTCasToInlineXml.generateXML
(CAS aCAS) Deprecated.TCasToInlineXml.generateXML
(CAS aCAS, FSMatchConstraint aFilter) Deprecated.private Attributes
CasToInlineXml.getFeatureAttributes
(FeatureStructure aFS, CAS aCAS) private final Attributes
TCasToInlineXml.getFeatureAttributes
(FeatureStructure aFS, CAS aCAS) Deprecated.static int
ConsumerCasUtils.getIntFeatValue
(CAS aCasView, String aTypeS, String aFeatS) private static CASImpl
CasCopier.getOrCreateView
(CAS aCas, String aViewName) Gets the named view; if the view doesn't exist it will be created.static String
ConsumerCasUtils.getStringFeatValue
(CAS aCasView, String aTypeS, String aFeatS) static FeatureStructure
void
CasPool.releaseCas
(CAS aCas) Checks in a CAS to the pool.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.Constructors in org.apache.uima.util with parameters of type CASModifierConstructorDescriptionCreates a new CasCopier that can be used to copy FeatureStructures from one CAS to another.Creates a new CasCopier that can be used to copy FeatureStructures from one CAS to another.(package private)
XmlCasDeserializerHandler
(CAS cas, boolean lenient) Constructor parameters in org.apache.uima.util with type arguments of type CAS