de.unistuttgart.ims.uimautil

Class AnnotationUtil

java.lang.Object

de.unistuttgart.ims.uimautil.AnnotationUtil

public class AnnotationUtil
extends Object

This class contains static method to manipulate annotations.

Author:

reiterns

Constructor Summary

Constructors

Constructor and Description
AnnotationUtil()

Method Summary

Modifier and Type	Method and Description
static <T extends org.apache.uima.jcas.tcas.Annotation> void	trim(Collection<T> annotations) trims an entire collection of annotations.
static <T extends org.apache.uima.jcas.tcas.Annotation> T	trim(T annotation) This method first checks whether the string contains whitespace at all.
static <T extends org.apache.uima.jcas.tcas.Annotation> T	trim(T annotation, char... ws) trims the annotated text.
static <T extends org.apache.uima.jcas.tcas.Annotation> T	trimBegin(T annotation, char... ws) Moves the begin-index as long as a character contain in the array is at the beginning.
static <T extends org.apache.uima.jcas.tcas.Annotation> T	trimEnd(T annotation, char... ws) Moves the end-index as long a character that is contained in the array is at the end.
static <T extends org.apache.uima.jcas.tcas.Annotation> T	trimFront(T annotation, char... ws) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationUtil

public AnnotationUtil()

Method Detail

trim

public static <T extends org.apache.uima.jcas.tcas.Annotation> T trim(T annotation,
                                                                      char... ws)

trims the annotated text. Similar to String.trim(), this method moves the begin and end indexes towards the middle as long as there is whitespace. The method throws a ArrayIndexOutOfBoundsException if the entire annotation consists of whitespace.

Type Parameters:

T - The annotation type

Parameters:

annotation - The annotation to trim

ws - An array of chars that are to be considered whitespace

Returns:

The trimmed annotation (not a copy)

Since:

0.4.1

trim

public static <T extends org.apache.uima.jcas.tcas.Annotation> T trim(T annotation)

This method first checks whether the string contains whitespace at all. See also trim(Annotation, char...)

Type Parameters:

T - the annotation type

Parameters:

annotation - The annotation to trim

Returns:

the trimmed annotation

Since:

0.4.1

trim

public static <T extends org.apache.uima.jcas.tcas.Annotation> void trim(Collection<T> annotations)

trims an entire collection of annotations. Beware: directly trimming the result of JCasUtil.select(org.apache.uima.jcas.JCas, Class) throws a ConcurrentModificationException.

Type Parameters:

T - the annotation type

Parameters:

annotations - The annotations you want to trim

Since:

0.4.1

trimFront

@Deprecated
public static <T extends org.apache.uima.jcas.tcas.Annotation> T trimFront(T annotation,
                                                                                       char... ws)

Deprecated.

Moves the begin-index as long as a character contain in the array is at the beginning.

Type Parameters:

T - the annotation type

Parameters:

annotation - the annotation to be trimmed

ws - an array of chars to be trimmed

Returns:

the trimmed annotation

Since:

0.4.1

trimBegin

public static <T extends org.apache.uima.jcas.tcas.Annotation> T trimBegin(T annotation,
                                                                           char... ws)

Moves the begin-index as long as a character contain in the array is at the beginning.

Type Parameters:

T - the annotation type

Parameters:

annotation - the annotation to be trimmed

ws - an array of chars to be trimmed

Returns:

the trimmed annotation

Since:

0.4.2

trimEnd

public static <T extends org.apache.uima.jcas.tcas.Annotation> T trimEnd(T annotation,
                                                                         char... ws)

Moves the end-index as long a character that is contained in the array is at the end.

Parameters:

annotation - The annotation to be trimmed.

ws - An array of characters which are considered whitespace

Returns:

The trimmed annotation

Since:

0.4.2