de.julielab.jcore.utility

Class JCoReAnnotationIndexMerger

java.lang.Object

de.julielab.jcore.utility.JCoReAnnotationIndexMerger

public class JCoReAnnotationIndexMerger
extends Object

This class takes multiple UIMA indices, e.g. Token, EntityMention and Part of Speech, and merges them into a single iterator that then outputs the respective annotations as a sequence. The most useful functionality is the capability of the annotation merger to sort the annotations efficiently on the fly by start offsets. Thus, when given a range of UIMA annotation indices, the annotation merger is able to intertwine the annotations in correct reading order.

Constructor Summary

Constructors

Constructor and Description
JCoReAnnotationIndexMerger(Set<?> annotationTypes, boolean sort, org.apache.uima.cas.text.AnnotationFS coveringAnnotation, org.apache.uima.jcas.JCas aJCas) Constructs a new annotation index merger.

Method Summary

Modifier and Type	Method and Description
boolean	firstToken()
org.apache.uima.jcas.cas.TOP	getAnnotation()
int	getCurrentBegin()
int	getCurrentEnd()
boolean	hasBeginOffsetChanged()
boolean	incrementAnnotation()
protected boolean	moveIterator(boolean initialize)
protected void	setCurrentAnnotation()
void	setCurrentBegin(int currentBegin)
void	setCurrentEnd(int currentEnd)

Methods inherited from class java.lang.Object

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

Constructor Detail

JCoReAnnotationIndexMerger

public JCoReAnnotationIndexMerger(Set<?> annotationTypes,
                                  boolean sort,
                                  org.apache.uima.cas.text.AnnotationFS coveringAnnotation,
                                  org.apache.uima.jcas.JCas aJCas)
                           throws ClassNotFoundException

Constructs a new annotation index merger.

Parameters:

annotationTypes - The CAS integer constant of the types, the qualified Java class names of the types or the Type object of the types to merge the annotation indexes.

sort - If set to true, the annotations will be returned sorted ascendingly by begin offset.

coveringAnnotation - May be null. If given, the returned annotations will be restricted to those covered by the given annotation.

aJCas - The CAS containing the annotations.

Throws:

ClassNotFoundException

Method Detail

firstToken

public boolean firstToken()

getAnnotation

public org.apache.uima.jcas.cas.TOP getAnnotation()

getCurrentBegin

public int getCurrentBegin()

getCurrentEnd

public int getCurrentEnd()

hasBeginOffsetChanged

public boolean hasBeginOffsetChanged()

incrementAnnotation

public boolean incrementAnnotation()

moveIterator

protected boolean moveIterator(boolean initialize)

setCurrentAnnotation

protected void setCurrentAnnotation()

setCurrentBegin

public void setCurrentBegin(int currentBegin)

setCurrentEnd

public void setCurrentEnd(int currentEnd)