edu.illinois.cs.cogcomp.nlp.corpusreaders

Class AnnotationReader<T>

java.lang.Object

edu.illinois.cs.cogcomp.nlp.corpusreaders.AnnotationReader<T>

All Implemented Interfaces:

IResetableIterator<T>, Iterable<T>, Iterator<T>

Direct Known Subclasses:

AbstractIncrementalCorpusReader, ACEReader, ColumnFormatReader, CoNLLColumnFormatReader, CoNLLNerReader, OntonotesNamedEntityReader, OntonotesReader, OntonotesTreebankReader, PennTreebankReader

public abstract class AnnotationReader<T>
extends Object
implements Iterable<T>, IResetableIterator<T>

A fairly generic iterator that generates some kind of Annotation objects from some input source.

Author:

Vivek Srikumar, mssammon

Field Summary

Fields

Modifier and Type	Field and Description
protected String	corpusName
protected int	currentAnnotationId
protected ResourceManager	resourceManager

Constructor Summary

Constructors

Constructor and Description
AnnotationReader(ResourceManager rm) ResourceManager must provide a value for CorpusReaderConfigurator.CORPUS_NAME, plus whatever is required by derived class for its initializeReader() and reset() methods.

Method Summary

Modifier and Type	Method and Description
abstract String	generateReport() generate a human-readable report of annotations read from the source file (plus whatever other relevant statistics the user should know about).
abstract boolean	hasNext() is there another annotation object to return?
protected abstract void	initializeReader() called by constructor to perform subclass-specific initialization.
Iterator<T>	iterator()
abstract T	next() return the next annotation object.
void	remove()
void	reset() override this to conform to whatever the derived class's state mechanism requires.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

corpusName

protected final String corpusName

resourceManager

protected final ResourceManager resourceManager

currentAnnotationId

protected int currentAnnotationId

Constructor Detail

AnnotationReader

public AnnotationReader(ResourceManager rm)

ResourceManager must provide a value for CorpusReaderConfigurator.CORPUS_NAME, plus whatever is required by derived class for its initializeReader() and reset() methods.

Parameters:

rm - ResourceManager with constructor arguments.

Method Detail

initializeReader

protected abstract void initializeReader()

called by constructor to perform subclass-specific initialization.

reset

public void reset()

override this to conform to whatever the derived class's state mechanism requires.

Specified by:

reset in interface IResetableIterator<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

hasNext

public abstract boolean hasNext()

is there another annotation object to return?

Specified by:

hasNext in interface Iterator<T>

Returns:

'true' if there is at least one more annotation, 'false' otherwise

next

public abstract T next()

return the next annotation object. Don't forget to increment currentAnnotationId.

Specified by:

next in interface Iterator<T>

Returns:

an annotation object.

remove

public void remove()

Specified by:

remove in interface Iterator<T>

Throws:

{@link - UnsupportedOperationException} to let user know nothing happens.

generateReport

public abstract String generateReport()

generate a human-readable report of annotations read from the source file (plus whatever other relevant statistics the user should know about).