edu.stanford.nlp.pipeline

Class SentimentAnnotator

java.lang.Object

edu.stanford.nlp.pipeline.SentenceAnnotator

edu.stanford.nlp.pipeline.SentimentAnnotator

All Implemented Interfaces:

Annotator

public class SentimentAnnotator
extends SentenceAnnotator

This annotator attaches a binarized tree with sentiment annotations to each sentence. It requires there to already be binarized trees attached to the sentence, which is best done in the ParserAnnotator. The tree will be attached to each sentence in the SentencesAnnotation via the SentimentCoreAnnotations.SentimentAnnotatedTree annotation. The class name for the top level class is also set using the SentimentCoreAnnotations.SentimentClass annotation. The reason the decision was made to do the binarization in the ParserAnnotator is because it may require specific options set in the parser. An alternative would be to do the binarization here, which would require at a minimum the HeadFinder used in the parser.

Author:

John Bauer

Nested Class Summary

Nested classes/interfaces inherited from class edu.stanford.nlp.pipeline.SentenceAnnotator

SentenceAnnotator.AnnotatorProcessor

Field Summary

Fields inherited from interface edu.stanford.nlp.pipeline.Annotator

DEFAULT_REQUIREMENTS, STANFORD_CDC_TOKENIZE, STANFORD_CLEAN_XML, STANFORD_COLUMN_DATA_CLASSIFIER, STANFORD_COREF, STANFORD_COREF_MENTION, STANFORD_DEPENDENCIES, STANFORD_DETERMINISTIC_COREF, STANFORD_DOCDATE, STANFORD_ENTITY_MENTIONS, STANFORD_GENDER, STANFORD_KBP, STANFORD_LEMMA, STANFORD_LINK, STANFORD_MWT, STANFORD_NATLOG, STANFORD_NER, STANFORD_OPENIE, STANFORD_PARSE, STANFORD_POS, STANFORD_QUOTE, STANFORD_QUOTE_ATTRIBUTION, STANFORD_REGEXNER, STANFORD_RELATION, STANFORD_SENTIMENT, STANFORD_SSPLIT, STANFORD_TOKENIZE, STANFORD_TOKENSREGEX, STANFORD_TRUECASE, STANFORD_UD_FEATURES

Constructor Summary

Constructors

Constructor and Description
SentimentAnnotator(java.lang.String annotatorName, java.util.Properties props)

Method Summary

Modifier and Type	Method and Description
void	doOneFailedSentence(Annotation annotation, CoreMap sentence) Fills in empty annotations for trees, tags, etc if the annotator failed or timed out.
protected void	doOneSentence(Annotation annotation, CoreMap sentence) annotation is included in case there is global information we care about
protected long	maxTime() The maximum time to run this annotator for, in milliseconds.
protected int	nThreads()
java.util.Set<java.lang.Class<? extends CoreAnnotation>>	requirementsSatisfied() Returns a set of requirements for which tasks this annotator can provide.
java.util.Set<java.lang.Class<? extends CoreAnnotation>>	requires() Returns the set of tasks which this annotator requires in order to perform.
static java.lang.String	signature(java.lang.String annotatorName, java.util.Properties props)

Methods inherited from class edu.stanford.nlp.pipeline.SentenceAnnotator

annotate

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.stanford.nlp.pipeline.Annotator

exactRequirements, unmount

Constructor Detail

SentimentAnnotator

public SentimentAnnotator(java.lang.String annotatorName,
                          java.util.Properties props)

Method Detail

requirementsSatisfied

public java.util.Set<java.lang.Class<? extends CoreAnnotation>> requirementsSatisfied()

Description copied from interface: Annotator

Returns a set of requirements for which tasks this annotator can provide. For example, the POS annotator will return "pos".

requires

public java.util.Set<java.lang.Class<? extends CoreAnnotation>> requires()

Description copied from interface: Annotator

Returns the set of tasks which this annotator requires in order to perform. For example, the POS annotator will return "tokenize", "ssplit".

signature

public static java.lang.String signature(java.lang.String annotatorName,
                                         java.util.Properties props)

nThreads

protected int nThreads()

Specified by:

nThreads in class SentenceAnnotator

maxTime

protected long maxTime()

Description copied from class: SentenceAnnotator

The maximum time to run this annotator for, in milliseconds.

Specified by:

maxTime in class SentenceAnnotator

doOneFailedSentence

public void doOneFailedSentence(Annotation annotation,
                                CoreMap sentence)

Description copied from class: SentenceAnnotator

Fills in empty annotations for trees, tags, etc if the annotator failed or timed out. Not supposed to do major processing.

Specified by:

doOneFailedSentence in class SentenceAnnotator

Parameters:

annotation - The whole Annotation object, in case it is needed for context.

sentence - The particular sentence to process

doOneSentence

protected void doOneSentence(Annotation annotation,
                             CoreMap sentence)

Description copied from class: SentenceAnnotator

annotation is included in case there is global information we care about

Specified by:

doOneSentence in class SentenceAnnotator