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

Class TextAnnotation

java.lang.Object

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

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

All Implemented Interfaces:

HasAttributes, Serializable, Cloneable

public class TextAnnotation
extends AbstractTextAnnotation
implements Serializable, Cloneable, HasAttributes

This class contains all annotation for a single piece of text (which could contain more than one sentence.)

Author:

Vivek Srikumar

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected gnu.trove.map.TIntObjectMap<ArrayList<IntPair>>	allSpans
protected Map<String,String>	attributes Mop containing attributes/metadata information related to TextAnnotation.
protected int[]	characterOffsetsToTokens A map from character offset to the token id.
protected String	corpusId An identifier for the corpus
protected String	id The identifier for this text annotation
protected List<Sentence>	sentences The list of sentences contained in this text

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

text, tokenCharacterOffsets, tokenizedText, tokens, views

Constructor Summary

Constructors

Constructor and Description
TextAnnotation(String corpusId, String id, String text, IntPair[] characterOffsets, String[] tokens, int[] sentenceEndPositions)

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String key, String value)
void	addView(Annotator annotator) Adds a view that is generated by a Annotator
Object	clone()
boolean	equals(Object obj)
String	getAttribute(String key)
Set<String>	getAttributeKeys()
String	getCorpusId()
String	getId()
int	getNumberOfSentences()
Sentence	getSentence(int sentenceId)
Sentence	getSentenceFromToken(int tokenId) Gets the sentence containing the specified token
List<Sentence>	getSentenceFromTokens(Set<Integer> tokens)
int	getSentenceId(Constituent constituent)
int	getSentenceId(int tokenId) Gets the index of the sentence that contains the token, indexed by tokenPosition.
List<IntPair>	getSpansMatching(String text)
int	getTokenIdFromCharacterOffset(int characterOffset) Get the position of token that corresponds to the character offset that is passed as a parameter.
boolean	hasAttribute(String key)
int	hashCode()
void	removeAllAttributes()
List<Sentence>	sentences()
void	setSentences() allows user to force sentences field to be (re-)populated based on Sentence View, possibly after modifying sentence View.
String	toString()

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

addTopKView, addView, addViews, getAvailableViews, getText, getToken, getTokenCharacterOffset, getTokenizedText, getTokens, getTokensInSpan, getTopKViews, getView, hasView, removeAllViews, removeView, select, setTokens, size

Methods inherited from class java.lang.Object

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

Field Detail

corpusId

protected String corpusId

An identifier for the corpus

id

protected String id

The identifier for this text annotation

sentences

protected List<Sentence> sentences

The list of sentences contained in this text

characterOffsetsToTokens

protected int[] characterOffsetsToTokens

A map from character offset to the token id. This will be instantiated only when the function getTokenIdFromCharacterOffset(int) is called the first time.

allSpans

protected gnu.trove.map.TIntObjectMap<ArrayList<IntPair>> allSpans

attributes

protected Map<String,String> attributes

Mop containing attributes/metadata information related to TextAnnotation.

Constructor Detail

TextAnnotation

public TextAnnotation(String corpusId,
                      String id,
                      String text,
                      IntPair[] characterOffsets,
                      String[] tokens,
                      int[] sentenceEndPositions)

Method Detail

addView

public void addView(Annotator annotator)
             throws AnnotatorException

Adds a view that is generated by a Annotator

Throws:

AnnotatorException

getCorpusId

public String getCorpusId()

getId

public String getId()

getNumberOfSentences

public int getNumberOfSentences()

getSentence

public Sentence getSentence(int sentenceId)

getSentenceId

public int getSentenceId(Constituent constituent)

getSentenceId

public int getSentenceId(int tokenId)

Gets the index of the sentence that contains the token, indexed by tokenPosition. If no sentence contains the token, then this function throws an IllegalArgumentException. The sentence index can further be used to get the Sentence itself by calling getSentence(int) .

Parameters:

tokenId - The index of the token whose sentenceId is needed

Returns:

The index of the sentence that contains this token

Throws:

IllegalArgumentException - if no sentence contains the tokenId

getSentenceFromToken

public Sentence getSentenceFromToken(int tokenId)

Gets the sentence containing the specified token

getSentenceFromTokens

public List<Sentence> getSentenceFromTokens(Set<Integer> tokens)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

sentences

public List<Sentence> sentences()

setSentences

public void setSentences()

allows user to force sentences field to be (re-)populated based on Sentence View, possibly after modifying sentence View. WARNING: if you

getTokenIdFromCharacterOffset

public int getTokenIdFromCharacterOffset(int characterOffset)

Get the position of token that corresponds to the character offset that is passed as a parameter. This function could be useful when dealing with corpora that specify annotation in terms of character offsets. In particular, the CuratorClient uses this function to convert views from the Curator representation. NOTE: one-past-the-end indexing can make this problematic. Currently, constituents are processed so that only characters within tokens are mapped to token ids (avoiding ambiguity at the cost of introducing complexity for users thinking of one-past-the-end indexing). I.E. you MUST modify the end offset in the call if you are using one-past-the-end offsets. (example: curator data structures use one-past-the- end, as do TextAnnotation Views/Constituents. This behavior was chosen to handle the case where there is arbitrary whitespace, and to avoid confusion when two tokens are contiguous (the first character of the second token would conflict with the last (one-past-the-end) character of the first. UPDATED to allow non-zero first token character offset (i.e. in case where source text has markup preamble that you want to ignore. Current implementation maps char offsets not representing tokens to the index '-1'.

toString

public String toString()

Overrides:

toString in class Object

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getSpansMatching

public List<IntPair> getSpansMatching(String text)

addAttribute

public void addAttribute(String key,
                         String value)

Specified by:

addAttribute in interface HasAttributes

getAttribute

public String getAttribute(String key)

Specified by:

getAttribute in interface HasAttributes

getAttributeKeys

public Set<String> getAttributeKeys()

Specified by:

getAttributeKeys in interface HasAttributes

hasAttribute

public boolean hasAttribute(String key)

Specified by:

hasAttribute in interface HasAttributes

removeAllAttributes

public void removeAllAttributes()

Specified by:

removeAllAttributes in interface HasAttributes