Package affective.core

Class ArffLexiconEvaluator

java.lang.Object

affective.core.ArffLexiconEvaluator

All Implemented Interfaces:

java.io.Serializable, OptionHandler

public class ArffLexiconEvaluator
extends java.lang.Object
implements java.io.Serializable, OptionHandler

This class is used for calculating scores for a tweet using a list of affective lexicons in arff format. Numeric associations are added and nominal ones are counted.

Version:

$Revision: 1 $

Author:

Felipe Bravo-Marquez (fbravoma@waikato.ac.nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	LEXICON_FOLDER_NAME	Default path to where lexicons are stored.
static java.lang.String	NRC_AFFECT_INTENSITY_FILE_NAME	The path of the default lexicon.

Constructor Summary

Constructors

Constructor	Description
ArffLexiconEvaluator()

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.Double>	evaluateTweet(java.util.List<java.lang.String> tokens)	Calculates lexicon-based feature values from a list of tokens
java.util.List<java.lang.String>	getFeatureNames()	Gets the feature names
java.io.File	getLexiconFile()
java.lang.String	getLexiconName()
java.lang.String	getLexiconWordIndex()
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getNomDict()	Gets the dictionary with nominal attributes
java.lang.String[]	getOptions()
Stemmer	getStemmer()
java.lang.String	globalInfo()	Returns a string describing this filter.
java.util.Enumeration<Option>	listOptions()
void	processDict()	Processes all the dictionary files.
void	setLexiconFile(java.io.File lexiconFile)
void	setLexiconName(java.lang.String lexiconName)
void	setLexiconWordIndex(java.lang.String lexiconWordIndex)
void	setOptions(java.lang.String[] options)
void	setStemmer(Stemmer m_stemmer)

Methods inherited from class java.lang.Object

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

Field Detail

LEXICON_FOLDER_NAME

public static java.lang.String LEXICON_FOLDER_NAME

Default path to where lexicons are stored.

NRC_AFFECT_INTENSITY_FILE_NAME

public static java.lang.String NRC_AFFECT_INTENSITY_FILE_NAME

The path of the default lexicon.

Constructor Detail

ArffLexiconEvaluator

public ArffLexiconEvaluator()

Method Detail

processDict

public void processDict()
                 throws java.io.IOException

Processes all the dictionary files.

Throws:

java.io.IOException - an IOException will be raised if an invalid file is supplied

evaluateTweet

public java.util.Map<java.lang.String,java.lang.Double> evaluateTweet(java.util.List<java.lang.String> tokens)

Calculates lexicon-based feature values from a list of tokens

Parameters:

tokens - a tokenized tweet

Returns:

a mapping between attribute names and their scores

getFeatureNames

public java.util.List<java.lang.String> getFeatureNames()

Gets the feature names

Returns:

the feature names.

getNomDict

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getNomDict()

Gets the dictionary with nominal attributes

Returns:

the dictionary with nominal attributes

globalInfo

public java.lang.String globalInfo()

Returns a string describing this filter.

Returns:

a description of the filter suitable for displaying in the explorer/experimenter gui

listOptions

public java.util.Enumeration<Option> listOptions()

Specified by:

listOptions in interface OptionHandler

getOptions

public java.lang.String[] getOptions()

Specified by:

getOptions in interface OptionHandler

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Specified by:

setOptions in interface OptionHandler

Throws:

java.lang.Exception

getLexiconFile

@OptionMetadata(displayName="lexicon file",
                description="The arff file with the input lexicon.",
                commandLineParamName="lexiconFile",
                commandLineParamSynopsis="-lexiconFile <string>",
                displayOrder=1)
public java.io.File getLexiconFile()

setLexiconFile

public void setLexiconFile(java.io.File lexiconFile)

getLexiconName

@OptionMetadata(displayName="lexiconName",
                description="The lexicon name to be prefixed in all features calculated from this lexicon.",
                commandLineParamName="B",
                commandLineParamSynopsis="-B",
                displayOrder=2)
public java.lang.String getLexiconName()

setLexiconName

public void setLexiconName(java.lang.String lexiconName)

getLexiconWordIndex

@OptionMetadata(displayName="lexiconWordIndex",
                description="The index of the word attribute in the given arff lexicon (starting from 1). First and last are valid values.",
                commandLineParamName="A",
                commandLineParamSynopsis="-A <col>",
                displayOrder=3)
public java.lang.String getLexiconWordIndex()

setLexiconWordIndex

public void setLexiconWordIndex(java.lang.String lexiconWordIndex)

getStemmer

@OptionMetadata(displayName="stemmer",
                description="The stemming algorithm to use on the words from the lexicon. It is recommended to use the same stemmer used with the main filter. Default: no stemming.",
                commandLineParamName="lex-stemmer",
                commandLineParamSynopsis="-lex-stemmer <string>",
                displayOrder=4)
public Stemmer getStemmer()

setStemmer

public void setStemmer(Stemmer m_stemmer)