edu.illinois.cs.cogcomp.nlp.corpusreaders

Class ACEReader

java.lang.Object

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

edu.illinois.cs.cogcomp.nlp.corpusreaders.ACEReader

All Implemented Interfaces:

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

public class ACEReader
extends AnnotationReader<TextAnnotation>

Corpus reader for the ACE data-set. This reader currently only supports only the ACE-2004 and ACE-2005 data-sets.

Author:

Bhargav Mangipudi

Field Summary

Fields

Modifier and Type	Field and Description
static String	EntityClassAttribute
static String	EntityHeadEndCharOffset
static String	EntityHeadStartCharOffset
static String	EntityIDAttribute
static String	EntityMentionIDAttribute
static String	EntityMentionLDCTypeAttribute
static String	EntityMentionTypeAttribute
static String	EntitySubtypeAttribute
static String	EntityTypeAttribute
static String	RelationIDAttribute
static String	RelationMentionIDAttribute
static String	RelationMentionLexicalConditionAttribute
static String	RelationModalityAttribute
static String	RelationSubtypeAttribute
static String	RelationTenseAttribute
static String	RelationTypeAttribute

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

corpusName, currentAnnotationId, resourceManager

Constructor Summary

Constructors

Constructor and Description
ACEReader(String aceCorpusHome, boolean is2004mode) Constructor for the ACE Data-set Reader
ACEReader(String aceCorpusHome, String[] sections, boolean is2004mode) Constructor for the ACE Data-set Reader

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() Returns true if the iteration has more elements.
protected void	initializeReader() called by constructor to perform subclass-specific initialization.
boolean	Is2004Mode()
TextAnnotation	next() return the next annotation object.
void	reset() override this to conform to whatever the derived class's state mechanism requires.

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

iterator, remove

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

EntityIDAttribute

public static final String EntityIDAttribute

See Also:

Constant Field Values

EntityTypeAttribute

public static final String EntityTypeAttribute

See Also:

Constant Field Values

EntitySubtypeAttribute

public static final String EntitySubtypeAttribute

See Also:

Constant Field Values

EntityClassAttribute

public static final String EntityClassAttribute

See Also:

Constant Field Values

EntityMentionIDAttribute

public static final String EntityMentionIDAttribute

See Also:

Constant Field Values

EntityMentionTypeAttribute

public static final String EntityMentionTypeAttribute

See Also:

Constant Field Values

EntityMentionLDCTypeAttribute

public static final String EntityMentionLDCTypeAttribute

See Also:

Constant Field Values

EntityHeadStartCharOffset

public static final String EntityHeadStartCharOffset

See Also:

Constant Field Values

EntityHeadEndCharOffset

public static final String EntityHeadEndCharOffset

See Also:

Constant Field Values

RelationIDAttribute

public static final String RelationIDAttribute

See Also:

Constant Field Values

RelationTypeAttribute

public static final String RelationTypeAttribute

See Also:

Constant Field Values

RelationSubtypeAttribute

public static final String RelationSubtypeAttribute

See Also:

Constant Field Values

RelationModalityAttribute

public static final String RelationModalityAttribute

See Also:

Constant Field Values

RelationTenseAttribute

public static final String RelationTenseAttribute

See Also:

Constant Field Values

RelationMentionIDAttribute

public static final String RelationMentionIDAttribute

See Also:

Constant Field Values

RelationMentionLexicalConditionAttribute

public static final String RelationMentionLexicalConditionAttribute

See Also:

Constant Field Values

Constructor Detail

ACEReader

public ACEReader(String aceCorpusHome,
                 String[] sections,
                 boolean is2004mode)
          throws Exception

Constructor for the ACE Data-set Reader

Parameters:

aceCorpusHome - Path of the data. eg. `data/ace2004/data/English`

sections - List of sections to parse. eg. `new String[] { "nw", "bn" }` Pass `null` to parse all available sections.

is2004mode - Boolean representing if the data-set is the ACE-2004.

Throws:

Exception - Exception thrown in-case of major failure.

ACEReader

public ACEReader(String aceCorpusHome,
                 boolean is2004mode)
          throws Exception

Constructor for the ACE Data-set Reader

Parameters:

aceCorpusHome - Path of the data. eg. `data/ace2004/data/English`

is2004mode - Boolean representing if the data-set is the ACE-2004.

Throws:

Exception - Exception thrown in-case of major failure.

Method Detail

Is2004Mode

public boolean Is2004Mode()

Returns:

Boolean representing if the reader is in 2004 mode.

initializeReader

protected void initializeReader()

Description copied from class: AnnotationReader

called by constructor to perform subclass-specific initialization.

Specified by:

initializeReader in class AnnotationReader<TextAnnotation>

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.

reset

public void reset()

Description copied from class: AnnotationReader

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

Specified by:

reset in interface IResetableIterator<TextAnnotation>

Overrides:

reset in class AnnotationReader<TextAnnotation>

hasNext

public boolean hasNext()

Returns true if the iteration has more elements. (In other words, returns true if next() would return an element rather than throwing an exception.)

Specified by:

hasNext in interface Iterator<TextAnnotation>

Specified by:

hasNext in class AnnotationReader<TextAnnotation>

Returns:

true if the iteration has more elements

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>