edu.illinois.cs.cogcomp.nlp.corpusreaders

Class PennTreebankReader

java.lang.Object

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

edu.illinois.cs.cogcomp.nlp.corpusreaders.PennTreebankReader

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractSRLAnnotationReader, TreebankChunkReader, VerbSensePropbankReader

public class PennTreebankReader
extends AnnotationReader<TextAnnotation>

Author:

Vivek Srikumar

Field Summary

Fields

Modifier and Type	Field and Description
protected String	combinedWSJHome
protected int	currentSectionId
static String	PENN_TREEBANK_WSJ
protected String[]	sections

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

corpusName, currentAnnotationId, resourceManager

Constructor Summary

Constructors

Constructor and Description
PennTreebankReader(String treebankHome) Reads all the sections of the combined annotation from penn treebank
PennTreebankReader(String treebankHome, String parseViewName) Reads all the sections of the combined annotation from penn treebank
PennTreebankReader(String treebankHome, String[] sections) Reads the specified sections from penn treebank
PennTreebankReader(String treebankHome, String[] sections, String parseViewName, String sourceFileExtension, String annotationFileExtension) 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() is there another annotation object to return?
protected void	initializeReader() called by constructor to perform subclass-specific initialization.
TextAnnotation	next() return the next annotation object.
void	remove()

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

iterator, 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

PENN_TREEBANK_WSJ

public static final String PENN_TREEBANK_WSJ

See Also:

Constant Field Values

sections

protected final String[] sections

combinedWSJHome

protected final String combinedWSJHome

currentSectionId

protected int currentSectionId

Constructor Detail

PennTreebankReader

public PennTreebankReader(String treebankHome)
                   throws Exception

Reads all the sections of the combined annotation from penn treebank

Parameters:

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

Throws:

Exception

PennTreebankReader

public PennTreebankReader(String treebankHome,
                          String parseViewName)
                   throws Exception

Reads all the sections of the combined annotation from penn treebank

Parameters:

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

parseViewName - The name of the parse view which is to be added

Throws:

Exception

PennTreebankReader

public PennTreebankReader(String treebankHome,
                          String[] sections)
                   throws Exception

Reads the specified sections from penn treebank

Parameters:

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

Throws:

Exception

PennTreebankReader

public PennTreebankReader(String treebankHome,
                          String[] sections,
                          String parseViewName,
                          String sourceFileExtension,
                          String annotationFileExtension)
                   throws Exception

Reads the specified sections from penn treebank

Parameters:

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

Throws:

Exception

Method Detail

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.

remove

public void remove()

Specified by:

remove in interface Iterator<TextAnnotation>

Overrides:

remove in class AnnotationReader<TextAnnotation>

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>