edu.illinois.cs.cogcomp.nlp.corpusreaders.ereReader

Class EREEventReader

java.lang.Object

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

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

edu.illinois.cs.cogcomp.nlp.corpusreaders.XmlDocumentReader

edu.illinois.cs.cogcomp.nlp.corpusreaders.ereReader.EREDocumentReader

edu.illinois.cs.cogcomp.nlp.corpusreaders.ereReader.ERENerReader

edu.illinois.cs.cogcomp.nlp.corpusreaders.ereReader.EREMentionRelationReader

edu.illinois.cs.cogcomp.nlp.corpusreaders.ereReader.EREEventReader

All Implemented Interfaces:

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

public class EREEventReader
extends EREMentionRelationReader

Read Event annotations from ERE corpus.

Author:

mssammon

Nested Class Summary

Nested classes/interfaces inherited from class edu.illinois.cs.cogcomp.nlp.corpusreaders.ereReader.EREDocumentReader

EREDocumentReader.EreCorpus

Field Summary

Fields inherited from class edu.illinois.cs.cogcomp.nlp.corpusreaders.ereReader.ERENerReader

ends, IS_FOUND, starts

Fields inherited from class edu.illinois.cs.cogcomp.nlp.corpusreaders.ereReader.EREDocumentReader

ARG_ONE, ARG_TWO, AUTHOR, CORPUS_TYPE, DATELINE, DATETIME, deletableSpanTags, DOC, ENTITIES, ENTITY, ENTITY_ID, ENTITY_MENTION, ENTITY_MENTION_ID, EntityHeadEndCharOffset, EntityHeadStartCharOffset, EntityIdAttribute, EntityKbIdAttribute, EntityMentionIdAttribute, EntityMentionTypeAttribute, EntitySpecificityAttribute, EVENT_ARGUMENT, EVENT_MENTION, EventIdAttribute, EventMentionIdAttribute, FILL, FILLER, FILLER_ID, FILLERS, HEADLINE, HOPPER, HOPPERS, ID, IMG, KBID, LENGTH, MENTION_HEAD, MENTION_TEXT, NAM, NAME_END, NAME_START, NOM, NOUN_TYPE, OFFSET, ORIG_AUTHOR, ORIGIN, POST, PRO, QUOTE, REALIS, RELATION, RELATION_MENTION, RelationIdAttribute, RelationMentionIdAttribute, RelationRealisAttribute, RELATIONS, RelationSourceRoleAttribute, RelationSubtypeAttribute, RelationTargetRoleAttribute, RelationTypeAttribute, ROLE, SARCASM, SNIP, SOURCE, SPECIFICITY, SQUISH, STUFF, SUBTYPE, tagsToIgnore, tagsWithAtts, TRIGGER, TYPE, UNKNOWN_KBID, UNSPECIFIED, WAYS

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

fileId

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

fileList, sourceDirectory

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

corpusName, currentAnnotationId, resourceManager

Constructor Summary

Constructors

Constructor and Description
EREEventReader(EREDocumentReader.EreCorpus ereCorpus, String corpusRoot, boolean throwExceptionOnXmlParseFailure) Read mention-relation annotations -- including coreference -- from ERE English corpus.
EREEventReader(EREDocumentReader.EreCorpus ereCorpus, TextAnnotationBuilder taBldr, String corpusRoot, boolean throwExceptionOnXmlParseFailure) constructor to allow arbitrary language/tokenization behavior via explicit TextAnnotationBuilder

Method Summary

Modifier and Type	Method and Description
String	generateReport() Reports number of relations and relation mentions read from source and generated.
List<XmlTextAnnotation>	getAnnotationsFromFile(List<Path> corpusFileListEntry) given an entry from the corpus file list generated by EREDocumentReader.getFileListing() , parse its contents and get zero or more TextAnnotation objects.
static String	getEventViewName()
void	reset() set the reader to start from the beginning of the corpus.

Methods inherited from class edu.illinois.cs.cogcomp.nlp.corpusreaders.ereReader.EREMentionRelationReader

getMentionViewName, readRelation

Methods inherited from class edu.illinois.cs.cogcomp.nlp.corpusreaders.ereReader.ERENerReader

compileOffsets, findEndIndex, findEndIndexIgnoreError, findStartIndex, findStartIndexIgnoreError, getCorefViewName, getEntitiesFromFile, getFillersFromFile, getMentionConstituent, getTokenOffsets, readEntity

Methods inherited from class edu.illinois.cs.cogcomp.nlp.corpusreaders.ereReader.EREDocumentReader

buildEreConfig, buildEreXmlTextAnnotationMaker, buildXmlTextAnnotationMaker, buildXmlTextAnnotationMaker, getFileListing, getPostViewName

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

getRequiredAnnotationFileExtension, getRequiredSourceFileExtension, initializeReader

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

getSourceDirectory, hasNext, next

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

Constructor Detail

EREEventReader

public EREEventReader(EREDocumentReader.EreCorpus ereCorpus,
                      String corpusRoot,
                      boolean throwExceptionOnXmlParseFailure)
               throws Exception

Read mention-relation annotations -- including coreference -- from ERE English corpus.

Parameters:

ereCorpus - the ERE corpus release (values from EreCorpus

corpusRoot - the data root directory for the ERE corpus to be processed

throwExceptionOnXmlParseFailure - if 'true', throws exception if xml parser encounters e.g. mismatched open/close tags @throws Exception

Throws:

Exception

EREEventReader

public EREEventReader(EREDocumentReader.EreCorpus ereCorpus,
                      TextAnnotationBuilder taBldr,
                      String corpusRoot,
                      boolean throwExceptionOnXmlParseFailure)
               throws Exception

constructor to allow arbitrary language/tokenization behavior via explicit TextAnnotationBuilder

Parameters:

ereCorpus - the ERE corpus release (values from EreCorpus -- specifies source/markup directories, source xml tag behavior

taBldr - a TextAnnotationBuilder for the desired language/tokenization behavior.

corpusRoot - the data root directory for the ERE corpus to be processed

throwExceptionOnXmlParseFailure - if 'true', throws exception if xml parser encounters e.g. mismatched open/close tags @throws Exception

Throws:

Exception - if source/annotation file missing, or if xml not valid

Method Detail

getEventViewName

public static String getEventViewName()

reset

public void reset()

Description copied from class: XmlDocumentReader

set the reader to start from the beginning of the corpus.

Specified by:

reset in interface IResetableIterator<XmlTextAnnotation>

Overrides:

reset in class EREMentionRelationReader

getAnnotationsFromFile

public List<XmlTextAnnotation> getAnnotationsFromFile(List<Path> corpusFileListEntry)
                                               throws Exception

Description copied from class: EREDocumentReader

given an entry from the corpus file list generated by EREDocumentReader.getFileListing() , parse its contents and get zero or more TextAnnotation objects. This allows for the case where corpus annotations are provided in standoff format in one or more files separate from the source document. In such cases, the first file in the list should contain the source document and the rest should be the corresponding markup files. In this default implementation, it is assumed that a single file contains both source and markup.

Overrides:

getAnnotationsFromFile in class EREMentionRelationReader

Parameters:

corpusFileListEntry - a list of files, the first of which is a source file.

Returns:

List of TextAnnotation objects extracted from the corpus file.

Throws:

Exception

generateReport

public String generateReport()

Description copied from class: EREMentionRelationReader

Reports number of relations and relation mentions read from source and generated. Note that number read and number generated may disagree because an argument was not read correctly (see {#ERENerReader.generateReport()})

Overrides:

generateReport in class EREMentionRelationReader

Returns:

a String representing a human-readable report on information read from corpus and generated as data structures.