Package weka.filters.unsupervised.attribute

Class LexiconDistantSupervision

java.lang.Object

weka.filters.Filter

weka.filters.SimpleFilter

weka.filters.SimpleBatchFilter

weka.filters.unsupervised.attribute.LexiconDistantSupervision

All Implemented Interfaces:

java.io.Serializable, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler

public class LexiconDistantSupervision
extends SimpleBatchFilter

A lexicon-based distant supervision method for training polarity classifiers in Twitter in the absence of labeled data. A lexicon is used for labeling tweets. The trailing word can be removed from the content. Tweets with both positive and negative words are discarded.

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

Constructor Summary

Constructors

Constructor	Description
LexiconDistantSupervision()

Method Summary

Modifier and Type	Method	Description
boolean	allowAccessToFullInputFormat()
Capabilities	getCapabilities()
java.io.File	getLexicon()
java.lang.String[]	getOptions()
java.lang.String	getPolarityAttName()
java.lang.String	getPolarityAttNegValName()
java.lang.String	getPolarityAttPosValName()
TechnicalInformation	getTechnicalInformation()	Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.
java.lang.String	getTextIndex()
Tokenizer	getTokenizer()
java.lang.String	globalInfo()
boolean	isRemoveMatchingWord()
java.util.Enumeration<Option>	listOptions()
static void	main(java.lang.String[] args)	Main method for testing this class.
void	setLexicon(java.io.File lexicon)
void	setOptions(java.lang.String[] options)	Parses the options for this object.
void	setPolarityAttName(java.lang.String polarityAttName)
void	setPolarityAttNegValName(java.lang.String polarityAttNegValName)
void	setPolarityAttPosValName(java.lang.String polarityAttPosValName)
void	setRemoveMatchingWord(boolean removeMatchingWord)
void	setTextIndex(java.lang.String textIndex)
void	setTokenizer(Tokenizer m_tokenizer)

Methods inherited from class weka.filters.Filter

batchFilterFile, debugTipText, doNotCheckCapabilitiesTipText, filterFile, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getOutputFormat, getRevision, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputPeek, postExecution, preExecution, run, runFilter, setDebug, setDoNotCheckCapabilities, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

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

Methods inherited from class weka.filters.SimpleBatchFilter

batchFinished, input

Methods inherited from class weka.filters.SimpleFilter

setInputFormat

Field Detail

LEXICON_FOLDER_NAME

public static java.lang.String LEXICON_FOLDER_NAME

Default path to where lexicons are stored

Constructor Detail

LexiconDistantSupervision

public LexiconDistantSupervision()

Method Detail

getTechnicalInformation

public TechnicalInformation getTechnicalInformation()

Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.

Returns:

the technical information about this class

globalInfo

public java.lang.String globalInfo()

Specified by:

globalInfo in class SimpleFilter

listOptions

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

Specified by:

listOptions in interface OptionHandler

Overrides:

listOptions in class Filter

getOptions

public java.lang.String[] getOptions()

Specified by:

getOptions in interface OptionHandler

Overrides:

getOptions in class Filter

setOptions

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

Parses the options for this object.

Specified by:

setOptions in interface OptionHandler

Overrides:

setOptions in class Filter

Parameters:

options - the options to use

Throws:

java.lang.Exception - if setting of options fails

getCapabilities

public Capabilities getCapabilities()

Specified by:

getCapabilities in interface CapabilitiesHandler

Overrides:

getCapabilities in class Filter

allowAccessToFullInputFormat

public boolean allowAccessToFullInputFormat()

Overrides:

allowAccessToFullInputFormat in class SimpleBatchFilter

getTextIndex

@OptionMetadata(displayName="textIndex",
                description="The index (starting from 1) of the target string attribute. First and last are valid values. ",
                commandLineParamName="I",
                commandLineParamSynopsis="-I <col>",
                displayOrder=0)
public java.lang.String getTextIndex()

setTextIndex

public void setTextIndex(java.lang.String textIndex)

getTokenizer

@OptionMetadata(displayName="tokenizer",
                description="The tokenizing algorithm to use on the tweets. Uses the CMU TweetNLP tokenizer as default",
                commandLineParamName="tokenizer",
                commandLineParamSynopsis="-tokenizer <string>",
                displayOrder=1)
public Tokenizer getTokenizer()

setTokenizer

public void setTokenizer(Tokenizer m_tokenizer)

getLexicon

@OptionMetadata(displayName="lexicon",
                description="The file containing a lexicon in ARFF format with word polarities.",
                commandLineParamName="lex",
                commandLineParamSynopsis="-lex <string>",
                displayOrder=2)
public java.io.File getLexicon()

setLexicon

public void setLexicon(java.io.File lexicon)

getPolarityAttName

@OptionMetadata(displayName="polarityAttName",
                description="The lexicon attribute name with the word polarities. The attribute must be nominal. \t default: polarity",
                commandLineParamName="polatt",
                commandLineParamSynopsis="-polatt <string>",
                displayOrder=3)
public java.lang.String getPolarityAttName()

setPolarityAttName

public void setPolarityAttName(java.lang.String polarityAttName)

getPolarityAttPosValName

@OptionMetadata(displayName="polarityAttPosValName",
                description="The lexicon attribute value name for positive words. \t default: positive",
                commandLineParamName="posval",
                commandLineParamSynopsis="-posval <String>",
                displayOrder=4)
public java.lang.String getPolarityAttPosValName()

setPolarityAttPosValName

public void setPolarityAttPosValName(java.lang.String polarityAttPosValName)

getPolarityAttNegValName

@OptionMetadata(displayName="polarityAttNegValName",
                description="The lexicon attribute value name for negative words. \t default: negative",
                commandLineParamName="negval",
                commandLineParamSynopsis="-negval <String>",
                displayOrder=5)
public java.lang.String getPolarityAttNegValName()

setPolarityAttNegValName

public void setPolarityAttNegValName(java.lang.String polarityAttNegValName)

isRemoveMatchingWord

@OptionMetadata(displayName="removeMatchingWord",
                description="True for removing the words from the lexicon in the tweet. This avoids overfitting classifiers trained from the labelled data. \t default: TRUE",
                commandLineParamIsFlag=true,
                commandLineParamName="removeMatchingWord",
                commandLineParamSynopsis="-removeMatchingWord",
                displayOrder=6)
public boolean isRemoveMatchingWord()

setRemoveMatchingWord

public void setRemoveMatchingWord(boolean removeMatchingWord)

main

public static void main(java.lang.String[] args)

Main method for testing this class.

Parameters:

args - should contain arguments to the filter: use -h for help