edu.illinois.cs.cogcomp.nlp.corpusreaders

Class CoNLLNerReader

java.lang.Object

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

edu.illinois.cs.cogcomp.nlp.corpusreaders.CoNLLNerReader

All Implemented Interfaces:

IResetableIterator<TextAnnotation>, Iterable<TextAnnotation>, Iterator<TextAnnotation>

public class CoNLLNerReader
extends AnnotationReader<TextAnnotation>

This reads column format CoNLL data for NER (from CoNLL 2002/2003 shared tasks). This only reads labels and words -- doesn't read POS tags, even if present. Created by mayhew2 on 7/20/16.

Field Summary

Fields inherited from class edu.illinois.cs.cogcomp.nlp.corpusreaders.AnnotationReader

corpusName, currentAnnotationId, resourceManager

Constructor Summary

Constructors

Constructor and Description
CoNLLNerReader(String conlldirectory) This expects a directory that contains conll format files.

Method Summary

Modifier and Type	Method and Description
static String	conllline(String tag, int num, String word) Convenience function to avoid having to think about this format all the time...
String	generateReport() TODO: generate a human-readable report of annotations read from the source file (plus whatever other relevant statistics the user should know about).
boolean	hasNext() is there another annotation object to return?
protected void	initializeReader() called by constructor to perform subclass-specific initialization.
static TextAnnotation	loadCoNLLfile(String filename) This loads filename into a textannotation.
TextAnnotation	next() return the next annotation object.
static void	TaToConll(List<TextAnnotation> tas, String outpath) Converts a list of annotated TextAnnotation into CoNLL format.

Methods inherited from class edu.illinois.cs.cogcomp.nlp.corpusreaders.AnnotationReader

iterator, remove, reset

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

Constructor Detail

CoNLLNerReader

public CoNLLNerReader(String conlldirectory)

This expects a directory that contains conll format files.

Parameters:

conlldirectory -

Method Detail

conllline

public static String conllline(String tag,
                               int num,
                               String word)

Convenience function to avoid having to think about this format all the time...

Parameters:

tag -

num -

word -

Returns:

TaToConll

public static void TaToConll(List<TextAnnotation> tas,
                             String outpath)
                      throws IOException

Converts a list of annotated TextAnnotation into CoNLL format. Must have NER_CONLL view. This writes each TextAnnotation to it's own file, using the sentence view as a guide for sentences. This will requires that each TextAnnotation have a non-null ID, which will be the name of the conll file for that TextAnnotation.

Parameters:

tas -

outpath -

Throws:

IOException

loadCoNLLfile

public static TextAnnotation loadCoNLLfile(String filename)
                                    throws FileNotFoundException

This loads filename into a textannotation.

Parameters:

filename -

Returns:

Throws:

FileNotFoundException

initializeReader

protected void initializeReader()

Description copied from class: AnnotationReader

called by constructor to perform subclass-specific initialization.

Specified by:

initializeReader in class AnnotationReader<TextAnnotation>

hasNext

public boolean hasNext()

Description copied from class: AnnotationReader

is there another annotation object to return?

Specified by:

hasNext in interface Iterator<TextAnnotation>

Specified by:

hasNext in class AnnotationReader<TextAnnotation>

Returns:

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

next

public TextAnnotation next()

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

Specified by:

next in interface Iterator<TextAnnotation>

Specified by:

next in class AnnotationReader<TextAnnotation>

Returns:

an annotation object.

generateReport

public String generateReport()

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

Specified by:

generateReport in class AnnotationReader<TextAnnotation>