Package weka.filters.unsupervised.attribute

Class TweetNLPPOSTagger

java.lang.Object

weka.filters.Filter

weka.filters.SimpleFilter

weka.filters.SimpleBatchFilter

weka.filters.unsupervised.attribute.TweetNLPPOSTagger

All Implemented Interfaces:

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

public class TweetNLPPOSTagger
extends SimpleBatchFilter

A Twitter-specific POS tagger based on the CMU TwitterNLP library: http://www.cs.cmu.edu/~ark/TweetNLP/ BibTeX:

 @InProceedings{twitterNLP,
        Title                    = {Part-of-speech tagging for twitter: Annotation, features, and experiments},
        Author                   = {Gimpel, Kevin and Schneider, Nathan and O'Connor, Brendan and Das, Dipanjan and Mills, Daniel and Eisenstein, Jacob and Heilman, Michael and Yogatama, Dani and Flanigan, Jeffrey and Smith, Noah A},
        Booktitle                = {Proceedings of the 49th Annual Meeting of the Association for Computational Linguistics: Human Language Technologies: short papers-Volume 2},
        Year                     = {2011},
        Organization             = {Association for Computational Linguistics},
        Pages                    = {42--47}
        }
 

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	RESOURCES_FOLDER_NAME	Default path to where resources are stored.

Constructor Summary

Constructors

Constructor	Description
TweetNLPPOSTagger()

Method Summary

Modifier and Type	Method	Description
boolean	allowAccessToFullInputFormat()
Capabilities	getCapabilities()
java.lang.String[]	getOptions()
java.lang.String	getSeparator()
java.io.File	getTaggerFile()
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()
java.util.Enumeration<Option>	listOptions()
static void	main(java.lang.String[] args)	Main method for testing this class.
void	setOptions(java.lang.String[] options)	Parses the options for this object.
void	setSeparator(java.lang.String separator)
void	setTaggerFile(java.io.File taggerFile)
void	setTextIndex(java.lang.String textIndex)
void	setTokenizer(Tokenizer m_tokenizer)
java.lang.String	tagTweet(java.lang.String content)	Returns POS-tagger String from a given String using the CMU TweetNLP tool

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

RESOURCES_FOLDER_NAME

public static java.lang.String RESOURCES_FOLDER_NAME

Default path to where resources are stored.

Constructor Detail

TweetNLPPOSTagger

public TweetNLPPOSTagger()

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

tagTweet

public java.lang.String tagTweet(java.lang.String content)

Returns POS-tagger String from a given String using the CMU TweetNLP tool

Parameters:

content - the String

Returns:

the tagged String

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)

getTaggerFile

@OptionMetadata(displayName="taggerFile",
                description="The file with TweetNLP POS tagger model.",
                commandLineParamName="taggerFile",
                commandLineParamSynopsis="-taggerFile <string>",
                displayOrder=2)
public java.io.File getTaggerFile()

setTaggerFile

public void setTaggerFile(java.io.File taggerFile)

getSeparator

@OptionMetadata(displayName="separator",
                description="The separator String between the token and the POS tag.",
                commandLineParamName="separator",
                commandLineParamSynopsis="-separator <string>",
                displayOrder=3)
public java.lang.String getSeparator()

setSeparator

public void setSeparator(java.lang.String separator)

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