org.apache.giraph.benchmark

Class BenchmarkOption

java.lang.Object

org.apache.giraph.benchmark.BenchmarkOption

public class BenchmarkOption
extends Object

Command line options for benchmarks

Field Summary

Fields

Modifier and Type	Field and Description
static BenchmarkOption	EDGES_PER_VERTEX Option for number of edges per vertex
static BenchmarkOption	HELP Option for help
static BenchmarkOption	JYTHON Option for using Jython
static BenchmarkOption	LOCAL_EDGES_MIN_RATIO Option for minimum ratio of partition-local edges
static BenchmarkOption	SCRIPT_PATH Option for path to script for computation
static BenchmarkOption	SUPERSTEPS Option for number of supersteps
static BenchmarkOption	VERBOSE Option for verbose
static BenchmarkOption	VERTICES Option for number of vertices
static BenchmarkOption	WORKERS Option for number of workers

Constructor Summary

Constructors

Constructor and Description
BenchmarkOption(String shortOption, String longOption, boolean hasArgument, String description) Constructor for option which is not required
BenchmarkOption(String shortOption, String longOption, boolean hasArgument, String description, String missingMessage) Constructor for option which is not required

Method Summary

Modifier and Type	Method and Description
void	addToOptions(org.apache.commons.cli.Options options) Add option to cli Options
boolean	checkOption(org.apache.commons.cli.CommandLine cmd, org.apache.log4j.Logger log) If option is not required just return true.
float	getOptionFloatValue(org.apache.commons.cli.CommandLine cmd) Retrieve the argument of this option as float value
float	getOptionFloatValue(org.apache.commons.cli.CommandLine cmd, float defaultValue) Retrieve the argument of this option as float value, or default value if option is not set
int	getOptionIntValue(org.apache.commons.cli.CommandLine cmd) Retrieve the argument of this option as integer value
int	getOptionIntValue(org.apache.commons.cli.CommandLine cmd, int defaultValue) Retrieve the argument of this option as integer value, or default value if option is not set
long	getOptionLongValue(org.apache.commons.cli.CommandLine cmd) Retrieve the argument of this option as long value
String	getOptionValue(org.apache.commons.cli.CommandLine cmd) Retrieve the argument, if any, of this option
boolean	isRequired() Check if the option is required
boolean	optionTurnedOn(org.apache.commons.cli.CommandLine cmd) Check if the option is present in CommandLine

Methods inherited from class java.lang.Object

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

Field Detail

HELP

public static final BenchmarkOption HELP

Option for help

VERBOSE

public static final BenchmarkOption VERBOSE

Option for verbose

WORKERS

public static final BenchmarkOption WORKERS

Option for number of workers

SUPERSTEPS

public static final BenchmarkOption SUPERSTEPS

Option for number of supersteps

VERTICES

public static final BenchmarkOption VERTICES

Option for number of vertices

EDGES_PER_VERTEX

public static final BenchmarkOption EDGES_PER_VERTEX

Option for number of edges per vertex

LOCAL_EDGES_MIN_RATIO

public static final BenchmarkOption LOCAL_EDGES_MIN_RATIO

Option for minimum ratio of partition-local edges

JYTHON

public static final BenchmarkOption JYTHON

Option for using Jython

SCRIPT_PATH

public static final BenchmarkOption SCRIPT_PATH

Option for path to script for computation

Constructor Detail

BenchmarkOption

public BenchmarkOption(String shortOption,
                       String longOption,
                       boolean hasArgument,
                       String description)

Constructor for option which is not required

Parameters:

shortOption - Short option

longOption - Long option

hasArgument - True iff option requires argument

description - Description of the option

BenchmarkOption

public BenchmarkOption(String shortOption,
                       String longOption,
                       boolean hasArgument,
                       String description,
                       String missingMessage)

Constructor for option which is not required

Parameters:

shortOption - Short option

longOption - Long option

hasArgument - True iff option requires argument

description - Description of the option

missingMessage - Message to print if the option is missing

Method Detail

isRequired

public boolean isRequired()

Check if the option is required

Returns:

True iff the option is required

addToOptions

public void addToOptions(org.apache.commons.cli.Options options)

Add option to cli Options

Parameters:

options - Cli Options

checkOption

public boolean checkOption(org.apache.commons.cli.CommandLine cmd,
                           org.apache.log4j.Logger log)

If option is not required just return true. If option is required, check if it's present in CommandLine, and if it's not print the missingMessage to log.

Parameters:

cmd - CommandLine

log - Logger to print the missing message to

Returns:

False iff the option is required but is not specified in cmd

optionTurnedOn

public boolean optionTurnedOn(org.apache.commons.cli.CommandLine cmd)

Check if the option is present in CommandLine

Parameters:

cmd - CommandLine

Returns:

True iff the option is present in CommandLine

getOptionValue

public String getOptionValue(org.apache.commons.cli.CommandLine cmd)

Retrieve the argument, if any, of this option

Parameters:

cmd - CommandLine

Returns:

Value of the argument if option is set and has an argument, otherwise null

getOptionIntValue

public int getOptionIntValue(org.apache.commons.cli.CommandLine cmd)

Retrieve the argument of this option as integer value

Parameters:

cmd - CommandLine

Returns:

Value of the argument as integer value

getOptionIntValue

public int getOptionIntValue(org.apache.commons.cli.CommandLine cmd,
                             int defaultValue)

Retrieve the argument of this option as integer value, or default value if option is not set

Parameters:

cmd - CommandLine

defaultValue - Default value

Returns:

Value of the argument as integer value, or default value if option is not set

getOptionLongValue

public long getOptionLongValue(org.apache.commons.cli.CommandLine cmd)

Retrieve the argument of this option as long value

Parameters:

cmd - CommandLine

Returns:

Value of the argument as long value

getOptionFloatValue

public float getOptionFloatValue(org.apache.commons.cli.CommandLine cmd)

Retrieve the argument of this option as float value

Parameters:

cmd - CommandLine

Returns:

Value of the argument as float value

getOptionFloatValue

public float getOptionFloatValue(org.apache.commons.cli.CommandLine cmd,
                                 float defaultValue)

Retrieve the argument of this option as float value, or default value if option is not set

Parameters:

cmd - CommandLine

defaultValue - Default value

Returns:

Value of the argument as float value, or default value if option is not set