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

Packages that use JCas

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.cas	Common Analysis System (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.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

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

Class<JCas>	JCasAnnotator_ImplBase.getRequiredCasInterface()
Class<JCas>	JCasMultiplier_ImplBase.getRequiredCasInterface()

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

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

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

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

void	JTextAnnotator.process(JCas aJCas, ResultSpecification aResultSpec) Deprecated. Invokes this annotator's analysis logic.

Uses of JCas in org.apache.uima.cas

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

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.examples

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

SourceDocumentInformation_Type(JCas jcas, Type casType)
initialize variables to correspond with Cas Type and Features

SourceDocumentInformation(JCas jcas)

SourceDocumentInformation(JCas jcas, int begin, int end)

Uses of JCas in org.apache.uima.flow

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

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

Class<JCas>

JCasFlowController_ImplBase.getRequiredCasInterface()

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

abstract Flow	JCasFlowController_ImplBase.computeFlow(JCas aJCas) This method must be overriden by subclasses.
protected Flow	JCasFlow_ImplBase.newCasProduced(JCas 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	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

JCas	JCas.createView(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(SofaFS aSofa) Get the view for a Sofa (subject of analysis).
JCas	JCas.getView(String localViewName) Get the view for a Sofa (subject of analysis).

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

Iterator<JCas>	JCas.getViewIterator() Get iterator over all views in this JCas.
Iterator<JCas>	JCas.getViewIterator(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

JCas	TOP_Type.jcas reference to the Java Cas root

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

void	TOP.addToIndexes(JCas jcas)
void	TOP.removeFromIndexes(JCas jcas)

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

AnnotationBase_Type(JCas jcas, Type casType)

AnnotationBase(JCas jcas)

BooleanArray_Type(JCas jcas, Type casType)

BooleanArray(JCas jcas, int length)
Make a new BooleanArray of given size

ByteArray_Type(JCas jcas, Type casType)

ByteArray(JCas jcas, int length)
Make a new ByteArray of given size

CommonArray_Type(JCas jcas, Type casType)

DoubleArray_Type(JCas jcas, Type casType)

DoubleArray(JCas jcas, int length)
Make a new DoubleArray of given size

EmptyFloatList_Type(JCas jcas, Type casType)

EmptyFloatList(JCas jcas)

EmptyFSList_Type(JCas jcas, Type casType)

EmptyFSList(JCas jcas)

EmptyIntegerList_Type(JCas jcas, Type casType)

EmptyIntegerList(JCas jcas)

EmptyStringList_Type(JCas jcas, Type casType)

EmptyStringList(JCas jcas)

FloatArray_Type(JCas jcas, Type casType)

FloatArray(JCas jcas, int length)
Make a new FloatArray of given size

FloatList_Type(JCas jcas, Type casType)

FloatList(JCas jcas)

FSArray_Type(JCas jcas, Type casType)

FSArray(JCas jcas, int length)
Make a new FSArray of given size

FSList_Type(JCas jcas, Type casType)

FSList(JCas jcas)

IntegerArray_Type(JCas jcas, Type casType)

IntegerArray(JCas jcas, int length)
Make a new IntegerArray of given size

IntegerList_Type(JCas jcas, Type casType)

IntegerList(JCas jcas)

LongArray_Type(JCas jcas, Type casType)

LongArray(JCas jcas, int length)
Make a new LongArray of given size

NonEmptyFloatList_Type(JCas jcas, Type casType)

NonEmptyFloatList(JCas jcas)

NonEmptyFSList_Type(JCas jcas, Type casType)

NonEmptyFSList(JCas jcas)

NonEmptyIntegerList_Type(JCas jcas, Type casType)

NonEmptyIntegerList(JCas jcas)

NonEmptyStringList_Type(JCas jcas, Type casType)

NonEmptyStringList(JCas jcas)

ShortArray_Type(JCas jcas, Type casType)

ShortArray(JCas jcas, int length)
Make a new ShortArray of given size

Sofa_Type(JCas jcas, Type casType)
initialize variables to correspond with Cas Type and Features

Sofa(JCas jcas, SofaID ID, String mimeType)
Deprecated. As of v2.0, use JCasImpl.createView(String) to create a view, which will also create the Sofa for that view.

StringArray_Type(JCas jcas, Type casType)

StringArray(JCas jcas, int length)
Make a new StringArray of given size

StringList_Type(JCas jcas, Type casType)

StringList(JCas jcas)

TOP_Type(JCas jcas, Type casType)
Internal - this constructor is called when new CAS creates corresponding jcas instance.

TOP_Type(JCas jcas, Type casType, boolean installGenerator)
DO NOT USE - for backwards compatibility only.

TOP(JCas jcas)
(Internal) create a new instance of TOP (or subclass of TOP) in Java and Cas, and make them correspond.

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

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

Annotation_Type(JCas jcas, Type casType)

Annotation(JCas jcas)

Annotation(JCas jcas, int begin, int end)
Constructor with begin and end passed as arguments

DocumentAnnotation_Type(JCas jcas, Type casType)

DocumentAnnotation(JCas jcas)

Uses of JCas in org.apache.uima.util

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

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

protected Vector<JCas>	JCasPool.getAllInstances()
protected Vector<JCas>	JCasPool.getFreeInstances()

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

void	JCasPool.releaseJCas(JCas aJCas) Checks in a JCas to the pool.