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
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 final 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
Class<JCas>	JCasAnnotator_ImplBase.getRequiredCasInterface()
final 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 overridden by subclasses.
void	JCasProcessor.process(JCas aJCas)	Accepts the processor.

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 view for this CAS view
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().
default JCas	FeatureStructure.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.getJCas()
JCas	CASImpl.getJCas(SofaFS aSofa)
JCas	CASImpl.getJCas(SofaID aSofaID)	Deprecated.

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

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

Uses of JCas in org.apache.uima.examples

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

Modifier	Constructor	Description
	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

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
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, 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(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(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
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

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

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

Modifier and Type	Method	Description
static BooleanArray	BooleanArray.create(JCas jcas, boolean[] a)
static ByteArray	ByteArray.create(JCas jcas, byte[] a)
static DoubleArray	DoubleArray.create(JCas jcas, double[] a)
static FloatArray	FloatArray.create(JCas jcas, float[] a)
static FloatList	FloatList.create(JCas jcas, Float[] a)	Create an FloatList from an existing array of Feature Structures
static <U extends FeatureStructure> FSArray<U>	FSArray.create(JCas jcas, FeatureStructure[] a)	Convenience - create a FSArray from an existing FeatureStructure[]
static <E extends TOP, F extends FeatureStructure> FSArrayList<E>	FSArrayList.create(JCas jcas, F[] a)	Convenience - create a FSArrayList from an existing Array.
static <U extends TOP, E extends FeatureStructure> FSList<U>	FSList.create(JCas jcas, E[] a)	Create an FSList from an existing array of Feature Structures
static IntegerArray	IntegerArray.create(JCas jcas, int[] a)
static IntegerArrayList	IntegerArrayList.create(JCas jcas, int[] a)	Convenience - create a IntegerArrayList from an existing array.
static IntegerList	IntegerList.create(JCas jcas, int[] a)	Create an IntegerList from an existing array of ints
static LongArray	LongArray.create(JCas jcas, long[] a)
static ShortArray	ShortArray.create(JCas jcas, short[] a)
static StringArray	StringArray.create(JCas jcas, String[] a)
static StringList	StringList.create(JCas jcas, String[] a)	Create an StringList from an existing array of Strings

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

Modifier	Constructor	Description
	AnnotationBase(JCas jcas)
protected	AnnotationBase(JCas jcas, int aId)	Used to create temporary marker annotations.
	AnnotationBase_Type(JCas jcas, Type casType)	Deprecated.
	BooleanArray(JCas jcas, int length)	Make a new BooleanArray of given size
	ByteArray(JCas jcas, int length)	Make a new ByteArray of given size
	DoubleArray(JCas jcas, int length)	Make a new DoubleArray of given size
	EmptyFloatList(JCas jcas)
	EmptyFSList(JCas jcas)
	EmptyIntegerList(JCas jcas)
	EmptyStringList(JCas jcas)
	FloatArray(JCas jcas, int length)	Make a new FloatArray of given size
	FloatList(JCas jcas)
	FSArray(Class<? extends TOP> clazz, JCas jcas, int length)	Constructs an instance of a subtype of FSArray having the component type clazz Note: the array with this component type must already be specified in the type system declaration as a feature whose range is FSArray with the specified elementType.
	FSArray(JCas jcas, int length)	Make a new FSArray of given size
	FSArrayList(JCas jcas)
	FSArrayList(JCas jcas, int length)	Make a new ArrayList with an initial size .
	FSHashSet(HashSet<T> set, JCas jcas)
	FSHashSet(HashSet<T> set, JCas jcas, int length)
	FSHashSet(JCas jcas)
	FSHashSet(JCas jcas, int length)	Make a new HashSet with an initial size .
	FSLinkedHashSet(JCas jcas)
	FSLinkedHashSet(JCas jcas, int length)	Make a new FSLinkedHashSet with an initial size .
	FSList(JCas jcas)
	Int2FS(JCas jcas)
	Int2FS(JCas jcas, int length)	Make a new Int2FS map with an initial capacity.
	IntegerArray(JCas jcas, int length)	Make a new IntegerArray of given size
	IntegerArrayList(JCas jcas)
	IntegerArrayList(JCas jcas, int length)	Make a new ArrayList with an initial size
	IntegerList(JCas jcas)
	LongArray(JCas jcas, int length)	Make a new LongArray of given size
	NonEmptyFloatList(JCas jcas)
	NonEmptyFloatList(JCas jcas, float v)	Generate a NonEmpty node with the specified head with the empty node as the tail
	NonEmptyFloatList(JCas jcas, float v, FloatList tail)	Generate a NonEmpty node with the specified head and tail
	NonEmptyFSList(JCas jcas)
	NonEmptyFSList(JCas jcas, T head)	Generate a NonEmpty node with the specified head with the empty node as the tail
	NonEmptyFSList(JCas jcas, T head, FSList<?> tail)	Generate a NonEmpty node with the specified head and tail
	NonEmptyIntegerList(JCas jcas)
	NonEmptyIntegerList(JCas jcas, int v)	Generate a NonEmpty node with the specified head with the empty node as the tail
	NonEmptyIntegerList(JCas jcas, int v, IntegerList tail)	Generate a NonEmpty node with the specified head and tail
	NonEmptyStringList(JCas jcas)
	NonEmptyStringList(JCas jcas, String head)	Generate a NonEmpty node with the specified head with the empty node as the tail
	NonEmptyStringList(JCas jcas, String head, StringList tail)	Generate a NonEmpty node with the specified head and tail
	ShortArray(JCas jcas, int length)	Make a new ShortArray of given size
	StringArray(JCas jcas, int length)	Make a new StringArray of given size
	StringList(JCas jcas)
	TOP(JCas jcas)	This version is used by user code new XXX(jcas)
	TOP_Type(JCas jcas, Type casType)	Deprecated.
protected	TOP_Type(JCas jcas, Type casType, boolean installGenerator)	Deprecated.

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(String sofaID)
JCas	JCasImpl.getJCas(Sofa sofa)
JCas	JCasImpl.getView(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
Iterator<JCas>	JCasImpl.getViewIterator()
Iterator<JCas>	JCasImpl.getViewIterator(String localViewNamePrefix)

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

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

Modifier and Type	Method	Description
static Annotation	Annotation._createMarkerAnnotation(JCas aJCas, int aBegin, int aEnd)	For internal use by SelectFSs_impl

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

Modifier	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)	Deprecated.
	DocumentAnnotation(JCas jcas)

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 Vector<JCas>	JCasPool.getAllInstances()
protected 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.