edu.stanford.nlp.simple

Enum SentimentClass

java.lang.Object

java.lang.Enum<SentimentClass>

edu.stanford.nlp.simple.SentimentClass

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SentimentClass>

public enum SentimentClass
extends java.lang.Enum<SentimentClass>

An enum for the Simple CoreNLP API to represent a sentiment value.

Author:

Gabor Angeli

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEGATIVE
NEUTRAL
POSITIVE
VERY_NEGATIVE
VERY_POSITIVE

Method Summary

Modifier and Type	Method and Description
static SentimentClass	fromInt(int sentiment) Get the sentiment class from the Stanford Sentiment Treebank integer encoding.
boolean	isExtreme()
boolean	isMild()
boolean	isNegative()
boolean	isNeutral()
boolean	isPositive()
static SentimentClass	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SentimentClass[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VERY_POSITIVE

public static final SentimentClass VERY_POSITIVE

POSITIVE

public static final SentimentClass POSITIVE

NEUTRAL

public static final SentimentClass NEUTRAL

NEGATIVE

public static final SentimentClass NEGATIVE

VERY_NEGATIVE

public static final SentimentClass VERY_NEGATIVE

Method Detail

values

public static SentimentClass[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SentimentClass c : SentimentClass.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SentimentClass valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isPositive

public boolean isPositive()

isNegative

public boolean isNegative()

isExtreme

public boolean isExtreme()

isMild

public boolean isMild()

isNeutral

public boolean isNeutral()

fromInt

public static SentimentClass fromInt(int sentiment)

Get the sentiment class from the Stanford Sentiment Treebank integer encoding. That is, an integer between 0 and 4 (inclusive)

Parameters:

sentiment - The Integer representation of a sentiment.

Returns:

The sentiment class associated with that integer.