edu.illinois.cs.cogcomp.core.datastructures.textannotation

Class Sentence

java.lang.Object

edu.illinois.cs.cogcomp.core.datastructures.textannotation.AbstractTextAnnotation

edu.illinois.cs.cogcomp.core.datastructures.textannotation.Sentence

All Implemented Interfaces:

Serializable

public class Sentence
extends AbstractTextAnnotation
implements Serializable

Sentence class is a read-only projection of a TextAnnotation with all views restricted to a single sentence. For making changes to any views, you will have to edit the source TextAnnotation instance that was used to create the Sentence instance.

Author:

Vivek Srikumar

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static ITransformer<View,Double>	defaultViewScoreSplitter
protected Constituent	sentenceConstituent
protected TextAnnotation	textAnnotation

Fields inherited from class edu.illinois.cs.cogcomp.core.datastructures.textannotation.AbstractTextAnnotation

text, tokenCharacterOffsets, tokenizedText, tokens, views

Constructor Summary

Constructors

Constructor and Description
Sentence(Constituent sentenceConstituent) Create a sentence out of a sentenceConstituent.

Method Summary

Modifier and Type	Method and Description
void	addTopKView(String viewName, List<View> view) Overrides for forbidden methods.
void	addView(String viewName, View view) Adds the top scoring value for the view identified by viewName.
void	addViews(String[] viewNames, View[] views)
boolean	equals(Object obj)
int	getEndSpan()
Constituent	getSentenceConstituent()
int	getSentenceId()
int	getStartSpan()
String	getText() Gets the raw text
String	getToken(int position) Get the token at position from this text
String	getTokenizedText() Gets the tokenized text.
String[]	getTokens() Gets the tokens in this text.
List<View>	getTopKViews(String viewName) Get all the values available for a given view, identified by viewName
View	getView(String viewName) Gets the highest scoring value for the view identified by viewName.
int	hashCode()
boolean	hasView(String viewName) Checks if this text annotation has a view identified by viewName
void	removeAllViews()
void	removeView(String viewName) Remove a given view
void	setTokens(String[] tokens, IntPair[] tokenCharacterOffsets) Set the tokens for this text.
int	size() Get the number of tokens in this text.
String	toString()

Methods inherited from class edu.illinois.cs.cogcomp.core.datastructures.textannotation.AbstractTextAnnotation

getAvailableViews, getTokenCharacterOffset, getTokensInSpan, select

Methods inherited from class java.lang.Object

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

Field Detail

textAnnotation

protected TextAnnotation textAnnotation

sentenceConstituent

protected Constituent sentenceConstituent

defaultViewScoreSplitter

protected static final ITransformer<View,Double> defaultViewScoreSplitter

Constructor Detail

Sentence

public Sentence(Constituent sentenceConstituent)

Create a sentence out of a sentenceConstituent.

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getEndSpan

public int getEndSpan()

getView

public View getView(String viewName)

Description copied from class: AbstractTextAnnotation

Gets the highest scoring value for the view identified by viewName.

Overrides:

getView in class AbstractTextAnnotation

hasView

public boolean hasView(String viewName)

Description copied from class: AbstractTextAnnotation

Checks if this text annotation has a view identified by viewName

Overrides:

hasView in class AbstractTextAnnotation

Returns:

true if the text annotation contains a view called viewName and false otherwise

getSentenceConstituent

public Constituent getSentenceConstituent()

getStartSpan

public int getStartSpan()

getTopKViews

public List<View> getTopKViews(String viewName)

Description copied from class: AbstractTextAnnotation

Get all the values available for a given view, identified by viewName

Overrides:

getTopKViews in class AbstractTextAnnotation

getTokens

public String[] getTokens()

Description copied from class: AbstractTextAnnotation

Gets the tokens in this text.

Overrides:

getTokens in class AbstractTextAnnotation

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

size

public int size()

Description copied from class: AbstractTextAnnotation

Get the number of tokens in this text.

Overrides:

size in class AbstractTextAnnotation

Returns:

the number of tokens

getText

public String getText()

Description copied from class: AbstractTextAnnotation

Gets the raw text

Overrides:

getText in class AbstractTextAnnotation

Returns:

The raw text

getTokenizedText

public String getTokenizedText()

Description copied from class: AbstractTextAnnotation

Gets the tokenized text.

Overrides:

getTokenizedText in class AbstractTextAnnotation

Returns:

The tokenized text, as a string where each token is separated by a space.

getToken

public String getToken(int position)

Description copied from class: AbstractTextAnnotation

Get the token at position from this text

Overrides:

getToken in class AbstractTextAnnotation

getSentenceId

public int getSentenceId()

addTopKView

@AvoidUsing(reason="Sentence class is read-only. Edit the source TextAnnotation instance directly.")
public void addTopKView(String viewName,
                                                                                                                             List<View> view)

Overrides for forbidden methods.

Overrides:

addTopKView in class AbstractTextAnnotation

Parameters:

viewName - The name of the new view to be added.

view - The top K views

addViews

@AvoidUsing(reason="Sentence class is read-only. Edit the source TextAnnotation instance directly.")
public void addViews(String[] viewNames,
                                                                                                                          View[] views)

Overrides:

addViews in class AbstractTextAnnotation

addView

@AvoidUsing(reason="Sentence class is read-only. Edit the source TextAnnotation instance directly.")
public void addView(String viewName,
                                                                                                                         View view)

Description copied from class: AbstractTextAnnotation

Adds the top scoring value for the view identified by viewName.

Overrides:

addView in class AbstractTextAnnotation

removeView

@AvoidUsing(reason="Sentence class is read-only. Edit the source TextAnnotation instance directly.")
public void removeView(String viewName)

Description copied from class: AbstractTextAnnotation

Remove a given view

Overrides:

removeView in class AbstractTextAnnotation

removeAllViews

@AvoidUsing(reason="Sentence class is read-only. Edit the source TextAnnotation instance directly.")
public void removeAllViews()

Overrides:

removeAllViews in class AbstractTextAnnotation

setTokens

@AvoidUsing(reason="Sentence class is read-only. Edit the source TextAnnotation instance directly.")
public void setTokens(String[] tokens,
                                                                                                                           IntPair[] tokenCharacterOffsets)

Description copied from class: AbstractTextAnnotation

Set the tokens for this text.

NOTE: This function should not be called by any method that is not a Tokenizer and will throw an exception if tokens are set more than once. So do not call this function unless you know what you are doing.

Overrides:

setTokens in class AbstractTextAnnotation

Parameters:

tokens - An array of tokens

tokenCharacterOffsets - An array, whose length is the same as tokens. Each element indicates the character offset of this token in the raw text.