Uses of Interface
org.apache.uima.jcas.JCas

Packages that use JCas

Package	Description
org.apache.uima.analysis_component
org.apache.uima.analysis_engine	The Analysis Engine interface, along with supporting interfaces and exception classes.
org.apache.uima.analysis_engine.annotator	The Annotator Interfaces, along with supporting interfaces and exception classes.
org.apache.uima.analysis_engine.impl
org.apache.uima.cas	Common Analysis System (CAS) Interfaces.
org.apache.uima.cas.impl	Implementation and Low-Level API for the CAS Interfaces.
org.apache.uima.examples
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.jcas.impl	Provides the classes that support the Java Cas Model (JCM).
org.apache.uima.jcas.tcas	JCAS model for built-in TCAS types
org.apache.uima.util	Utility classes and interfaces used by UIMA components.

Uses of JCas in org.apache.uima.analysis_component

Methods in org.apache.uima.analysis_component that return JCas

Modifier and Type	Method	Description
protected JCas	JCasMultiplier_ImplBase.getEmptyJCas()	Gets an empty JCas that this CAS Multiplier can then populate.

Methods in org.apache.uima.analysis_component that return types with arguments of type JCas

Modifier and Type	Method	Description
java.lang.Class<JCas>	JCasAnnotator_ImplBase.getRequiredCasInterface()
java.lang.Class<JCas>	JCasMultiplier_ImplBase.getRequiredCasInterface()

Methods in org.apache.uima.analysis_component with parameters of type JCas

Modifier and Type	Method	Description
abstract void	JCasAnnotator_ImplBase.process(JCas aJCas)	This method should be overriden by subclasses.
abstract void	JCasMultiplier_ImplBase.process(JCas aJCas)	This method should be overriden by subclasses.

Uses of JCas in org.apache.uima.analysis_engine

Methods in org.apache.uima.analysis_engine that return JCas

Modifier and Type	Method	Description
JCas	AnalysisEngine.newJCas()	Similar to AnalysisEngine.newCAS() but wraps the new CAS objects with the Java-object-based JCas interface.
JCas	JCasIterator.next()	Gets the next JCAS from the iterator.

Methods in org.apache.uima.analysis_engine with parameters of type JCas

Modifier and Type	Method	Description
ProcessTrace	AnalysisEngine.process(JCas aJCas)	Similar to AnalysisEngine.process(CAS) but uses the Java-object-based JCas interface instead of the general CAS interface.
ProcessTrace	AnalysisEngine.process(JCas aJCas, ResultSpecification aResultSpec)	Similar to AnalysisEngine.process(CAS,ResultSpecification) but uses the Java-object-based JCas interface instead of the general CAS interface.
void	AnalysisEngine.process(JCas aJCas, ResultSpecification aResultSpec, ProcessTrace aTrace)	Similar to AnalysisEngine.process(CAS, ResultSpecification, ProcessTrace) but uses the Java-object-based JCas interface instead of the general CAS interface.
JCasIterator	AnalysisEngine.processAndOutputNewCASes(JCas aJCAS)	Processes a JCAS, possibly producing multiple JCASes as a result.

Uses of JCas in org.apache.uima.analysis_engine.annotator

Methods in org.apache.uima.analysis_engine.annotator with parameters of type JCas

Modifier and Type	Method	Description
void	JTextAnnotator.process(JCas aJCas, ResultSpecification aResultSpec)	Deprecated. Invokes this annotator's analysis logic.

Uses of JCas in org.apache.uima.analysis_engine.impl

Methods in org.apache.uima.analysis_engine.impl that return JCas

Modifier and Type	Method	Description
JCas	AnalysisEngineImplBase.newJCas()
JCas	JCasIteratorWrapper.next()

Methods in org.apache.uima.analysis_engine.impl with parameters of type JCas

Modifier and Type	Method	Description
ProcessTrace	AnalysisEngineImplBase.process(JCas aJCas)
ProcessTrace	AnalysisEngineImplBase.process(JCas aJCas, ResultSpecification aResultSpec)
void	AnalysisEngineImplBase.process(JCas aJCas, ResultSpecification aResultSpec, ProcessTrace aTrace)
ProcessTrace	MultiprocessingAnalysisEngine_impl.process(JCas aJCas)
ProcessTrace	MultiprocessingAnalysisEngine_impl.process(JCas aJCas, ResultSpecification aResultSpec)
void	MultiprocessingAnalysisEngine_impl.process(JCas aJCas, ResultSpecification aResultSpec, ProcessTrace aTrace)
JCasIterator	AnalysisEngineImplBase.processAndOutputNewCASes(JCas aJCas)	Default implementation of processAndOutputNewCASes(JCas) method.
JCasIterator	MultiprocessingAnalysisEngine_impl.processAndOutputNewCASes(JCas aJCas)

Uses of JCas in org.apache.uima.cas

Methods in org.apache.uima.cas that return JCas

Modifier and Type	Method	Description
JCas	CAS.getJCas()	Get the JCas for this CAS.
JCas	CAS.getJCas(SofaFS aSofa)	Create a JCas view for a Sofa.
JCas	CAS.getJCas(SofaID aSofaID)	Deprecated. As of v2.0, use CAS.getView(String) followed by CAS.getJCas().

Uses of JCas in org.apache.uima.cas.impl

Methods in org.apache.uima.cas.impl that return JCas

Modifier and Type	Method	Description
JCas	CASImpl.getExistingJCas()	Internal use only
JCas	CASImpl.getJCas()
JCas	CASImpl.getJCas(SofaFS aSofa)
JCas	CASImpl.getJCas(SofaID aSofaID)	Deprecated.

Uses of JCas in org.apache.uima.examples

Constructors in org.apache.uima.examples with parameters of type JCas

Constructor	Description
SourceDocumentInformation(JCas jcas)
SourceDocumentInformation(JCas jcas, int begin, int end)
SourceDocumentInformation_Type(JCas jcas, Type casType)	initialize variables to correspond with Cas Type and Features

Uses of JCas in org.apache.uima.flow

Methods in org.apache.uima.flow that return JCas

Modifier and Type	Method	Description
protected JCas	JCasFlow_ImplBase.getJCas()	Gets the JCas being routed by this Flow object.

Methods in org.apache.uima.flow that return types with arguments of type JCas

Modifier and Type	Method	Description
java.lang.Class<JCas>	JCasFlowController_ImplBase.getRequiredCasInterface()

Methods in org.apache.uima.flow with parameters of type JCas

Modifier and Type	Method	Description
abstract Flow	JCasFlowController_ImplBase.computeFlow(JCas aJCas)	This method must be overriden by subclasses.
protected Flow	JCasFlow_ImplBase.newCasProduced(JCas newCas, java.lang.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	JCasFlow_ImplBase.setJCas(JCas aJCas)	Deprecated. this is done automatically by the framework with the Flow object is created

Uses of JCas in org.apache.uima.jcas

Methods in org.apache.uima.jcas that return JCas

Modifier and Type	Method	Description
JCas	JCas.createView(java.lang.String sofaID)	Create a view and its underlying Sofa (subject of analysis).
JCas	JCas.getJCas(Sofa sofa)	Create a JCas view for a Sofa.
JCas	JCas.getView(java.lang.String localViewName)	Get the view for a Sofa (subject of analysis).
JCas	JCas.getView(SofaFS aSofa)	Get the view for a Sofa (subject of analysis).

Methods in org.apache.uima.jcas that return types with arguments of type JCas

Modifier and Type	Method	Description
java.util.Iterator<JCas>	JCas.getViewIterator()	Get iterator over all views in this JCas.
java.util.Iterator<JCas>	JCas.getViewIterator(java.lang.String localViewNamePrefix)	Get iterator over all views with the given name prefix.

Uses of JCas in org.apache.uima.jcas.cas

Fields in org.apache.uima.jcas.cas declared as JCas

Modifier and Type	Field	Description
JCas	TOP_Type.jcas	reference to the Java Cas root

Methods in org.apache.uima.jcas.cas with parameters of type JCas

Modifier and Type	Method	Description
void	TOP.addToIndexes(JCas jcas)	add this FS to indexes in a specific view, perhaps different from the creation view
void	TOP.removeFromIndexes(JCas jcas)	remove this FS from indexes in a specific view, perhaps different from the view where this was created.

Constructors in org.apache.uima.jcas.cas with parameters of type JCas

Constructor	Description
AnnotationBase(JCas jcas)
AnnotationBase_Type(JCas jcas, Type casType)
BooleanArray(JCas jcas, int length)	Make a new BooleanArray of given size
BooleanArray_Type(JCas jcas, Type casType)
ByteArray(JCas jcas, int length)	Make a new ByteArray of given size
ByteArray_Type(JCas jcas, Type casType)
CommonArray_Type(JCas jcas, Type casType)
DoubleArray(JCas jcas, int length)	Make a new DoubleArray of given size
DoubleArray_Type(JCas jcas, Type casType)
EmptyFloatList(JCas jcas)
EmptyFloatList_Type(JCas jcas, Type casType)
EmptyFSList(JCas jcas)
EmptyFSList_Type(JCas jcas, Type casType)
EmptyIntegerList(JCas jcas)
EmptyIntegerList_Type(JCas jcas, Type casType)
EmptyStringList(JCas jcas)
EmptyStringList_Type(JCas jcas, Type casType)
FloatArray(JCas jcas, int length)	Make a new FloatArray of given size
FloatArray_Type(JCas jcas, Type casType)
FloatList(JCas jcas)
FloatList_Type(JCas jcas, Type casType)
FSArray(JCas jcas, int length)	Make a new FSArray of given size
FSArray_Type(JCas jcas, Type casType)
FSList(JCas jcas)
FSList_Type(JCas jcas, Type casType)
IntegerArray(JCas jcas, int length)	Make a new IntegerArray of given size
IntegerArray_Type(JCas jcas, Type casType)
IntegerList(JCas jcas)
IntegerList_Type(JCas jcas, Type casType)
LongArray(JCas jcas, int length)	Make a new LongArray of given size
LongArray_Type(JCas jcas, Type casType)
NonEmptyFloatList(JCas jcas)
NonEmptyFloatList(JCas jcas, float item, FloatList tail)
NonEmptyFloatList_Type(JCas jcas, Type casType)
NonEmptyFSList(JCas jcas)
NonEmptyFSList(JCas jcas, TOP item, FSList tail)
NonEmptyFSList_Type(JCas jcas, Type casType)
NonEmptyIntegerList(JCas jcas)
NonEmptyIntegerList(JCas jcas, int i, IntegerList tail)
NonEmptyIntegerList_Type(JCas jcas, Type casType)
NonEmptyStringList(JCas jcas)
NonEmptyStringList(JCas jcas, java.lang.String s, StringList tail)
NonEmptyStringList_Type(JCas jcas, Type casType)
ShortArray(JCas jcas, int length)	Make a new ShortArray of given size
ShortArray_Type(JCas jcas, Type casType)
Sofa(JCas jcas, SofaID ID, java.lang.String mimeType)	Deprecated. As of v2.0, use JCasImpl.createView(String) to create a view, which will also create the Sofa for that view.
Sofa_Type(JCas jcas, Type casType)	initialize variables to correspond with Cas Type and Features
StringArray(JCas jcas, int length)	Make a new StringArray of given size
StringArray_Type(JCas jcas, Type casType)
StringList(JCas jcas)
StringList_Type(JCas jcas, Type casType)
TOP(JCas jcas)
TOP_Type(JCas jcas, Type casType)
TOP_Type(JCas jcas, Type casType, boolean installGenerator)

Uses of JCas in org.apache.uima.jcas.impl

Classes in org.apache.uima.jcas.impl that implement JCas

Modifier and Type	Class	Description
class	JCasImpl	implements the supporting infrastructure for JCas model linked with a Cas.

Methods in org.apache.uima.jcas.impl that return JCas

Modifier and Type	Method	Description
JCas	JCasImpl.createView(java.lang.String sofaID)
static JCas	JCasImpl.getJCas(CASImpl cas)	creates a new JCas instance that corresponds to a CAS instance.
JCas	JCasImpl.getJCas(Sofa sofa)
JCas	JCasImpl.getView(java.lang.String localViewName)
JCas	JCasImpl.getView(SofaFS aSofa)

Methods in org.apache.uima.jcas.impl that return types with arguments of type JCas

Modifier and Type	Method	Description
java.util.Iterator<JCas>	JCasImpl.getViewIterator()
java.util.Iterator<JCas>	JCasImpl.getViewIterator(java.lang.String localViewNamePrefix)

Uses of JCas in org.apache.uima.jcas.tcas

Constructors in org.apache.uima.jcas.tcas with parameters of type JCas

Constructor	Description
Annotation(JCas jcas)
Annotation(JCas jcas, int begin, int end)	Constructor with begin and end passed as arguments
Annotation_Type(JCas jcas, Type casType)
DocumentAnnotation(JCas jcas)
DocumentAnnotation_Type(JCas jcas, Type casType)

Uses of JCas in org.apache.uima.util

Methods in org.apache.uima.util that return JCas

Modifier and Type	Method	Description
JCas	JCasPool.getJCas()	Checks out a JCas from the pool.
JCas	JCasPool.getJCas(long aTimeout)	Checks out a JCas from the pool.

Methods in org.apache.uima.util that return types with arguments of type JCas

Modifier and Type	Method	Description
protected java.util.Vector<JCas>	JCasPool.getAllInstances()
protected java.util.Vector<JCas>	JCasPool.getFreeInstances()

Methods in org.apache.uima.util with parameters of type JCas

Modifier and Type	Method	Description
void	JCasPool.releaseJCas(JCas aJCas)	Checks in a JCas to the pool.