org.openimaj.tools.twitter.options

Class AbstractTwitterPreprocessingToolOptions

java.lang.Object

org.openimaj.tools.InOutToolOptions

org.openimaj.tools.twitter.options.AbstractTwitterPreprocessingToolOptions

Direct Known Subclasses:

HadoopTwitterPreprocessingToolOptions, TwitterPreprocessingToolOptions

public abstract class AbstractTwitterPreprocessingToolOptions
extends InOutToolOptions

An abstract kind of twitter processing tool. Contains all the options generic to this kind of tool, not dependant on files or hadoop or whatever.

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
List<TwitterPreprocessingMode<?>>	modeOptionsOp The preprocessing to perform
StatusType	outputStatusType the status type to output
List<TwitterPreprocessingPredicate>	postFilterOptionsOp the postfiltering to perform
List<TwitterPreprocessingPredicate>	preFilterOptionsOp The prefiltering to perform
StatusType	statusType the status type to take as input

Fields inherited from class org.openimaj.tools.InOutToolOptions

output

Constructor Summary

Constructors

Constructor and Description
AbstractTwitterPreprocessingToolOptions(String[] args)
AbstractTwitterPreprocessingToolOptions(String[] args, boolean prepare)

Method Summary

Modifier and Type	Method and Description
GeneralJSON	convertToOutputFormat(USMFStatus twitterStatus) Provides the functionality to convert to the required output format as specified by -ot
String	getEncoding()
StatusType	getInputClass()
StatusType	getOutputClass()
long	getTimeBeforeSkip()
TwitterOutputMode	ouputMode()
boolean	postProcessesSkip(USMFStatus twitterStatus) Check the internal postprocessing filters and say whether a given status should be skipped
void	prepare() prepare the tool for running
boolean	preProcessesSkip(USMFStatus twitterStatus) Check the internal preprocessing filters and say whether a given status should be skipped
List<TwitterPreprocessingMode<?>>	preprocessingMode()
void	progress(String string)
abstract boolean	validate()
boolean	veryLoud()

Methods inherited from class org.openimaj.tools.InOutToolOptions

getAllInputs, getInput, getInputFile, getOutput, isContinue, isForce, overwriteOutput, prepareMultivaluedArgument, setInput, setInputFile, setOutput

Methods inherited from class java.lang.Object

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

Field Detail

modeOptionsOp

public List<TwitterPreprocessingMode<?>> modeOptionsOp

The preprocessing to perform

preFilterOptionsOp

public List<TwitterPreprocessingPredicate> preFilterOptionsOp

The prefiltering to perform

postFilterOptionsOp

public List<TwitterPreprocessingPredicate> postFilterOptionsOp

the postfiltering to perform

statusType

public StatusType statusType

the status type to take as input

outputStatusType

public StatusType outputStatusType

the status type to output

Constructor Detail

AbstractTwitterPreprocessingToolOptions

public AbstractTwitterPreprocessingToolOptions(String[] args,
                                               boolean prepare)
                                        throws org.kohsuke.args4j.CmdLineException

Parameters:

args - the arguments, prepared using the prepare method

prepare - whether prepare should be called now or later

Throws:

org.kohsuke.args4j.CmdLineException

AbstractTwitterPreprocessingToolOptions

public AbstractTwitterPreprocessingToolOptions(String[] args)
                                        throws org.kohsuke.args4j.CmdLineException

Parameters:

args - the arguments, prepared using the prepare method

Throws:

org.kohsuke.args4j.CmdLineException

Method Detail

prepare

public void prepare()
             throws org.kohsuke.args4j.CmdLineException

prepare the tool for running

Throws:

org.kohsuke.args4j.CmdLineException

preprocessingMode

public List<TwitterPreprocessingMode<?>> preprocessingMode()
                                                    throws Exception

Returns:

an instance of the selected preprocessing mode

Throws:

Exception

ouputMode

public TwitterOutputMode ouputMode()

Returns:

an instance of the selected output mode

validate

public abstract boolean validate()
                          throws org.kohsuke.args4j.CmdLineException

Returns:

whether the options provided make sense

Throws:

org.kohsuke.args4j.CmdLineException

progress

public void progress(String string)

Parameters:

string - print progress if we are not being quiet

veryLoud

public boolean veryLoud()

Returns:

print some extra information

getTimeBeforeSkip

public long getTimeBeforeSkip()

Returns:

the time to wait while analysing a tweet before it is skipped over

getEncoding

public String getEncoding()

Returns:

the encoding

preProcessesSkip

public boolean preProcessesSkip(USMFStatus twitterStatus)

Check the internal preprocessing filters and say whether a given status should be skipped

Parameters:

twitterStatus -

Returns:

whether to skip a status

postProcessesSkip

public boolean postProcessesSkip(USMFStatus twitterStatus)

Check the internal postprocessing filters and say whether a given status should be skipped

Parameters:

twitterStatus -

Returns:

whether to skip a status

convertToOutputFormat

public GeneralJSON convertToOutputFormat(USMFStatus twitterStatus)

Provides the functionality to convert to the required output format as specified by -ot

Parameters:

twitterStatus -

Returns:

the converted output

getInputClass

public StatusType getInputClass()

Returns:

the input status type

getOutputClass

public StatusType getOutputClass()

Returns:

the input status type