org.openimaj.text.nlp.sentiment.type

Class TFFCountSentiment

java.lang.Object

org.openimaj.text.nlp.sentiment.type.TFFCountSentiment

All Implemented Interfaces:

BipolarSentimentProvider, DiscreteCountBipolarSentimentProvider, Sentiment, WeightedBipolarSentimentProvider

public class TFFCountSentiment
extends Object
implements Sentiment, BipolarSentimentProvider, WeightedBipolarSentimentProvider, DiscreteCountBipolarSentimentProvider

A Discrete count sentiment is one which a set of arbitrary sentiments are given a count in a given phrase . The sentiments hold values for counts of words considered to be one of the N sentiments provided and the total number of words the sentiment was decided against is also provided. An assumption is made that a single term can only have a single sentiment, therefore sum(sentiment_count) < total though perhaps not equal as some terms may be none of the N sentiments (stop words etc.)

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
TFFCountSentiment() all weights set to 0
TFFCountSentiment(int total)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,?>	asMap()
BipolarSentiment	bipolar()
BipolarSentiment	bipolar(double deltaThresh)
static BipolarSentiment	bipolar(TFF.Clue clue)
DiscreteCountBipolarSentiment	countBipolarSentiment()
boolean	equals(Object obj)
void	fromMap(Map<String,?> map)
void	incrementClue(TFF.Clue entry, int increment)
WeightedBipolarSentiment	weightedBipolar()

Methods inherited from class java.lang.Object

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

Constructor Detail

TFFCountSentiment

public TFFCountSentiment()

all weights set to 0

TFFCountSentiment

public TFFCountSentiment(int total)

Parameters:

total - instnatiate with a total number of words

Method Detail

incrementClue

public void incrementClue(TFF.Clue entry,
                 int increment)

Parameters:

entry -

increment -

bipolar

public BipolarSentiment bipolar()

Specified by:

bipolar in interface BipolarSentimentProvider

Returns:

a collapsed version of the sentiment that is either positive, negaitve or neutral

bipolar

public BipolarSentiment bipolar(double deltaThresh)

Specified by:

bipolar in interface BipolarSentimentProvider

Parameters:

deltaThresh - A a proportional threshold

Returns:

a collapsed version of the sentiment that is either positive, negaitve or neutral

weightedBipolar

public WeightedBipolarSentiment weightedBipolar()

Specified by:

weightedBipolar in interface WeightedBipolarSentimentProvider

Returns:

a collapsed version of the sentiment that is positive, negaitve or neutral all to some degree

countBipolarSentiment

public DiscreteCountBipolarSentiment countBipolarSentiment()

Specified by:

countBipolarSentiment in interface DiscreteCountBipolarSentimentProvider

Returns:

a new DiscreteCountBipolarSentiment instance based on the sentiments held

asMap

public Map<String,?> asMap()

Specified by:

asMap in interface Sentiment

Returns:

return a map representing this sentiment, may be more than just the held sentiments, but extra data

fromMap

public void fromMap(Map<String,?> map)
             throws UnrecognisedMapException

Specified by:

fromMap in interface Sentiment

Parameters:

map - the map containing this sentiment

Throws:

UnrecognisedMapException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

bipolar

public static BipolarSentiment bipolar(TFF.Clue clue)

Parameters:

clue -

Returns:

given a clue construct a TFFCountSentiment with 1 word and 1 clue and call bipolar()