Uses of Interface
org.apache.uima.cas.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.
This package contains the editor classes.
Classes and interfaces for collection processing.
uimaFIT-enhanced base classes for UIMA components and some simple components.
Factories to create different kinds of UIMA resource specifiers.
Executing UIMA pipelines.
Apache UIMA internals
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.
Utility classes and interfaces used by UIMA components.
-
Uses of CAS in org.apache.uima.adapter.vinci
Modifier and TypeMethodDescriptionvoid
VinciAnalysisEngineServiceStub.callProcess
(CAS aCAS) Call process.void
VinciBinaryAnalysisEngineServiceStub.callProcess
(CAS aCAS) Call process.void
VinciAnalysisEngineServiceStub.callProcessCas
(CAS aCAS) Call process cas.ModifierConstructorDescriptionCASTransportable
(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
Modifier and TypeMethodDescriptionprotected final CAS
CasMultiplier_ImplBase.getEmptyCAS()
Gets an empty CAS that this CAS Multiplier can then populate.Modifier and TypeMethodDescriptionCasAnnotator_ImplBase.getRequiredCasInterface()
CasMultiplier_ImplBase.getRequiredCasInterface()
-
Uses of CAS in org.apache.uima.analysis_engine
Modifier 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.Modifier 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
Modifier 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
Modifier and TypeMethodDescriptionInvokes the processing of the aggregate on the given input CAS. -
Uses of CAS in org.apache.uima.analysis_engine.asb.impl
Modifier 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) ModifierConstructorDescriptionFlowContainer
(Flow aFlow, FlowControllerContainer aFlowControllerContainer, CAS aCAS) -
Uses of CAS in org.apache.uima.analysis_engine.impl
Modifier and TypeFieldDescriptionprotected CAS
AnalysisProcessData_impl.mCAS
Deprecated.The CAS owned by this AnalysisProcessData.Modifier 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()
Modifier 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) void
Performs service call to process an entity.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) AnalysisEngineProcessorAdapter.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) ModifierConstructorDescriptionAnalysisProcessData_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
. andProcessTrace
objects. -
Uses of CAS in org.apache.uima.analysis_engine.impl.compatibility
Modifier and TypeMethodDescriptionCasConsumerAdapter.getRequiredCasInterface()
Get the CAS interface required by this CasConsumer. -
Uses of CAS in org.apache.uima.analysis_engine.service.impl
Modifier and TypeMethodDescriptionprotected CAS
AnalysisEngineService_impl.getCasFromPool
(int aTimeout) Gets a CAS from the CAS Pool.Modifier and TypeMethodDescriptionAnalysisEngineServiceAdapter.processAndOutputNewCASes
(CAS aCAS) void
ServiceDataCargo.unmarshalCas
(CAS aCas, boolean aReplaceCasTypeSystem) Unmarshalls the CAS data in thisServiceDataCargo
into an existingCAS
instance.ModifierConstructorDescriptionServiceDataCargo
(CAS aCAS, ProcessTrace aProcessTrace) Creates a newSerializableAnalysisProcessData
that contains the givenCAS
andProcessTrace
. -
Uses of CAS in org.apache.uima.cas
Modifier and TypeMethodDescriptionCAS.createView
(String localViewName) Create a view and its underlying Sofa (subject of analysis).FeatureStructure.getCAS()
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).Modifier and TypeMethodDescriptionCAS.getViewIterator
(String localViewNamePrefix) Get iterator over all views with the given name prefix. -
Uses of CAS in org.apache.uima.cas.admin
-
Uses of CAS in org.apache.uima.cas.impl
Modifier 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()
CASImpl.getView
(int sofaNum) Modifier and TypeMethodDescriptionvoid
FeatureStructureImplC.addToIndexes
(CAS cas) static StringBuilder
CasCompare.compareNumberOfFSsByType
(CAS cas1, CAS cas2) Counts and compares the number of Feature Structures, by type, and generates a reportstatic 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
XCASDeserializer.deserialize
(Reader aReader, CAS aCAS, boolean aLenient) Deserializes an XCAS from a stream.static void
XCASDeserializer.deserialize
(InputSource aSource, CAS aCAS, boolean aLenient) 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.static final boolean
void
FeatureStructureImplC.removeFromIndexes
(CAS cas) remove this FS from indexes in a specific view, perhaps different from the view where this was created.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.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.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.void
XmiCasSerializer.serialize
(CAS cas, ContentHandler contentHandler) 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 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 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. - To omit type filtering, use null for the target type system It also only sends those feature structures which are reachable either from an index or references from other reachable feature structures.static 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. - To omit type filtering, use null for the target type system It also only sends those feature structures which are reachable either from an index or references from other reachable feature structures.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. - To omit type filtering, use null for the target type system It also only sends those feature structures which are reachable either from an index or references from other reachable feature structures.void
Deprecated.Does nothing, kept only for backwards compatibilityModifierConstructorDescriptionSelectFSs_impl
(CAS cas) SelectFSs_impl
(FeatureStructure[] source, CAS cas) Create information about a view for given CAS. -
Uses of CAS in org.apache.uima.caseditor.editor
Modifier and TypeMethodDescriptionDocumentUimaImpl.getCAS()
Retrieves theCAS
.ICasDocument.getCAS()
Retrieves the CAS.static CAS
DocumentUimaImpl.getVirginCAS
(org.eclipse.core.resources.IFile extensionTypeSystemFile) Gets the virgin CAS.ModifierConstructorDescriptionDocumentUimaImpl
(CAS cas, org.eclipse.core.resources.IFile casFile, String typeSystemText) Initializes a new instance. -
Uses of CAS in org.apache.uima.collection
Modifier 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
Modifier 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
Modifier 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.container
Modifier and TypeMethodDescriptionvoid
CasObjectNetworkCasProcessorImpl.processCas
(CAS aCAS) Uses configured transport to delegate given CAS to the remote service.void
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
Modifier and TypeMethodDescriptionInvokes fenced CasProcessor. -
Uses of CAS in org.apache.uima.collection.impl.cpm.engine
Modifier and TypeFieldDescriptionprotected CAS[]
NonThreadedProcessingUnit.casList
The cas list.protected CAS[]
ProcessingUnit.casList
The cas list.protected CAS
NonThreadedProcessingUnit.conversionCas
The conversion cas.protected CAS
ProcessingUnit.conversionCas
The conversion cas.protected CAS[]
NonThreadedProcessingUnit.conversionCasArray
The conversion cas array.protected CAS[]
ProcessingUnit.conversionCasArray
The conversion cas array.Modifier and TypeMethodDescriptionCPECasPool.getCas()
Checks out a CAS from the pool.CPECasPool.getCas
(long aTimeout) Returns a Cas instance from the pool.CAS[]
WorkUnit.getCas()
Gets the cas.CPECasPool.getCheckedOutCas
(int aIndex) Returns a CAS found in a given position in the list.Modifier and TypeMethodDescriptionstatic void
CPMEngine.callEntityProcessCompleteWithCAS
(StatusCallbackListener statCL, CAS cas, EntityProcessStatus eps) Internal use only, public for cross package access. switches class loaders and locks casstatic int
ConsumerCasUtils.getIntFeatValue
(CAS aCasView, String aTypeS, String aFeatS) Returns an int value of a given Feature Structure.static String
ConsumerCasUtils.getStringFeatValue
(CAS aCasView, String aTypeS, String aFeatS) Returns a string value of a given Feature Structure.static FeatureStructure
Returns a Feature Structure of a given type.void
ArtifactProducer.invalidate
(CAS[] aCasList) Invalidate.void
BoundedWorkQueue.invalidate
(CAS[] aCasObjectList) Invalidate.void
SequencedQueue.invalidate
(CAS[] aCasObjectList) void
CPMEngine.invalidateCASes
(CAS[] aCASList) Invalidate CA ses.void
CPECasPool.releaseCas
(CAS aCas) Checks in a CAS to the pool.void
CPMEngine.releaseCASes
(CAS[] aCASList) Releases given cases back to pool.void
Sets the cas. -
Uses of CAS in org.apache.uima.collection.impl.cpm.utils
Modifier 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) Gets the feature as int.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.fit.benchmark
Modifier and TypeMethodDescriptionstatic void
CasInitializationUtils.initRandomCas
(CAS cas, int typeCount, int annotationCount, int maxAnnotationLength, int approxDocLength, long seed) -
Uses of CAS in org.apache.uima.fit.component
-
Uses of CAS in org.apache.uima.fit.factory
Modifier and TypeMethodDescriptionstatic CAS
CasFactory.createCas()
Creates a newCAS
.static CAS
Creates a newCAS
from type system descriptor files found by name.static CAS
CasFactory.createCas
(String fileName, TypeSystemDescription typeSystemDescription) This method creates a new CAS and loads the contents of an XMI or XCAS file into it.static CAS
CasFactory.createCas
(TypeSystemDescription typeSystemDescription) Create a new CAS for the given type system description.static CAS
CasFactory.createCasFromPath
(String... typeSystemDescriptorPaths) Creates a new CAS from type system descriptor files.static CAS
CasFactory.createText
(String aText) Creates a new CAS with the given text.static CAS
CasFactory.createText
(String aText, String aLanguage) Creates a new CAS with the given text and language. -
Uses of CAS in org.apache.uima.fit.pipeline
Modifier and TypeMethodDescriptionstatic void
SimplePipeline.runPipeline
(CAS cas, AnalysisEngine... engines) Run a sequence ofanalysis engines
over aCAS
.static void
SimplePipeline.runPipeline
(CAS aCas, AnalysisEngineDescription... aDescs) Run a sequence ofanalysis engines
over aJCas
. -
Uses of CAS in org.apache.uima.fit.testing.assertj
-
Uses of CAS in org.apache.uima.fit.testing.junit
-
Uses of CAS in org.apache.uima.fit.util
Modifier and TypeMethodDescriptionstatic CAS
Convenience method to get the specified view or create a new view if the requested view does not exist.static CAS
Convenience method to get the specified view or a default view if the requested view does not exist.Modifier and TypeMethodDescriptionstatic ContainmentIndex
<AnnotationFS, AnnotationFS> ContainmentIndex.create
(CAS cas, Type aSuper, Type aUnder, ContainmentIndex.Type aType) Factory method to create an index instead of using the constructor.static List
<FeatureStructure> Deprecated.Usecas.select(type).asList()
static <T extends FeatureStructure>
ArrayFS<T> FSCollectionFactory.createArrayFS
(CAS aCas, Collection<T> aCollection) static <T extends FeatureStructure>
ArrayFS<T> FSCollectionFactory.createArrayFS
(CAS aCas, T... aArray) static BooleanArrayFS
FSCollectionFactory.createBooleanArrayFS
(CAS aCas, boolean... aArray) static BooleanArrayFS
FSCollectionFactory.createBooleanArrayFS
(CAS aCas, Collection<Boolean> aCollection) static ByteArrayFS
FSCollectionFactory.createByteArrayFS
(CAS aCas, byte... aArray) static ByteArrayFS
FSCollectionFactory.createByteArrayFS
(CAS aCas, Collection<Byte> aCollection) static DoubleArrayFS
FSCollectionFactory.createDoubleArrayFS
(CAS aCas, double... aArray) static DoubleArrayFS
FSCollectionFactory.createDoubleArrayFS
(CAS aCas, Collection<Double> aCollection) static FloatArrayFS
FSCollectionFactory.createFloatArrayFS
(CAS aCas, float... aArray) static FloatArrayFS
FSCollectionFactory.createFloatArrayFS
(CAS aCas, Collection<Float> aCollection) static <T extends FeatureStructure>
TFSCollectionFactory.createFloatList
(CAS aCas, float... aValues) static <T extends FeatureStructure>
TFSCollectionFactory.createFloatList
(CAS aCas, Collection<Float> aValues) FSCollectionFactory.createFSList
(CAS aCas, Collection<T> aValues) FSCollectionFactory.createFSList
(CAS aCas, T... aValues) static IntArrayFS
FSCollectionFactory.createIntArrayFS
(CAS aCas, int... aArray) static IntArrayFS
FSCollectionFactory.createIntArrayFS
(CAS aCas, Collection<Integer> aCollection) static <T extends FeatureStructure>
TFSCollectionFactory.createIntegerList
(CAS aCas, int... aValues) static <T extends FeatureStructure>
TFSCollectionFactory.createIntegerList
(CAS aCas, Collection<Integer> aValues) static LongArrayFS
FSCollectionFactory.createLongArrayFS
(CAS aCas, long... aArray) static LongArrayFS
FSCollectionFactory.createLongArrayFS
(CAS aCas, Collection<Long> aCollection) static ShortArrayFS
FSCollectionFactory.createShortArrayFS
(CAS aCas, short... aArray) static ShortArrayFS
FSCollectionFactory.createShortArrayFS
(CAS aCas, Collection<Short> aCollection) static StringArrayFS
FSCollectionFactory.createStringArrayFS
(CAS aCas, String... aArray) static StringArrayFS
FSCollectionFactory.createStringArrayFS
(CAS aCas, Collection<String> aCollection) static <T extends FeatureStructure>
TFSCollectionFactory.createStringList
(CAS aCas, String... aValues) static <T extends FeatureStructure>
TFSCollectionFactory.createStringList
(CAS aCas, Collection<String> aValues) static <T extends TOP>
booleanTest if a CAS contains an annotation of the given type.static Type
CasUtil.getAnnotationType
(CAS aCas, Class<?> aJCasClass) Get the CAS type for the given JCas wrapper class making sure it is or inherits fromAnnotation
.static Type
CasUtil.getAnnotationType
(CAS aCas, String aTypeName) Get the CAS type for the given name making sure it is or inherits from Annotation.static Type
Get the CAS type for the given JCas wrapper class.static Type
Get the CAS type for the given name.static CAS
Convenience method to get the specified view or create a new view if the requested view does not exist.static CAS
Convenience method to get the specified view or a default view if the requested view does not exist.static Map
<AnnotationFS, List<AnnotationFS>> CasUtil.indexCovered
(CAS cas, Type type, Type coveredType) Create an index for quickly lookup up the annotations covered by a particular annotation.static Map
<AnnotationFS, List<AnnotationFS>> CasUtil.indexCovering
(CAS cas, Type type, Type coveringType) Create an index for quickly lookup up the annotations covering a particular annotation.static boolean
CasUtil.isAnnotationType
(CAS aCas, Type aType) static <T extends AnnotationFS>
Iterator<T> Get an iterator over the given annotation type.static <T extends FeatureStructure>
Iterator<T> CasUtil.iteratorFS
(CAS cas, Type type) Deprecated.Usecas.select(type).iterator()
static void
Deprecated.UseCasIOUtils.load(java.net.URL, CAS)
instead.static void
Deprecated.UseCasIOUtils.load(java.net.URL, CAS)
instead.static void
Deprecated.UseCasIOUtils.load(java.net.URL, CAS)
instead.static void
CasUtil.requireAnnotationType
(CAS aCas, Type aType) static Collection
<AnnotationFS> Convenience method to iterator over all annotations of a given type.static Collection
<AnnotationFS> Convenience method to iterator over all annotations.static Collection
<FeatureStructure> CasUtil.selectAllFS
(CAS aCas) Convenience method to iterator over all features structures.static List
<AnnotationFS> Get all annotations of the given type at the specified offsets.static List
<AnnotationFS> CasUtil.selectBetween
(CAS cas, Type type, AnnotationFS ann1, AnnotationFS ann2) Get a list of annotations of the given annotation type located between two annotations.static AnnotationFS
CasUtil.selectByIndex
(CAS cas, Type type, int index) This method exists simply as a convenience method for unit testing.static List
<AnnotationFS> CasUtil.selectCovered
(CAS cas, Type type, int begin, int end) Get a list of annotations of the given annotation type constraint by a certain annotation.static List
<AnnotationFS> CasUtil.selectCovered
(CAS cas, Type type, AnnotationFS coveringAnnotation) Get a list of annotations of the given annotation type constraint by a certain annotation.static List
<AnnotationFS> CasUtil.selectCovering
(CAS cas, Type type, int begin, int end) Get a list of annotations of the given annotation type constraint by a certain annotation.static List
<AnnotationFS> CasUtil.selectCovering
(CAS cas, Type type, AnnotationFS coveredAnnotation) Get a list of annotations of the given annotation type constraint by a certain annotation.static List
<AnnotationFS> CasUtil.selectFollowing
(CAS cas, Type type, AnnotationFS anchor, int count) Returns the n annotations following the given annotationstatic <T extends FeatureStructure>
List<T> Deprecated.Usecas.select(type).asList()
static List
<AnnotationFS> CasUtil.selectOverlapping
(CAS aCas, Type aType, int aSelBegin, int aSelEnd) Get a list of annotations of the given annotation type overlapping the given span.static List
<AnnotationFS> CasUtil.selectOverlapping
(CAS aCas, Type aType, AnnotationFS aBoundaryAnnotation) Get a list of annotations of the given annotation type overlapping the given annotation.static List
<AnnotationFS> CasUtil.selectPreceding
(CAS cas, Type type, AnnotationFS anchor, int count) Returns the n annotations preceding the given annotationstatic AnnotationFS
CasUtil.selectSingle
(CAS cas, Type type) Get the single instance of the specified type from the CAS.static AnnotationFS
CasUtil.selectSingleAt
(CAS aCas, Type aType, int aBegin, int aEnd) Get the single instance of the specified type from the CAS at the given offsets.static FeatureStructure
CasUtil.selectSingleFS
(CAS cas, Type type) Get the single instance of the specified type from the CAS.static AnnotationFS
CasUtil.selectSingleRelative
(CAS cas, Type type, AnnotationFS aAnchor, int aPosition) Return an annotation preceding or following of a given reference annotation.static void
Deprecated.static void
Deprecated.ModifierConstructorDescriptionprotected
ContainmentIndex
(CAS cas, Type aSuper, Type aUnder, ContainmentIndex.Type aType) Create a new index on the given JCas using the specified two types. -
Uses of CAS in org.apache.uima.fit.validation
Modifier and TypeMethodDescriptionApply this check to the given CAS. -
Uses of CAS in org.apache.uima.flow
Modifier and TypeMethodDescriptionprotected CAS
CasFlow_ImplBase.getCas()
Gets the CAS being routed by this Flow object.Modifier and TypeMethodDescriptionabstract 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
Modifier and TypeMethodDescriptionCapabilityLanguageFlowController.computeFlow
(CAS aCAS) FixedFlowController.computeFlow
(CAS aCAS) -
Uses of CAS in org.apache.uima.impl
Modifier 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.Modifier 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
-
Uses of CAS in org.apache.uima.jcas.cas
-
Uses of CAS in org.apache.uima.jcas.impl
-
Uses of CAS in org.apache.uima.json
Modifier 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
Modifier and TypeMethodDescriptionCasManager.createNewCas
(Properties aPerformanceTuningSettings) Create a new CAS using the CasDefinition stored in this CAS Manager.Gets an empty CAS.Modifier 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
Modifier and TypeMethodDescriptionCasManager_impl.createNewCas
(Properties aPerformanceTuningSettings) Modifier 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
-
Uses of CAS in org.apache.uima.resource.metadata.impl
-
Uses of CAS in org.apache.uima.taeconfigurator.editors
Modifier and TypeMethodDescriptionMultiPageEditor.createCas
(AnalysisEngineDescription aAeDescription, Properties aPerformanceTuningSettings, ResourceManager aResourceManager) Creates the cas.MultiPageEditor.getCurrentView()
Gets the current view. -
Uses of CAS in org.apache.uima.taeconfigurator.model
-
Uses of CAS in org.apache.uima.test.junit_extension
Modifier and TypeMethodDescriptionAnnotatorTester.createCAS()
Deprecated.Creates a new fresh CAS instance which can be used for testing.static CAS
AnnotatorTester.getCASfromXCAS
(File tsFile, File xcasFile) Deprecated.create a CAS object from the given XCAS and typesystem files.AnnotatorTester.performTest
(String text, String language) Deprecated.performs a test on the initialized annotator.static CAS
AnnotatorTester.performTest
(String descFilePath, String text, String language) Deprecated.performs a test with a special annotator configuration.AnnotatorTester.performTest
(CAS cas) Deprecated.performs a test on the initialized annotator.Modifier and TypeMethodDescriptionstatic void
AnnotatorTester.checkResult
(CAS cas, String[] AnnotationTypes, File refFile, File testFile) Deprecated.checkResult compares the analyzed document with the reference output.AnnotatorTester.performTest
(CAS cas) Deprecated.performs a test on the initialized annotator.void
AnnotationWriter.processCas
(CAS aCAS) Deprecated. -
Uses of CAS in org.apache.uima.tools
Modifier and TypeMethodDescriptionvoid
RunAE.entityProcessComplete
(CAS aCas, EntityProcessStatus aStatus) Entity process complete. -
Uses of CAS in org.apache.uima.tools.components
Modifier 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. -
Uses of CAS in org.apache.uima.tools.cvd
-
Uses of CAS in org.apache.uima.tools.docanalyzer
Modifier and TypeMethodDescriptionprotected CAS
DocumentAnalyzer.createCasFromDescriptor
(String aDescriptorFile) Creates a CAS from an descriptor.Modifier and TypeMethodDescriptionvoid
DocumentAnalyzer.entityProcessComplete
(CAS aCas, EntityProcessStatus aStatus) Entity process complete.ModifierConstructorDescriptionAnnotationViewerDialog
(JFrame aParentFrame, String aDialogTitle, PrefsMediator med, File aStyleMapFile, String aPerformanceStats, TypeSystem aTypeSystem, String[] aTypesToDisplay, boolean generatedStyleMap, CAS cas) Instantiates a new annotation viewer dialog.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.stylemap
Modifier and TypeMethodDescriptionStyleMapEditor.launchEditor
(AnalysisEngineMetaData aAnalysisEngineMetaData, String aStyleMapXml, CAS cas) Displays the StyleMapEditor GUI and allows the user to edit a style map.void
AnnotationFeaturesViewer.populate
(AnalysisEngineDescription analysisEngine, AnalysisEngineMetaData aeMetaData, CAS cas) Populate. -
Uses of CAS in org.apache.uima.tools.viewer
Modifier and TypeMethodDescriptionvoid
Sets the CAS to be viewed. -
Uses of CAS in org.apache.uima.uimacpp
Modifier 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
Modifier and TypeMethodDescriptionstatic CAS
CasCreationUtils.createCas()
Creates a new CAS instance.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. reuses an existing type system.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. reuses an existing type system.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.CasPool.getCas()
Checks out a CAS from the pool.CasPool.getCas
(long aTimeout) Checks out a CAS from the pool.Modifier and TypeMethodDescriptionstatic 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.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.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.static int
ConsumerCasUtils.getIntFeatValue
(CAS aCasView, String aTypeS, String aFeatS) static String
ConsumerCasUtils.getStringFeatValue
(CAS aCasView, String aTypeS, String aFeatS) static FeatureStructure
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
(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
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.static SerialFormat
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) ModifierConstructorDescriptionCreates 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.