edu.stanford.nlp.dcoref

Class Document

java.lang.Object

edu.stanford.nlp.dcoref.Document

All Implemented Interfaces:

Serializable

public class Document
extends Object
implements Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Document.DocType

Field Summary

Fields

Modifier and Type	Field and Description
protected TwoDimensionalMap<Integer,Integer,Boolean>	acronymCache
Map<Integer,Mention>	allGoldMentions
Map<Mention,IntTuple>	allPositions
Map<Integer,Mention>	allPredictedMentions All mentions in a document mentionID -> mention
Annotation	annotation Document annotation
CoNLL2011DocumentReader.Document	conllDoc for conll shared task 2011
Map<Integer,CorefCluster>	corefClusters Clusters for coreferent mentions
Document.DocType	docType The type of document: conversational or article
Map<Integer,CorefCluster>	goldCorefClusters Gold Clusters for coreferent mentions
List<List<Mention>>	goldOrderedMentionsBySentence The list of gold mentions
int	maxUtter
Map<IntTuple,Mention>	mentionheadPositions
int	numParagraph
int	numSentences
Map<Mention,IntTuple>	positions Position of each mention in the input matrix Each mention occurrence with sentence # and position within sentence (Nth mention, not Nth token)
List<List<Mention>>	predictedOrderedMentionsBySentence The list of predicted mentions
Set<Mention>	roleSet Set of roles (in role apposition) in a document
Set<Pair<Integer,Integer>>	speakerPairs Pair of mention id, and the mention's speaker id
Map<Integer,String>	speakers UtteranceAnnotation -> String (speaker): mention ID or speaker string

Constructor Summary

Constructors

Constructor and Description
Document()
Document(Annotation anno, List<List<Mention>> predictedMentions, List<List<Mention>> goldMentions, Dictionaries dict)

Method Summary

Modifier and Type	Method and Description
void	addIncompatible(Mention m1, Mention m2)
protected void	assignOriginalID() When there is no mentionID information (without gold annotation), assign mention IDs
void	extractGoldCorefClusters() Extract gold coref cluster information.
protected void	extractGoldLinks() Extract gold coref link information
protected void	findTwinMentions(boolean strict) Mark twin mentions in gold and predicted mentions
protected List<Pair<IntTuple,IntTuple>>	getGoldLinks()
List<List<Mention>>	getOrderedMentions() return the list of predicted mentions
SpeakerInfo	getSpeakerInfo(String speaker)
protected void	initialize() Document initialize
boolean	isIncompatible(CorefCluster c1, CorefCluster c2)
boolean	isIncompatible(Mention m1, Mention m2)
static boolean	isSpeaker(Mention m, Mention ant, Dictionaries dict) Check one mention is the speaker of the other mention
void	mergeAcronymCache(CorefCluster to, CorefCluster from)
void	mergeIncompatibles(CorefCluster to, CorefCluster from)
int	numberOfSpeakers()
protected void	printMentionDetection()
protected void	processDiscourse(Dictionaries dict) Process discourse information

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

docType

public Document.DocType docType

The type of document: conversational or article

annotation

public Annotation annotation

Document annotation

conllDoc

public CoNLL2011DocumentReader.Document conllDoc

for conll shared task 2011

goldOrderedMentionsBySentence

public List<List<Mention>> goldOrderedMentionsBySentence

The list of gold mentions

predictedOrderedMentionsBySentence

public List<List<Mention>> predictedOrderedMentionsBySentence

The list of predicted mentions

corefClusters

public Map<Integer,CorefCluster> corefClusters

Clusters for coreferent mentions

goldCorefClusters

public Map<Integer,CorefCluster> goldCorefClusters

Gold Clusters for coreferent mentions

allPredictedMentions

public Map<Integer,Mention> allPredictedMentions

All mentions in a document mentionID -> mention

allGoldMentions

public Map<Integer,Mention> allGoldMentions

roleSet

public Set<Mention> roleSet

Set of roles (in role apposition) in a document

positions

public Map<Mention,IntTuple> positions

Position of each mention in the input matrix Each mention occurrence with sentence # and position within sentence (Nth mention, not Nth token)

allPositions

public Map<Mention,IntTuple> allPositions

mentionheadPositions

public final Map<IntTuple,Mention> mentionheadPositions

speakers

public Map<Integer,String> speakers

UtteranceAnnotation -> String (speaker): mention ID or speaker string

speakerPairs

public Set<Pair<Integer,Integer>> speakerPairs

Pair of mention id, and the mention's speaker id

maxUtter

public int maxUtter

numParagraph

public int numParagraph

numSentences

public int numSentences

acronymCache

protected TwoDimensionalMap<Integer,Integer,Boolean> acronymCache

Constructor Detail

Document

public Document()

Document

public Document(Annotation anno,
                List<List<Mention>> predictedMentions,
                List<List<Mention>> goldMentions,
                Dictionaries dict)

Method Detail

getOrderedMentions

public List<List<Mention>> getOrderedMentions()

return the list of predicted mentions

processDiscourse

protected void processDiscourse(Dictionaries dict)

Process discourse information

initialize

protected void initialize()

Document initialize

isIncompatible

public boolean isIncompatible(CorefCluster c1,
                              CorefCluster c2)

mergeIncompatibles

public void mergeIncompatibles(CorefCluster to,
                               CorefCluster from)

mergeAcronymCache

public void mergeAcronymCache(CorefCluster to,
                              CorefCluster from)

isIncompatible

public boolean isIncompatible(Mention m1,
                              Mention m2)

addIncompatible

public void addIncompatible(Mention m1,
                            Mention m2)

findTwinMentions

protected void findTwinMentions(boolean strict)

Mark twin mentions in gold and predicted mentions

assignOriginalID

protected void assignOriginalID()

When there is no mentionID information (without gold annotation), assign mention IDs

extractGoldCorefClusters

public void extractGoldCorefClusters()

Extract gold coref cluster information.

getGoldLinks

protected List<Pair<IntTuple,IntTuple>> getGoldLinks()

extractGoldLinks

protected void extractGoldLinks()

Extract gold coref link information

getSpeakerInfo

public SpeakerInfo getSpeakerInfo(String speaker)

numberOfSpeakers

public int numberOfSpeakers()

isSpeaker

public static boolean isSpeaker(Mention m,
                                Mention ant,
                                Dictionaries dict)

Check one mention is the speaker of the other mention

printMentionDetection

protected void printMentionDetection()