org.apache.ctakes.core.util

Class FSUtil

java.lang.Object

org.apache.ctakes.core.util.FSUtil

public class FSUtil
extends Object

Constructor Summary

Constructors

Constructor and Description
FSUtil()

Method Summary

Modifier and Type	Method and Description
static int	countAnnotationsInSpan(org.apache.uima.jcas.JCas jcas, int type, int beginSpan, int endSpan) returns the number of annotations of specified type in the
static int	countAnnotationsInSpan(org.apache.uima.jcas.JCas jcas, int type, int beginSpan, int endSpan, int[] validNeTypes) Does not use getAnnotationsInSpan(JCas, int, int, int, int[]) so we don't create a collection unnecessarily.
static List	getAnnotationsInSpan(org.apache.uima.jcas.JCas jcas, int type, int beginSpan, int endSpan, int[] validNeTypes)
static org.apache.uima.cas.FSIterator	getAnnotationsInSpanIterator(org.apache.uima.jcas.JCas jcas, int type, int beginSpan, int endSpan) Deprecated.
static org.apache.uima.cas.FSIterator	getAnnotationsIteratorInSpan(org.apache.uima.jcas.JCas jcas, int type, int beginSpan, int endSpan) For correct behavior, requires types to be listed in TypePriorities so that the subiterator works as expected
static boolean	isAnnotationPresentInSpan(org.apache.uima.jcas.JCas jcas, int type, int beginSpan, int endSpan) returns a true if the annotation type is present in the span

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FSUtil

public FSUtil()

Method Detail

getAnnotationsInSpanIterator

@Deprecated
public static org.apache.uima.cas.FSIterator getAnnotationsInSpanIterator(org.apache.uima.jcas.JCas jcas,
                                                                                      int type,
                                                                                      int beginSpan,
                                                                                      int endSpan)

Deprecated.

getAnnotationsIteratorInSpan

public static org.apache.uima.cas.FSIterator getAnnotationsIteratorInSpan(org.apache.uima.jcas.JCas jcas,
                                                                          int type,
                                                                          int beginSpan,
                                                                          int endSpan)

For correct behavior, requires types to be listed in TypePriorities so that the subiterator works as expected

countAnnotationsInSpan

public static int countAnnotationsInSpan(org.apache.uima.jcas.JCas jcas,
                                         int type,
                                         int beginSpan,
                                         int endSpan,
                                         int[] validNeTypes)

Does not use getAnnotationsInSpan(JCas, int, int, int, int[]) so we don't create a collection unnecessarily.

getAnnotationsInSpan

public static List getAnnotationsInSpan(org.apache.uima.jcas.JCas jcas,
                                        int type,
                                        int beginSpan,
                                        int endSpan,
                                        int[] validNeTypes)

countAnnotationsInSpan

public static int countAnnotationsInSpan(org.apache.uima.jcas.JCas jcas,
                                         int type,
                                         int beginSpan,
                                         int endSpan)

returns the number of annotations of specified type in the

isAnnotationPresentInSpan

public static boolean isAnnotationPresentInSpan(org.apache.uima.jcas.JCas jcas,
                                                int type,
                                                int beginSpan,
                                                int endSpan)

returns a true if the annotation type is present in the span