org.openimaj.text.nlp.sentiment.type

Class BipolarSentiment

java.lang.Object

org.openimaj.text.nlp.sentiment.type.BipolarSentiment

All Implemented Interfaces:

Sentiment

public class BipolarSentiment
extends Object
implements Sentiment

Encapsulate a simple sentiment that something is positive, negative or neutral.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BipolarSentiment.State The states of a bipolar sentiment

Field Summary

Fields

Modifier and Type	Field and Description
static BipolarSentiment	NEGATIVE a negative sentiment instance
static BipolarSentiment	NEUTRAL a neutral sentiment instance
static BipolarSentiment	POSITIVE a positive sentiment instance

Constructor Summary

Constructors

Constructor and Description
BipolarSentiment() Initialize sentiment as BipolarSentiment.State.NEUTRAL
BipolarSentiment(BipolarSentiment.State positive) Instantiate the sentiment

Method Summary

Modifier and Type	Method and Description
Map<String,?>	asMap()
boolean	equals(Object obj)
void	fromMap(Map<String,?> map)
static Set<BipolarSentiment>	listBipolarSentiment()
boolean	negative()
boolean	neutral()
boolean	positive()
BipolarSentiment.State	sentiment()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NEUTRAL

public static final BipolarSentiment NEUTRAL

a neutral sentiment instance

NEGATIVE

public static final BipolarSentiment NEGATIVE

a negative sentiment instance

POSITIVE

public static final BipolarSentiment POSITIVE

a positive sentiment instance

Constructor Detail

BipolarSentiment

public BipolarSentiment()

Initialize sentiment as BipolarSentiment.State.NEUTRAL

BipolarSentiment

public BipolarSentiment(BipolarSentiment.State positive)

Instantiate the sentiment

Parameters:

positive -

Method Detail

negative

public boolean negative()

Returns:

sentiment == NEGATIVE

positive

public boolean positive()

Returns:

positive

neutral

public boolean neutral()

Returns:

positive

sentiment

public BipolarSentiment.State sentiment()

Returns:

the bipolar sentiment

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

toString

public String toString()

Overrides:

toString in class Object

listBipolarSentiment

public static Set<BipolarSentiment> listBipolarSentiment()

Returns:

a list of the BipolarSentiment instances