Uses of Interface
org.apache.uima.jcas.JCas
Package
Description
The Analysis Engine interface, along with supporting interfaces and exception classes.
The Annotator Interfaces, along with supporting interfaces and exception classes.
Common Analysis System(CAS) Interfaces
Implementation and Low-Level API for the CAS Interfaces.
uimaFIT-enhanced base classes for UIMA components and some simple components.
Example for an UIMA-based experiment running an analysis and evaluating the results.
Example for a simple analysis engine and pipeline.
Examples for using the
ExternalResource
annotation.Example for using the
TypeCapability
annotation.Example for using the
ConfigurationParameter
annotation.Example for using the
ExternalResource
annotation.Factories to create different kinds of UIMA resource specifiers.
Executing UIMA pipelines.
Interfaces for accessing the JCAS.
JCAS model for built-in CAS types
Provides the classes that support the Java Cas Model (JCM).
Utility classes and interfaces used by UIMA components.
-
Uses of JCas in org.apache.uima.analysis_component
Modifier and TypeMethodDescriptionprotected final JCas
JCasMultiplier_ImplBase.getEmptyJCas()
Gets an empty JCas that this CAS Multiplier can then populate.Modifier and TypeMethodDescriptionJCasAnnotator_ImplBase.getRequiredCasInterface()
JCasMultiplier_ImplBase.getRequiredCasInterface()
Modifier and TypeMethodDescriptionabstract void
This method should be overriden by subclasses.abstract void
This method should be overridden by subclasses.void
Accepts the processor. -
Uses of JCas in org.apache.uima.analysis_engine
Modifier and TypeMethodDescriptionAnalysisEngine.newJCas()
Similar toAnalysisEngine.newCAS()
but wraps the new CAS objects with the Java-object-basedJCas
interface.JCasIterator.next()
Gets the next JCAS from the iterator.Modifier and TypeMethodDescriptionSimilar toAnalysisEngine.process(CAS)
but uses the Java-object-basedJCas
interface instead of the generalCAS
interface.AnalysisEngine.process
(JCas aJCas, ResultSpecification aResultSpec) Similar toAnalysisEngine.process(CAS,ResultSpecification)
but uses the Java-object-basedJCas
interface instead of the generalCAS
interface.void
AnalysisEngine.process
(JCas aJCas, ResultSpecification aResultSpec, ProcessTrace aTrace) Similar toAnalysisEngine.process(CAS, ResultSpecification, ProcessTrace)
but uses the Java-object-basedJCas
interface instead of the generalCAS
interface.AnalysisEngine.processAndOutputNewCASes
(JCas aJCAS) Processes a JCAS, possibly producing multiple JCASes as a result. -
Uses of JCas in org.apache.uima.analysis_engine.annotator
Modifier and TypeMethodDescriptionvoid
JTextAnnotator.process
(JCas aJCas, ResultSpecification aResultSpec) Deprecated.Invokes this annotator's analysis logic. -
Uses of JCas in org.apache.uima.analysis_engine.impl
Modifier and TypeMethodDescriptionAnalysisEngineImplBase.process
(JCas aJCas, ResultSpecification aResultSpec) void
AnalysisEngineImplBase.process
(JCas aJCas, ResultSpecification aResultSpec, ProcessTrace aTrace) MultiprocessingAnalysisEngine_impl.process
(JCas aJCas, ResultSpecification aResultSpec) void
MultiprocessingAnalysisEngine_impl.process
(JCas aJCas, ResultSpecification aResultSpec, ProcessTrace aTrace) AnalysisEngineImplBase.processAndOutputNewCASes
(JCas aJCas) Default implementation of processAndOutputNewCASes(JCas) method.MultiprocessingAnalysisEngine_impl.processAndOutputNewCASes
(JCas aJCas) -
Uses of JCas in org.apache.uima.cas
-
Uses of JCas in org.apache.uima.cas.impl
Modifier and TypeMethodDescriptionCASImpl.getJCas()
Deprecated.As of v2.0, useCASImpl.getView(String)
followed byCASImpl.getJCas()
.Modifier and TypeMethodDescriptionvoid
FeatureStructureImplC.addToIndexes
(JCas jcas) add this FS to indexes in a specific view, perhaps different from the creation viewvoid
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
-
Uses of JCas in org.apache.uima.fit.benchmark
-
Uses of JCas in org.apache.uima.fit.component
Modifier and TypeMethodDescriptionstatic JCas
ViewCreatorAnnotator.createViewSafely
(JCas aJCas, String aViewName) Provides a simple call that allows you to safely create a view if it has not been created yet.Modifier and TypeMethodDescriptionstatic JCas
ViewCreatorAnnotator.createViewSafely
(JCas aJCas, String aViewName) Provides a simple call that allows you to safely create a view if it has not been created yet.abstract void
Subclasses should implement this method rather thanJCasCollectionReader_ImplBase.getNext(CAS)
void
void
-
Uses of JCas in org.apache.uima.fit.examples.experiment.pos
-
Uses of JCas in org.apache.uima.fit.examples.getstarted
-
Uses of JCas in org.apache.uima.fit.examples.resource
-
Uses of JCas in org.apache.uima.fit.examples.tutorial.ex1
-
Uses of JCas in org.apache.uima.fit.examples.tutorial.ex2
-
Uses of JCas in org.apache.uima.fit.examples.tutorial.ex6
-
Uses of JCas in org.apache.uima.fit.examples.tutorial.type
ModifierConstructorDescriptionDateAnnotation
(JCas jcas) DateAnnotation
(JCas jcas, int begin, int end) DateTimeAnnotation
(JCas jcas) DateTimeAnnotation
(JCas jcas, int begin, int end) RoomNumber
(JCas jcas) RoomNumber
(JCas jcas, int begin, int end) TimeAnnotation
(JCas jcas) TimeAnnotation
(JCas jcas, int begin, int end) UimaAcronym
(JCas jcas) UimaAcronym
(JCas jcas, int begin, int end) UimaMeeting
(JCas jcas) UimaMeeting
(JCas jcas, int begin, int end) -
Uses of JCas in org.apache.uima.fit.examples.type
-
Uses of JCas in org.apache.uima.fit.factory
Modifier and TypeMethodDescriptionstatic JCas
JCasFactory.createJCas()
Creates a newJCas
.static JCas
JCasFactory.createJCas
(String... typeSystemDescriptorNames) Creates a new JCas from type system descriptor files found by name.static JCas
JCasFactory.createJCas
(String fileName, TypeSystemDescription typeSystemDescription) This method creates a new JCas and loads the contents of an XMI or XCAS file into it.static JCas
JCasFactory.createJCas
(TypeSystemDescription typeSystemDescription) Create a new JCas for the given type system description.static JCas
JCasFactory.createJCasFromPath
(String... typeSystemDescriptorPaths) Creates a new JCas from type system descriptor files.static JCas
JCasFactory.createText
(String aText) Creates a new JCas with the given text.static JCas
JCasFactory.createText
(String aText, String aLanguage) Creates a new JCas with the given text and language.JCasBuilder.getJCas()
Get the JCas.Modifier and TypeMethodDescriptionstatic <T extends Annotation>
TAnnotationFactory.createAnnotation
(JCas jCas, int begin, int end, Class<T> cls) Provides a convenient way to create an annotation and addToIndexes in a single line.ModifierConstructorDescriptionJCasBuilder
(JCas aJCas) Create a new JCas builder working on the specified JCas. -
Uses of JCas in org.apache.uima.fit.pipeline
Modifier and TypeMethodDescriptionstatic void
SimplePipeline.runPipeline
(JCas jCas, AnalysisEngine... engines) Run a sequence ofanalysis engines
over aJCas
.static void
SimplePipeline.runPipeline
(JCas jCas, AnalysisEngineDescription... descs) Run a sequence ofanalysis engines
over aJCas
. -
Uses of JCas in org.apache.uima.fit.testing.assertj
-
Uses of JCas in org.apache.uima.fit.testing.factory
Modifier and TypeMethodDescriptionvoid
TokenBuilder.buildTokens
(JCas aJCas, String aText) Builds white-space delimited tokens from the input text.void
TokenBuilder.buildTokens
(JCas aJCas, String aText, String aTokensString) void
TokenBuilder.buildTokens
(JCas aJCas, String aText, String aTokensString, String aPosTagsString) void
TokenBuilder.buildTokens
(JCas aJCas, String aText, String aTokensString, String aPosTagsString, String aStemsString) Build tokens for the given text, tokens, part-of-speech tags, and word stems. -
Uses of JCas in org.apache.uima.fit.testing.junit
-
Uses of JCas in org.apache.uima.fit.type
-
Uses of JCas in org.apache.uima.fit.util
Modifier and TypeMethodDescriptionstatic JCas
Convenience method to get the specified view or create a new view if the requested view does not exist.static JCas
Convenience method to get the specified view or a default view if the requested view does not exist.Modifier and TypeMethodDescriptionstatic boolean
JCasUtil.contains
(JCas jCas, AnnotationFS coveringAnnotation, Class<? extends Annotation> type) Check if the given annotation contains any annotation of the given type.static <A extends AnnotationFS,
B extends AnnotationFS>
ContainmentIndex<A, B> ContainmentIndex.create
(JCas aJcas, Class<A> aSuper, Class<B> aUnder, ContainmentIndex.Type aType) Factory method to create an index instead of using the constructor.static BooleanArray
FSCollectionFactory.createBooleanArray
(JCas aJCas, boolean... aArray) static BooleanArray
FSCollectionFactory.createBooleanArray
(JCas aJCas, Collection<Boolean> aCollection) static ByteArray
FSCollectionFactory.createByteArray
(JCas aJCas, byte... aArray) static ByteArray
FSCollectionFactory.createByteArray
(JCas aJCas, Collection<Byte> aCollection) static DoubleArray
FSCollectionFactory.createDoubleArray
(JCas aJCas, double... aArray) static DoubleArray
FSCollectionFactory.createDoubleArray
(JCas aJCas, Collection<Double> aCollection) static FloatArray
FSCollectionFactory.createFloatArray
(JCas aJCas, float... aArray) static FloatArray
FSCollectionFactory.createFloatArray
(JCas aJCas, Collection<Float> aCollection) static FloatList
FSCollectionFactory.createFloatList
(JCas aJCas, float... aValues) static FloatList
FSCollectionFactory.createFloatList
(JCas aJCas, Collection<Float> aCollection) static <T extends FeatureStructure>
FSArray<T> FSCollectionFactory.createFSArray
(JCas aJCas, Collection<T> aCollection) static <T extends FeatureStructure>
FSArray<T> FSCollectionFactory.createFSArray
(JCas aJCas, T... aArray) FSCollectionFactory.createFSList
(JCas aJCas, Collection<T> aCollection) static IntegerArray
FSCollectionFactory.createIntArray
(JCas aJCas, int... aArray) static IntegerArray
FSCollectionFactory.createIntArray
(JCas aJCas, Collection<Integer> aCollection) static IntegerList
FSCollectionFactory.createIntegerList
(JCas aJCas, int... aValues) static IntegerList
FSCollectionFactory.createIntegerList
(JCas aJCas, Collection<Integer> aCollection) static LongArray
FSCollectionFactory.createLongArray
(JCas aJCas, long... aArray) static LongArray
FSCollectionFactory.createLongArray
(JCas aJCas, Collection<Long> aCollection) static ShortArray
FSCollectionFactory.createShortArray
(JCas aJCas, short... aArray) static ShortArray
FSCollectionFactory.createShortArray
(JCas aJCas, Collection<Short> aCollection) static StringArray
FSCollectionFactory.createStringArray
(JCas aJCas, String... aArray) static StringArray
FSCollectionFactory.createStringArray
(JCas aJCas, Collection<String> aCollection) static StringList
FSCollectionFactory.createStringList
(JCas aJCas, String... aValues) static StringList
FSCollectionFactory.createStringList
(JCas aJCas, Collection<String> aCollection) static <T extends TOP>
booleanTest if a JCas contains an annotation of the given type.static Type
JCasUtil.getAnnotationType
(JCas jCas, Class<?> type) Get the CAS type for the given JCas wrapper class type making sure it inherits fromAnnotation
.static Type
Get the CAS type for the given JCas wrapper class type.static JCas
Convenience method to get the specified view or create a new view if the requested view does not exist.static JCas
Convenience method to get the specified view or a default view if the requested view does not exist.static <T extends Annotation,
S extends Annotation>
Map<T, List<S>> JCasUtil.indexCovered
(JCas jCas, Class<? extends T> type, Class<? extends S> coveredType) Create an index for quickly lookup up the annotations covered by a particular annotation.static <T extends Annotation,
S extends Annotation>
Map<T, List<S>> JCasUtil.indexCovering
(JCas jCas, Class<? extends T> type, Class<? extends S> coveringType) Create an index for quickly lookup up the annotations covering a particular annotation.Deprecated.Usejcas.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 <T extends TOP>
Collection<T> Convenience method to iterator over all features structures of a given type.static Collection
<TOP> Convenience method to iterator over all features structures.static <T extends Annotation>
List<T> Get all annotations of the given type at the specified offsets.static <T extends Annotation>
List<T> JCasUtil.selectBetween
(JCas jCas, Class<T> type, AnnotationFS ann1, AnnotationFS ann2) Get a list of annotations of the given annotation type located between two annotations.static <T extends Annotation>
TJCasUtil.selectByIndex
(JCas jCas, Class<T> cls, int index) This method exists simply as a convenience method for unit testing.static <T extends Annotation>
List<T> JCasUtil.selectCovered
(JCas jCas, Class<T> type, int begin, int end) Get a list of annotations of the given annotation type constrained by a 'covering' annotation.static <T extends Annotation>
List<T> JCasUtil.selectCovered
(JCas jCas, Class<T> type, AnnotationFS coveringAnnotation) Get a list of annotations of the given annotation type constrained by a 'covering' annotation.static <T extends Annotation>
List<T> JCasUtil.selectCovering
(JCas jCas, Class<T> type, int begin, int end) Get a list of annotations of the given annotation type constraint by a certain annotation.static <T extends Annotation>
List<T> JCasUtil.selectCovering
(JCas jCas, Class<T> type, AnnotationFS coveredAnnotation) Get a list of annotations of the given annotation type constraint by a certain annotation.static <T extends Annotation>
List<T> JCasUtil.selectFollowing
(JCas aJCas, Class<T> aType, AnnotationFS annotation, int count) Returns the n annotations following the given annotationstatic <T extends Annotation>
List<T> JCasUtil.selectOverlapping
(JCas aJCas, Class<T> aType, int aBegin, int aEnd) Get a list of annotations of the given annotation type overlapping the given span.static <T extends Annotation>
List<T> JCasUtil.selectOverlapping
(JCas aJCas, Class<T> aType, AnnotationFS aBoundaryAnnotation) Get a list of annotations of the given annotation type overlapping the given annotation.static <T extends Annotation>
List<T> JCasUtil.selectPreceding
(JCas aJCas, Class<T> aType, AnnotationFS annotation, int count) Returns the n annotations preceding the given annotationstatic <T extends TOP>
TJCasUtil.selectSingle
(JCas jCas, Class<T> type) Get the single instance of the specified type from the JCas.static <T extends Annotation>
TJCasUtil.selectSingleAt
(JCas jCas, Class<T> type, int aBegin, int aEnd) Get a single annotations of the given type at the specified offsets.static <T extends Annotation>
TJCasUtil.selectSingleRelative
(JCas aJCas, Class<T> aType, AnnotationFS aAnchor, int aPosition) Return an annotation preceding or following of a given reference annotation.static <T extends Annotation>
Iterable<T> JCasUtil.subiterate
(JCas jCas, Class<T> type, AnnotationFS container, boolean ambiguous, boolean strict) Convenience method to iterator over all annotations of a given type occurring within the scope of a provided annotation (sub-iteration).static void
Deprecated.static void
Deprecated. -
Uses of JCas in org.apache.uima.fit.validation
Modifier and TypeMethodDescriptionApply this check to the given CAS. -
Uses of JCas in org.apache.uima.flow
Modifier and TypeMethodDescriptionprotected JCas
JCasFlow_ImplBase.getJCas()
Gets the JCas being routed by this Flow object.Modifier and TypeMethodDescriptionabstract 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
Deprecated.this is done automatically by the framework with the Flow object is created -
Uses of JCas in org.apache.uima.it.pear_with_typesystem
-
Uses of JCas in org.apache.uima.it.pear_with_typesystem.type
ModifierConstructorDescriptionComplexAnnotation
(JCas jcas) ComplexAnnotation
(JCas jcas, int begin, int end) ComplexAnnotationSubtype
(JCas jcas) ComplexAnnotationSubtype
(JCas jcas, int begin, int end) SimpleAnnotation
(JCas jcas) SimpleAnnotation
(JCas jcas, int begin, int end) -
Uses of JCas in org.apache.uima.jcas
Modifier and TypeMethodDescriptionJCas.createView
(String sofaID) Create a view and its underlying Sofa (subject of analysis).Create a JCas view for a Sofa.Get the view for a Sofa (subject of analysis).Get the view for a Sofa (subject of analysis).Modifier and TypeMethodDescriptionJCas.getViewIterator()
Get iterator over all views in this JCas.JCas.getViewIterator
(String localViewNamePrefix) Get iterator over all views with the given name prefix. -
Uses of JCas in org.apache.uima.jcas.cas
Modifier and TypeFieldDescriptionfinal JCas
TOP_Type.jcas
Deprecated.reference to the Java Cas rootModifier and TypeMethodDescriptionstatic BooleanArray
static ByteArray
static DoubleArray
static FloatArray
static FloatList
Create an FloatList from an existing array of Feature Structuresstatic <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> Convenience - create a FSArrayList from an existing Array.static <U extends TOP,
E extends FeatureStructure>
FSList<U> Create an FSList from an existing array of Feature Structuresstatic IntegerArray
static IntegerArrayList
Convenience - create a IntegerArrayList from an existing array.static IntegerList
Create an IntegerList from an existing array of intsstatic LongArray
static ShortArray
static StringArray
static StringList
Create an StringList from an existing array of StringsModifierConstructorDescriptionAnnotationBase
(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 sizeMake a new ByteArray of given sizeDoubleArray
(JCas jcas, int length) Make a new DoubleArray of given sizeEmptyFloatList
(JCas jcas) EmptyFSList
(JCas jcas) EmptyIntegerList
(JCas jcas) EmptyStringList
(JCas jcas) FloatArray
(JCas jcas, int length) Make a new FloatArray of given sizeConstructs 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.Make a new FSArray of given sizeFSArrayList
(JCas jcas) FSArrayList
(JCas jcas, int length) Make a new ArrayList with an initial size .Make a new HashSet with an initial size .FSLinkedHashSet
(JCas jcas) FSLinkedHashSet
(JCas jcas, int length) Make a new FSLinkedHashSet with an initial size .Make a new Int2FS map with an initial capacity.IntegerArray
(JCas jcas, int length) Make a new IntegerArray of given sizeIntegerArrayList
(JCas jcas) IntegerArrayList
(JCas jcas, int length) Make a new ArrayList with an initial sizeIntegerList
(JCas jcas) Make a new LongArray of given sizeNonEmptyFloatList
(JCas jcas) NonEmptyFloatList
(JCas jcas, float v) Generate a NonEmpty node with the specified head with the empty node as the tailNonEmptyFloatList
(JCas jcas, float v, FloatList tail) Generate a NonEmpty node with the specified head and tailNonEmptyFSList
(JCas jcas) NonEmptyFSList
(JCas jcas, T head) Generate a NonEmpty node with the specified head with the empty node as the tailNonEmptyFSList
(JCas jcas, T head, FSList<?> tail) Generate a NonEmpty node with the specified head and tailNonEmptyIntegerList
(JCas jcas) NonEmptyIntegerList
(JCas jcas, int v) Generate a NonEmpty node with the specified head with the empty node as the tailNonEmptyIntegerList
(JCas jcas, int v, IntegerList tail) Generate a NonEmpty node with the specified head and tailNonEmptyStringList
(JCas jcas) NonEmptyStringList
(JCas jcas, String head) Generate a NonEmpty node with the specified head with the empty node as the tailNonEmptyStringList
(JCas jcas, String head, StringList tail) Generate a NonEmpty node with the specified head and tailShortArray
(JCas jcas, int length) Make a new ShortArray of given sizeStringArray
(JCas jcas, int length) Make a new StringArray of given sizeStringList
(JCas jcas) This version is used by user code new XXX(jcas)Deprecated.protected
Deprecated. -
Uses of JCas in org.apache.uima.jcas.impl
Modifier and TypeClassDescriptionclass
implements the supporting infrastructure for JCas model linked with a Cas.Modifier and TypeMethodDescriptionJCasImpl.getViewIterator()
JCasImpl.getViewIterator
(String localViewNamePrefix) -
Uses of JCas in org.apache.uima.jcas.tcas
Modifier and TypeMethodDescriptionstatic Annotation
Annotation._createMarkerAnnotation
(JCas aJCas, int aBegin, int aEnd) For internal use bySelectFSs_impl
ModifierConstructorDescriptionAnnotation
(JCas jcas) Annotation
(JCas jcas, int begin, int end) Constructor with begin and end passed as argumentsAnnotation_Type
(JCas jcas, Type casType) Deprecated.DocumentAnnotation
(JCas jcas) -
Uses of JCas in org.apache.uima.util
Modifier and TypeMethodDescriptionJCasPool.getJCas()
Checks out a JCas from the pool.JCasPool.getJCas
(long aTimeout) Checks out a JCas from the pool.Modifier and TypeMethodDescriptionvoid
JCasPool.releaseJCas
(JCas aJCas) Checks in a JCas to the pool.
CAS.getView(String)
followed byCAS.getJCas()
.