Package gov.nih.mipav.model.scripting.parameters

Class ParameterString

java.lang.Object

gov.nih.mipav.model.scripting.parameters.Parameter

gov.nih.mipav.model.scripting.parameters.ParameterString

Direct Known Subclasses:

ParameterFile, ParameterImage

public class ParameterString
extends Parameter

A string parameter used in either the recording or execution of a script action.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	value	The parameter's value.

Fields inherited from class gov.nih.mipav.model.scripting.parameters.Parameter

PARAM_BOOLEAN, PARAM_DOUBLE, PARAM_EXTERNAL_IMAGE, PARAM_FILE, PARAM_FLOAT, PARAM_IMAGE, PARAM_INT, PARAM_LIST, PARAM_LONG, PARAM_SHORT, PARAM_STRING, PARAM_USHORT

Constructor Summary

Constructors

Constructor	Description
ParameterString(String paramLabel)	Creates a new ParameterString object without any value.
ParameterString(String paramLabel, int paramType)	Creates a new ParameterString object without any value.
ParameterString(String paramLabel, int paramType, String paramValue)	Creates a new ParameterString object.
ParameterString(String paramLabel, String paramValue)	Creates a new ParameterString with a new value.
ParameterString(String paramLabel, String paramTypeString, String paramValue)	Creates a new ParameterString object.

Method Summary

Modifier and Type	Method	Description
String	getValue()	Returns the parameter value.
String	getValueString()	Returns the parameter value as a string.
void	setValue(String paramValueString)	Changes the parameter's current value.

Methods inherited from class gov.nih.mipav.model.scripting.parameters.Parameter

convertToString, getLabel, getParent, getParentConditionValueString, getType, getTypeFromString, getTypeString, getTypeString, isOptional, isParentConditionValueMet, isValueAssigned, setOptional, setParent, setParentCondition, setParentConditionValue, setValueAssigned

Methods inherited from class java.lang.Object

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

Field Details

value

protected String value

The parameter's value.

Constructor Details

ParameterString

public ParameterString(String paramLabel)
                throws ParserException

Creates a new ParameterString object without any value.

Parameters:

paramLabel - The label/name to give to this parameter.

Throws:

ParserException - If there is a problem creating the parameter.

ParameterString

public ParameterString(String paramLabel,
 String paramValue)
                throws ParserException

Creates a new ParameterString with a new value.

Parameters:

paramLabel - The label/name to give to this parameter.

paramValue - The new parameter value.

Throws:

ParserException - If there is a problem creating the parameter.

ParameterString

public ParameterString(String paramLabel,
 int paramType)
                throws ParserException

Creates a new ParameterString object without any value.

Parameters:

paramLabel - The label/name to give to this parameter.

paramType - The type of this parameter (should be PARAM_STRING).

Throws:

ParserException - If there is a problem creating the parameter.

ParameterString

public ParameterString(String paramLabel,
 String paramTypeString,
 String paramValue)
                throws ParserException

Creates a new ParameterString object.

Parameters:

paramLabel - The label/name to give to this parameter.

paramTypeString - The type of this parameter, in string form.

paramValue - The new parameter value.

Throws:

ParserException - If there is a problem creating the parameter.

ParameterString

public ParameterString(String paramLabel,
 int paramType,
 String paramValue)
                throws ParserException

Creates a new ParameterString object.

Parameters:

paramLabel - The label/name to give to this parameter.

paramType - The type of this parameter (should be PARAM_STRING).

paramValue - The new parameter value.

Throws:

ParserException - If there is a problem creating the parameter.

Method Details

getValue

public String getValue()

Returns the parameter value.

Returns:

The parameter value.

getValueString

public String getValueString()

Returns the parameter value as a string.

Specified by:

getValueString in class Parameter

Returns:

The parameter value in string form.

setValue

public void setValue(String paramValueString)
              throws ParserException

Changes the parameter's current value.

Specified by:

setValue in class Parameter

Parameters:

paramValueString - The new parameter value.

Throws:

ParserException - If there is a problem changing the parameter value.