| 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. | 
| Modifier and Type | Method and Description | 
|---|---|
| protected JCas | JCasMultiplier_ImplBase. getEmptyJCas()Gets an empty JCas that this CAS Multiplier can then populate. | 
| Modifier and Type | Method and Description | 
|---|---|
| Class<JCas> | JCasAnnotator_ImplBase. getRequiredCasInterface() | 
| Class<JCas> | JCasMultiplier_ImplBase. getRequiredCasInterface() | 
| Modifier and Type | Method and 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. | 
| Modifier and Type | Method and Description | 
|---|---|
| JCas | AnalysisEngine. newJCas()Similar to  AnalysisEngine.newCAS()but wraps the new CAS objects with the Java-object-basedJCasinterface. | 
| JCas | JCasIterator. next()Gets the next JCAS from the iterator. | 
| Modifier and Type | Method and Description | 
|---|---|
| ProcessTrace | AnalysisEngine. process(JCas aJCas)Similar to  AnalysisEngine.process(CAS)but uses the Java-object-basedJCasinterface instead
 of the generalCASinterface. | 
| ProcessTrace | AnalysisEngine. process(JCas aJCas,
       ResultSpecification aResultSpec)Similar to  AnalysisEngine.process(CAS,ResultSpecification)but uses the Java-object-basedJCasinterface instead of the generalCASinterface. | 
| void | AnalysisEngine. process(JCas aJCas,
       ResultSpecification aResultSpec,
       ProcessTrace aTrace)Similar to  AnalysisEngine.process(CAS, ResultSpecification, ProcessTrace)but uses the
 Java-object-basedJCasinterface instead of the generalCASinterface. | 
| JCasIterator | AnalysisEngine. processAndOutputNewCASes(JCas aJCAS)Processes a JCAS, possibly producing multiple JCASes as a result. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | JTextAnnotator. process(JCas aJCas,
       ResultSpecification aResultSpec)Deprecated.  Invokes this annotator's analysis logic. | 
| Modifier and Type | Method and Description | 
|---|---|
| JCas | AnalysisEngineImplBase. newJCas() | 
| JCas | JCasIteratorWrapper. next() | 
| Modifier and Type | Method and Description | 
|---|---|
| ProcessTrace | MultiprocessingAnalysisEngine_impl. process(JCas aJCas) | 
| ProcessTrace | AnalysisEngineImplBase. process(JCas aJCas) | 
| ProcessTrace | MultiprocessingAnalysisEngine_impl. process(JCas aJCas,
       ResultSpecification aResultSpec) | 
| ProcessTrace | AnalysisEngineImplBase. process(JCas aJCas,
       ResultSpecification aResultSpec) | 
| void | MultiprocessingAnalysisEngine_impl. process(JCas aJCas,
       ResultSpecification aResultSpec,
       ProcessTrace aTrace) | 
| void | AnalysisEngineImplBase. process(JCas aJCas,
       ResultSpecification aResultSpec,
       ProcessTrace aTrace) | 
| JCasIterator | MultiprocessingAnalysisEngine_impl. processAndOutputNewCASes(JCas aJCas) | 
| JCasIterator | AnalysisEngineImplBase. processAndOutputNewCASes(JCas aJCas)Default implementation of processAndOutputNewCASes(JCas) method. | 
| Modifier and Type | Method and Description | 
|---|---|
| JCas | CAS. getJCas()Get the JCas view for this CAS view | 
| default JCas | FeatureStructure. getJCas() | 
| 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 byCAS.getJCas(). | 
| Modifier and Type | Method and Description | 
|---|---|
| JCas | CASImpl. getJCas() | 
| JCas | CASImpl. getJCas(SofaFS aSofa) | 
| JCas | CASImpl. getJCas(SofaID aSofaID)Deprecated.  | 
| Modifier and Type | Method and 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. | 
| Constructor and Description | 
|---|
| SourceDocumentInformation(JCas jcas) | 
| SourceDocumentInformation(JCas jcas,
                         int begin,
                         int end) | 
| Modifier and Type | Method and Description | 
|---|---|
| protected JCas | JCasFlow_ImplBase. getJCas()Gets the JCas being routed by this Flow object. | 
| Modifier and Type | Method and Description | 
|---|---|
| Class<JCas> | JCasFlowController_ImplBase. getRequiredCasInterface() | 
| Modifier and Type | Method and 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 | 
| Modifier and Type | Method and 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(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). | 
| Modifier and Type | Method and 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. | 
| Modifier and Type | Field and Description | 
|---|---|
| JCas | TOP_Type. jcasDeprecated.  reference to the Java Cas root | 
| Modifier and Type | Method and 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 <U extends TOP,E extends FeatureStructure> | FSList. create(JCas jcas,
      E[] a)Create an FSList from an existing array of Feature Structures | 
| static <E extends TOP,F extends FeatureStructure> | FSArrayList. create(JCas jcas,
      F[] a)Convenience - create a FSArrayList from an existing Array. | 
| static <U extends FeatureStructure> | FSArray. create(JCas jcas,
      FeatureStructure[] a)Convenience - create a FSArray from an existing FeatureStructure[] | 
| 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 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 StringList | StringList. create(JCas jcas,
      String[] a)Create an StringList from an existing array of Strings | 
| static StringArray | StringArray. create(JCas jcas,
      String[] a) | 
| Constructor and Description | 
|---|
| AnnotationBase_Type(JCas jcas,
                   Type casType)Deprecated.  | 
| AnnotationBase(JCas jcas) | 
| 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_Type(JCas jcas,
        Type casType)Deprecated.  | 
| TOP_Type(JCas jcas,
        Type casType,
        boolean installGenerator)Deprecated.  | 
| TOP(JCas jcas)This version is used by user code new XXX(jcas) | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | JCasImplimplements the supporting infrastructure for JCas model linked with a Cas. | 
| Modifier and Type | Method and Description | 
|---|---|
| JCas | JCasImpl. createView(String sofaID) | 
| JCas | JCasImpl. getJCas(Sofa sofa) | 
| JCas | JCasImpl. getView(SofaFS aSofa) | 
| JCas | JCasImpl. getView(String localViewName) | 
| Modifier and Type | Method and Description | 
|---|---|
| Iterator<JCas> | JCasImpl. getViewIterator() | 
| Iterator<JCas> | JCasImpl. getViewIterator(String localViewNamePrefix) | 
| Constructor and Description | 
|---|
| Annotation_Type(JCas jcas,
               Type casType)Deprecated.  | 
| Annotation(JCas jcas) | 
| Annotation(JCas jcas,
          int begin,
          int end)Constructor with begin and end passed as arguments | 
| DocumentAnnotation(JCas jcas) | 
| Modifier and Type | Method and Description | 
|---|---|
| JCas | JCasPool. getJCas()Checks out a JCas from the pool. | 
| JCas | JCasPool. getJCas(long aTimeout)Checks out a JCas from the pool. | 
| Modifier and Type | Method and Description | 
|---|---|
| protected Vector<JCas> | JCasPool. getAllInstances() | 
| protected Vector<JCas> | JCasPool. getFreeInstances() | 
| Modifier and Type | Method and Description | 
|---|---|
| void | JCasPool. releaseJCas(JCas aJCas)Checks in a JCas to the pool. | 
Copyright © 2006–2022 The Apache Software Foundation. All rights reserved.