com.aliasi.coref
Interface MentionChain

All Known Implementing Classes:

AbstractMentionChain, MentionChainImpl

public interface MentionChain

A MentionChain represents a set of mentions that have been resolved as coreferent in that they refer to the same underlying entity. Mention chains are created with a MentionFactory by promoting mentions to mention chains.

Since:

LingPipe1.0

Version:

3.8

Author:

Bob Carpenter

Method Summary

void	add(Mention mention, int sentenceOffset) Adds the specified mention appearing at the specified sentence offset to this mention chain.
String	entityType() Returns the entity type associated with this mention chain.
String	gender() Returns the gender for this mention chain.
Set<String>	honorifics() Honorific phrases attached to instances of this mention chain.
int	identifier() The unique identifier for this mention chain (within a document).
boolean	killed(Mention mention) Returns true if there is a killing function that defeats the match of the mention against the mention chain.
int	matchScore(Mention mention) Returns the best match score of the mention versus the mention chain according to the matching functions determined by the antecedent.
int	maxSentenceOffset() Offset of the last sentence in which a mention belonging to this mention chain appears.
Set<Mention>	mentions() Returns the set of mentions underlying this mention chain.

Method Detail

mentions

Set<Mention> mentions()

Returns the set of mentions underlying this mention chain.

Returns:

Set of mentions underlying this mention chain.

maxSentenceOffset

int maxSentenceOffset()

Offset of the last sentence in which a mention belonging to this mention chain appears.

Returns:

Offset of last sentence containing a mention in this chain.

entityType

String entityType()

Returns the entity type associated with this mention chain.

Returns:

Entity type associated with this mention chain.

add

void add(Mention mention,
         int sentenceOffset)

Adds the specified mention appearing at the specified sentence offset to this mention chain.

Parameters:

mention - Mention to add to this chain.

sentenceOffset - Offset of mention added.

identifier

int identifier()

The unique identifier for this mention chain (within a document).

killed

boolean killed(Mention mention)

Returns true if there is a killing function that defeats the match of the mention against the mention chain. A true return means that the mention will not be allowed to match against the antecedent no matter what other matching functions return.

Parameters:

mention - Mention to test against antecedent.

Returns:

true if there is a killing function that defeats the match of the mention against the mention chain.

matchScore

int matchScore(Mention mention)

Returns the best match score of the mention versus the mention chain according to the matching functions determined by the antecedent. A score of Matcher.NO_MATCH_SCORE indicates that all matching functions failed. Otherwise, the score will fall in the range 0 to Matcher.MAX_SCORE, with a lower score being better.

Parameters:

mention - Mention to score against antecedent.

Returns:

Best matching score between mention and antecedent.

gender

String gender()

Returns the gender for this mention chain.

Returns:

Gender for this mention chain.

honorifics

Set<String> honorifics()

Honorific phrases attached to instances of this mention chain.

Returns:

Set of honorifics for this mention chain.