edu.illinois.cs.cogcomp.nlp.corpusreaders.ontonotes

Class OntonotesNamedEntityReader

java.lang.Object

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

edu.illinois.cs.cogcomp.nlp.corpusreaders.ontonotes.OntonotesNamedEntityReader

All Implemented Interfaces:

IResetableIterator<XmlTextAnnotation>, Iterable<XmlTextAnnotation>, Iterator<XmlTextAnnotation>

public class OntonotesNamedEntityReader
extends AnnotationReader<XmlTextAnnotation>

This class will traverse a directory hierarchy searching for any file with a certain file extension. The file is expected to be a penn treebank parse file in text format. It will go any number of levels deep. The iteration produces a TextAnnotation for each file.

Author:

redman

Field Summary

Fields

Modifier and Type	Field and Description
protected String	currentfile the current file ready to be read.
protected int	fileindex the index of the current file we are looking at.
protected ArrayList<File>	filelist the list of files, compiled during initialization, used to iterate over the parse trees.
protected String	homeDirectory the home directory to traverse.

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

corpusName, currentAnnotationId, resourceManager

Constructor Summary

Constructors

Constructor and Description
OntonotesNamedEntityReader(String nerHome, String language) Reads the specified sections from penn treebank

Method Summary

Modifier and Type	Method and Description
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() we assume all files found are correct, hence if we have another file, we will produce another text annotation.
protected void	initializeReader() called by constructor to perform subclass-specific initialization.
static void	main(String[] args) This class will read the ontonotes data from the provided directory, and write the resulting NER view data to the specified output directory in CoNLL column format.
XmlTextAnnotation	next() return the next annotation object.

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

Field Detail

homeDirectory

protected final String homeDirectory

the home directory to traverse.

filelist

protected ArrayList<File> filelist

the list of files, compiled during initialization, used to iterate over the parse trees.

fileindex

protected int fileindex

the index of the current file we are looking at.

currentfile

protected String currentfile

the current file ready to be read.

Constructor Detail

OntonotesNamedEntityReader

public OntonotesNamedEntityReader(String nerHome,
                                  String language)
                           throws IllegalArgumentException,
                                  IOException

Reads the specified sections from penn treebank

Parameters:

nerHome - The directory that points to the merged (mrg) files of the WSJ portion

language - the language

annotationFileExtension - the name of the annotation file

Throws:

IOException

IllegalArgumentException

Method Detail

hasNext

public boolean hasNext()

we assume all files found are correct, hence if we have another file, we will produce another text annotation.

Specified by:

hasNext in interface Iterator<XmlTextAnnotation>

Specified by:

hasNext in class AnnotationReader<XmlTextAnnotation>

Returns:

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

next

public XmlTextAnnotation next()

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

Specified by:

next in interface Iterator<XmlTextAnnotation>

Specified by:

next in class AnnotationReader<XmlTextAnnotation>

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<XmlTextAnnotation>

initializeReader

protected void initializeReader()

Description copied from class: AnnotationReader

called by constructor to perform subclass-specific initialization.

Specified by:

initializeReader in class AnnotationReader<XmlTextAnnotation>

main

public static void main(String[] args)
                 throws IOException

This class will read the ontonotes data from the provided directory, and write the resulting NER view data to the specified output directory in CoNLL column format. It will retain the directory structure of the original data.

Parameters:

args - command lines args specify input data directory, language and output directory.

Throws:

IOException