banner.types

Class Mention

java.lang.Object

banner.types.Mention

All Implemented Interfaces:

Comparable<Mention>

public class Mention
extends Object
implements Comparable<Mention>

Instances of this class represent the mention of an entity within a Sentence. Mentions are defined in terms of full tokens, and therefore finding mentions (the job of a Tagger) requires tokenization first.

Author:

Bob

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Mention.MentionType

Constructor Summary

Constructors

Constructor and Description
Mention(Sentence sentence, int start, int end, EntityType entityType, Mention.MentionType mentionType)
Mention(Sentence sentence, int start, int end, EntityType entityType, Mention.MentionType mentionType, Double probability)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Mention mention2)
boolean	contains(int tokenIndex)
Mention	copy(Sentence sentence2)
boolean	equals(Object obj)
int	getEnd()
int	getEndChar()
int	getEndChar(boolean ignoreWhitespace)
EntityType	getEntityType()
Mention.MentionType	getMentionType()
Double	getProbability()
Sentence	getSentence()
int	getStart()
int	getStartChar()
int	getStartChar(boolean ignoreWhitespace)
String	getText()
List<Token>	getTokens()
int	hashCode()
int	length()
boolean	overlaps(Mention mention2) Determines whether this Mention overlaps the specified Mention
void	setProbability(Double probability)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Mention

public Mention(Sentence sentence,
               int start,
               int end,
               EntityType entityType,
               Mention.MentionType mentionType)

Mention

public Mention(Sentence sentence,
               int start,
               int end,
               EntityType entityType,
               Mention.MentionType mentionType,
               Double probability)

Method Detail

getEntityType

public EntityType getEntityType()

Returns:

A EntityType indicating the type of entity being mentioned

getMentionType

public Mention.MentionType getMentionType()

getSentence

public Sentence getSentence()

Returns:

The Sentence containing this Mention

getTokens

public List<Token> getTokens()

Returns:

The Tokens which comprise this Mention

length

public int length()

Returns:

The number of tokens this Mention contains

getText

public String getText()

Returns:

The original text of this Mention

contains

public boolean contains(int tokenIndex)

getEnd

public int getEnd()

Returns:

The index of the last token in this Mention

getStart

public int getStart()

Returns:

The index of the first token in this Mention

getStartChar

public int getStartChar()

getEndChar

public int getEndChar()

getStartChar

public int getStartChar(boolean ignoreWhitespace)

getEndChar

public int getEndChar(boolean ignoreWhitespace)

overlaps

public boolean overlaps(Mention mention2)

Determines whether this Mention overlaps the specified Mention

Parameters:

mention2 -

Returns:

true if this Mention overlaps with the specified Mention, false otherwise

getProbability

public Double getProbability()

setProbability

public void setProbability(Double probability)

copy

public Mention copy(Sentence sentence2)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(Mention mention2)

Specified by:

compareTo in interface Comparable<Mention>