banner.types

Class Sentence

java.lang.Object

banner.types.Sentence

public class Sentence
extends Object

This class represents a single sentence, and provides for the text to be tokenized and for mentions.

Author:

Bob

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Sentence.OverlapOption

Constructor Summary

Constructors

Constructor and Description
Sentence(String sentenceId, String documentId, String text) Creates a new Sentence with the specified tag and text

Method Summary

Modifier and Type	Method and Description
boolean	addMention(Mention mention) Adds a Mention to this Sentence, ignoring any potential overlap with existing Mentions.
void	addMentions(List<String> tags, double probability)
void	addToken(Token token) Adds a Token to this Sentence.
Sentence	copy(boolean includeTokens, boolean includeMentions)
int	countWhitespace(int index)
boolean	equals(Object obj)
String	getDocumentId()
EntityIdentification	getIdentification(Mention mention)
List<Mention>	getMentions()
List<Mention>	getMentions(Mention.MentionType mentionType)
List<Mention>	getMentions(Token token, Set<Mention.MentionType> mentionTypes)
String	getSentenceId()
String	getText()
String	getText(int start, int end)
int	getTokenIndex(int charIndex, boolean returnNextIfBoundary)
List<String>	getTokenLabels(TagFormat format, Set<Mention.MentionType> mentionTypes, Sentence.OverlapOption sameType, Sentence.OverlapOption differentType)
List<Token>	getTokens()
int	hashCode()
boolean	removeMention(Mention mention)
EntityIdentification	setIdentification(Mention mention, EntityIdentification identification)

Methods inherited from class java.lang.Object

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

Constructor Detail

Sentence

public Sentence(String sentenceId,
                String documentId,
                String text)

Creates a new Sentence with the specified tag and text

Parameters:

id - The id for the Sentence, which may be a unique identifier

text - The text of the sentence

Method Detail

addToken

public void addToken(Token token)

Adds a Token to this Sentence. Normally called by instances of Tokenizer.

Parameters:

token -

countWhitespace

public int countWhitespace(int index)

addMention

public boolean addMention(Mention mention)

Adds a Mention to this Sentence, ignoring any potential overlap with existing Mentions. Normally called by instance of Tagger or post-processors.

Parameters:

mention -

removeMention

public boolean removeMention(Mention mention)

addMentions

public void addMentions(List<String> tags,
                        double probability)

getSentenceId

public String getSentenceId()

Returns:

the tag for the Sentence

getDocumentId

public String getDocumentId()

getText

public String getText()

Returns:

The text of the Sentence

getTokenIndex

public int getTokenIndex(int charIndex,
                         boolean returnNextIfBoundary)

getText

public String getText(int start,
                      int end)

getTokens

public List<Token> getTokens()

Returns:

The List of Tokens for this Sentence

getMentions

public List<Mention> getMentions()

Returns:

The List of Mentions for this Sentence. This list may or may not contain overlaps

getMentions

public List<Mention> getMentions(Mention.MentionType mentionType)

getTokenLabels

public List<String> getTokenLabels(TagFormat format,
                                   Set<Mention.MentionType> mentionTypes,
                                   Sentence.OverlapOption sameType,
                                   Sentence.OverlapOption differentType)

getMentions

public List<Mention> getMentions(Token token,
                                 Set<Mention.MentionType> mentionTypes)

setIdentification

public EntityIdentification setIdentification(Mention mention,
                                              EntityIdentification identification)

getIdentification

public EntityIdentification getIdentification(Mention mention)

copy

public Sentence copy(boolean includeTokens,
                     boolean includeMentions)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object