org.openimaj.tools

Class InOutToolOptions

java.lang.Object

org.openimaj.tools.InOutToolOptions

Direct Known Subclasses:

AbstractTwitterPreprocessingToolOptions, HadoopTwitterTokenToolOptions, PicSlurper, RedditHarvesterOptions, StormPicSlurper, StormToolOptions

public abstract class InOutToolOptions
extends Object

A file tool reads and writes files and knows whether existing outputs should be deleted

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	output

Constructor Summary

Constructors

Constructor and Description
InOutToolOptions()

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getAllInputs()
String	getInput()
String	getInputFile()
String	getOutput()
boolean	isContinue()
boolean	isForce()
boolean	overwriteOutput()
static <T> void	prepareMultivaluedArgument(List<T> modeOptions, T... defaults) Fixes a problem with args4j with multivalued arguments being preserved within the same JVM
void	setInput(String input) When the input file is set, any existing input file LIST file is removed (anything from -if)
void	setInputFile(String inputFile)
void	setOutput(String output)

Methods inherited from class java.lang.Object

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

Field Detail

output

protected String output

Constructor Detail

InOutToolOptions

public InOutToolOptions()

Method Detail

getInput

public String getInput()

Returns:

the input string option

getOutput

public String getOutput()

Returns:

the input string option

setInput

public void setInput(String input)

When the input file is set, any existing input file LIST file is removed (anything from -if)

Parameters:

input - new input location

setOutput

public void setOutput(String output)

Parameters:

output - new input location

overwriteOutput

public boolean overwriteOutput()

Returns:

the force option, whether the output should be overwritten if it exists

prepareMultivaluedArgument

public static <T> void prepareMultivaluedArgument(List<T> modeOptions,
                                  T... defaults)

Fixes a problem with args4j with multivalued arguments being preserved within the same JVM

Type Parameters:

T -

Parameters:

modeOptions -

defaults - optional default values if the modeoptions is empty

isForce

public boolean isForce()

Returns:

should files be forcefully removed

isContinue

public boolean isContinue()

Returns:

should existing files be continued from

getAllInputs

public String[] getAllInputs()

Returns:

all the inputs from the -if options file, or the single input if -i was not defined

getInputFile

public String getInputFile()

Returns:

the input list file, each line is an input

setInputFile

public void setInputFile(String inputFile)

Parameters:

inputFile - the new input file