edu.illinois.ncsa.datawolf.executor.java.tool

Class Parameter

java.lang.Object

edu.illinois.ncsa.datawolf.executor.java.tool.Parameter

public class Parameter
extends Object

Definition of a parameter. This class is used to return a parameter needed by the tool.

Author:

Rob Kooper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Parameter.ParameterType

Constructor Summary

Constructors

Constructor and Description
Parameter(String id, String name, String description, Parameter.ParameterType type, String value) Define a parameter that will be shown to the user of the tool.
Parameter(String id, String name, String description, Parameter.ParameterType type, String value, boolean hidden) Define a parameter that will be shown to the user of the tool, if hidden is not set to true.
Parameter(String id, String name, String description, Parameter.ParameterType type, String value, boolean hidden, boolean allowEmpty) Define a parameter that will be shown to the user of the tool, if hidden is not set to true.
Parameter(String id, String name, String description, String value, boolean hidden, boolean allowEmpty, String... options) Define a parameter that will be shown to the user of the tool, if hidden is not set to true.
Parameter(String id, String name, String description, String value, boolean hidden, String... options) Define a parameter that will be shown to the user of the tool, if hidden is not set to true.
Parameter(String id, String name, String description, String value, String... options) Define a parameter that will be shown to the user of the tool.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Return the description of the parameter.
String	getID() Return the id of the parameter.
String	getName() Return the name of the paraemter.
String[]	getOptions() Returns array with all allowable options.
Parameter.ParameterType	getType() Return the type of the parameter.
String	getValue() Return the value of the parameter.
boolean	isAllowEmpty() Returns true if the parameter can be empty
boolean	isHidden() Returns true if the parameter should not be shown to the user.
void	setAllowEmpty(boolean allowEmpty) Set to true if the parameter should not be shown to the user.
void	setDescription(String description) Set the description of the parameter.
void	setHidden(boolean hidden) Set to true if the parameter should not be shown to the user.
void	setID(String id) Set the id of the parameter.
void	setName(String name) Set the name of the parameter.
void	setOptions(String... options) Sets an array with all allowable options.
void	setType(Parameter.ParameterType type) Set the type of the parameter.
void	setValue(String value) Set the value of the parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

public Parameter(String id,
         String name,
         String description,
         Parameter.ParameterType type,
         String value)

Define a parameter that will be shown to the user of the tool.

Parameters:

id - the id of the parameter, used when setting the parameter.

name - the name of the parameter, shown to the user.

description - description of the parameter, shown as help to the user.

type - type of the parameter, string for example.

value - the default value of the parameter.

Parameter

public Parameter(String id,
         String name,
         String description,
         Parameter.ParameterType type,
         String value,
         boolean hidden)

Define a parameter that will be shown to the user of the tool, if hidden is not set to true.

Parameters:

id - the id of the parameter, used when setting the parameter.

name - the name of the parameter, shown to the user.

description - description of the parameter, shown as help to the user.

type - type of the parameter, string for example.

value - the default value of the parameter.

hidden - if true don't show the parameter to the user.

Parameter

public Parameter(String id,
         String name,
         String description,
         Parameter.ParameterType type,
         String value,
         boolean hidden,
         boolean allowEmpty)

Define a parameter that will be shown to the user of the tool, if hidden is not set to true.

Parameters:

id - the id of the parameter, used when setting the parameter.

name - the name of the parameter, shown to the user.

description - description of the parameter, shown as help to the user.

type - type of the parameter, string for example.

value - the default value of the parameter.

hidden - if true don't show the parameter to the user.

allowEmpty - if true the parameter can be empty.

Parameter

public Parameter(String id,
         String name,
         String description,
         String value,
         String... options)

Define a parameter that will be shown to the user of the tool. This will be an parameter of type OPTION.

Parameters:

id - the id of the parameter, used when setting the parameter.

name - the name of the parameter, shown to the user.

description - description of the parameter, shown as help to the user.

value - the default value of the parameter.

options - possible values to select from.

Parameter

public Parameter(String id,
         String name,
         String description,
         String value,
         boolean hidden,
         String... options)

Define a parameter that will be shown to the user of the tool, if hidden is not set to true. This will be an parameter of type OPTION.

Parameters:

id - the id of the parameter, used when setting the parameter.

name - the name of the parameter, shown to the user.

description - description of the parameter, shown as help to the user.

value - the default value of the parameter.

hidden - if true don't show the parameter to the user.

options - possible values to select from.

Parameter

public Parameter(String id,
         String name,
         String description,
         String value,
         boolean hidden,
         boolean allowEmpty,
         String... options)

Define a parameter that will be shown to the user of the tool, if hidden is not set to true. This will be an parameter of type OPTION.

Parameters:

id - the id of the parameter, used when setting the parameter.

name - the name of the parameter, shown to the user.

description - description of the parameter, shown as help to the user.

value - the default value of the parameter.

hidden - if true don't show the parameter to the user.

allowEmpty - if true the parameter can be empty.

options - possible values to select from.

Method Detail

getID

public String getID()

Return the id of the parameter.

Returns:

id of the parameter.

setID

public void setID(String id)

Set the id of the parameter.

Parameters:

id - of the parameter.

getName

public String getName()

Return the name of the paraemter.

Returns:

name of the parameter.

setName

public void setName(String name)

Set the name of the parameter.

Parameters:

name - the new name of the parameter.

getDescription

public String getDescription()

Return the description of the parameter.

Returns:

description of the parameter.

setDescription

public void setDescription(String description)

Set the description of the parameter.

Parameters:

description - the new description of the parameter.

getType

public Parameter.ParameterType getType()

Return the type of the parameter.

Returns:

type of the parameter.

setType

public void setType(Parameter.ParameterType type)

Set the type of the parameter.

Parameters:

type - the new type of the parameter.

getValue

public String getValue()

Return the value of the parameter.

Returns:

value of the parameter.

setValue

public void setValue(String value)

Set the value of the parameter.

Parameters:

value - the new value of the parameter.

isHidden

public boolean isHidden()

Returns true if the parameter should not be shown to the user.

Returns:

true if the parameter is hidden.

setHidden

public void setHidden(boolean hidden)

Set to true if the parameter should not be shown to the user.

Parameters:

hidden - true if the parameter should not be shown to the user.

isAllowEmpty

public boolean isAllowEmpty()

Returns true if the parameter can be empty

Returns:

true if the parameter is hidden.

setAllowEmpty

public void setAllowEmpty(boolean allowEmpty)

Set to true if the parameter should not be shown to the user.

Parameters:

allowNull - true if the parameter should not be shown to the user.

getOptions

public String[] getOptions()

Returns array with all allowable options.

Returns:

all allowable options.

setOptions

public void setOptions(String... options)

Sets an array with all allowable options.