Package ch.privately.owas.nlp

Enum Class EmotionAnalyzer

java.lang.Object

java.lang.Enum<EmotionAnalyzer>

ch.privately.owas.nlp.EmotionAnalyzer

All Implemented Interfaces:

Serializable, Comparable<EmotionAnalyzer>, Constable

public enum EmotionAnalyzer
extends Enum<EmotionAnalyzer>

 Class to extract the sentiments from a text.

 It is a good idea to test that the model is loaded before calling analyzeText().
 A simple use case to analyse a text for prevalent emotions would be:


     public EmotionResult classifyText(String text) {
         if (EmotionAnalyzer.INSTANCE.isLoaded()) {
             return EmotionAnalyser.INSTANCE.analyzeText(text);
         }
         return null;
     }
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Method Summary

Modifier and Type	Method	Description
EmotionResult	analyzeText(String text)	Analyze a text for emotion.
void	init(android.content.Context context)	Initialise the emotion analyser by loading the model.
boolean	isLoaded()
static EmotionAnalyzer	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EmotionAnalyzer[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final EmotionAnalyzer INSTANCE

Method Details

values

public static EmotionAnalyzer[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EmotionAnalyzer valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

init

public void init(android.content.Context context)

Initialise the emotion analyser by loading the model.

Parameters:

context - the context used to load the model.

isLoaded

public boolean isLoaded()

Returns:

true if the model is loaded.

analyzeText

public EmotionResult analyzeText(String text)

Analyze a text for emotion.

Parameters:

text - the text to analyze.

Returns:

a mapping of emotion to score. Higher score means more prevalence of the associated emotion.

Throws:

IllegalStateException - if the method is called before the class is initialised.