ivory.bloomir.util

Class OptionManager

java.lang.Object

ivory.bloomir.util.OptionManager

public class OptionManager
extends Object

Utility class that helps manage command line options

Author:

Nima Asadi

Field Summary

Fields

Modifier and Type	Field and Description
static String	BITS_PER_ELEMENT
static String	BLOOM_ROOT_PATH
static String	DOCUMENT_PATH
static String	DOCUMENT_VECTOR_CLASS
static String	FEATURE_PATH
static String	HITS
static String	INDEX_ROOT_PATH
static String	JUDGMENT_PATH
static String	NUMBER_OF_HASH
static String	OUTPUT_PATH
static String	POSTINGS_ROOT_PATH
static String	QUERY_PATH
static String	SPAM_PATH

Constructor Summary

Constructors

Constructor and Description
OptionManager(String className)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDependency(String optionA, String optionB) Adds a dependency.
void	addOption(String option, String valueType, String description, boolean isRequired) Creates an Option
void	addOption(String option, String valueType, String description, boolean isRequired, boolean hasArg) Creates an Option
boolean	foundOption(String option) Please use parse(java.lang.String[]) before calling this method.
String	getOptionValue(String option) Please use parse(java.lang.String[]) before calling this method.
void	parse(String[] args) Parses command line arguments

Methods inherited from class java.lang.Object

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

Field Detail

BITS_PER_ELEMENT

public static final String BITS_PER_ELEMENT

See Also:

Constant Field Values

BLOOM_ROOT_PATH

public static final String BLOOM_ROOT_PATH

See Also:

Constant Field Values

DOCUMENT_PATH

public static final String DOCUMENT_PATH

See Also:

Constant Field Values

DOCUMENT_VECTOR_CLASS

public static final String DOCUMENT_VECTOR_CLASS

See Also:

Constant Field Values

FEATURE_PATH

public static final String FEATURE_PATH

See Also:

Constant Field Values

HITS

public static final String HITS

See Also:

Constant Field Values

INDEX_ROOT_PATH

public static final String INDEX_ROOT_PATH

See Also:

Constant Field Values

JUDGMENT_PATH

public static final String JUDGMENT_PATH

See Also:

Constant Field Values

NUMBER_OF_HASH

public static final String NUMBER_OF_HASH

See Also:

Constant Field Values

OUTPUT_PATH

public static final String OUTPUT_PATH

See Also:

Constant Field Values

POSTINGS_ROOT_PATH

public static final String POSTINGS_ROOT_PATH

See Also:

Constant Field Values

QUERY_PATH

public static final String QUERY_PATH

See Also:

Constant Field Values

SPAM_PATH

public static final String SPAM_PATH

See Also:

Constant Field Values

Constructor Detail

OptionManager

public OptionManager(String className)

Parameters:

className - Class name (arbitrary)

Method Detail

addDependency

public void addDependency(String optionA,
                 String optionB)

Adds a dependency. If option A is present then option B will be required when parsing command line arguments. Please use addOption(java.lang.String, java.lang.String, java.lang.String, boolean) to define optionA and optionB first.

Parameters:

optionA -

optionB - Option B is required if option A is present

addOption

public void addOption(String option,
             String valueType,
             String description,
             boolean isRequired)

Creates an Option

Parameters:

option - Option name

valueType - Value type

description - Description of the option

isRequired - Whether this option is required or optional

addOption

public void addOption(String option,
             String valueType,
             String description,
             boolean isRequired,
             boolean hasArg)

Creates an Option

Parameters:

option - Option name

valueType - Value type

description - Description of the option

isRequired - Whether this option is required or optional

hasArg - Whether this option takes argument

foundOption

public boolean foundOption(String option)

Please use parse(java.lang.String[]) before calling this method.

Parameters:

option - Option name

Returns:

whether the given option is present in the command line arguments

getOptionValue

public String getOptionValue(String option)

Please use parse(java.lang.String[]) before calling this method.

Parameters:

option - Option name

Returns:

value of the given option

parse

public void parse(String[] args)
           throws org.apache.commons.cli.ParseException

Parses command line arguments

Parameters:

args - Command line arguments

Throws:

org.apache.commons.cli.ParseException