edu.mines.jtk.util

Class Parameter

java.lang.Object

edu.mines.jtk.util.Parameter

All Implemented Interfaces:

java.lang.Cloneable

public class Parameter
extends java.lang.Object
implements java.lang.Cloneable

A parameter - a named value (or array of values) with a type and (optional) units. A parameter's type may be set explicitly or by by setting its value(s). A parameter value set as one type may be got as another type, provided that the implied conversion is supported. For example, any float may be converted to a String, but only some Strings may be converted to floats. Getting a parameter value never changes the intrinsic parameter type. A ParameterConvertException is thrown when a conversion fails. Parameters typically reside in a parameter set. A parameter set contains parameters and parameter subsets, thereby creating a tree with parameters as leaves.

See Also:

ParameterSet, ParameterConvertException

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOOLEAN Parameter type boolean.
static int	DOUBLE Parameter type double.
static int	FLOAT Parameter type float.
static int	INT Parameter type int.
static int	LONG Parameter type long.
static int	NULL Parameter type null.
static int	STRING Parameter type string.

Constructor Summary

Constructors

Constructor and Description
Parameter(java.lang.String name) Construct an empty named parameter.
Parameter(java.lang.String name, boolean value) Construct a named parameter with boolean value.
Parameter(java.lang.String name, boolean[] values) Construct a named parameter with boolean values.
Parameter(java.lang.String name, boolean[] values, java.lang.String units) Construct a named parameter with boolean values and units.
Parameter(java.lang.String name, boolean value, java.lang.String units) Construct a named parameter with boolean value and units.
Parameter(java.lang.String name, double value) Construct a named parameter with double value.
Parameter(java.lang.String name, double[] values) Construct a named parameter with double values.
Parameter(java.lang.String name, double[] values, java.lang.String units) Construct a named parameter with double values and units.
Parameter(java.lang.String name, double value, java.lang.String units) Construct a named parameter with double value and units.
Parameter(java.lang.String name, float value) Construct a named parameter with float value.
Parameter(java.lang.String name, float[] values) Construct a named parameter with float values.
Parameter(java.lang.String name, float[] values, java.lang.String units) Construct a named parameter with float values and units.
Parameter(java.lang.String name, float value, java.lang.String units) Construct a named parameter with float value and units.
Parameter(java.lang.String name, int value) Construct a named parameter with int value.
Parameter(java.lang.String name, int[] values) Construct a named parameter with int values.
Parameter(java.lang.String name, int[] values, java.lang.String units) Construct a named parameter with int values and units.
Parameter(java.lang.String name, int value, java.lang.String units) Construct a named parameter with int value and units.
Parameter(java.lang.String name, long value) Construct a named parameter with long value.
Parameter(java.lang.String name, long[] values) Construct a named parameter with long values.
Parameter(java.lang.String name, long[] values, java.lang.String units) Construct a named parameter with long values and units.
Parameter(java.lang.String name, long value, java.lang.String units) Construct a named parameter with long value and units.
Parameter(java.lang.String name, java.lang.String value) Construct a named parameter with String value.
Parameter(java.lang.String name, java.lang.String[] values) Construct a named parameter with String values.
Parameter(java.lang.String name, java.lang.String[] values, java.lang.String units) Construct a named parameter with String values and units.
Parameter(java.lang.String name, java.lang.String value, java.lang.String units) Construct a named parameter with String value and units.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Clone this parameter.
Parameter	copyTo(ParameterSet parent) Copy this parameter to the specified parent parameter set without changing its name.
Parameter	copyTo(ParameterSet parent, java.lang.String name) Copy this parameter.to the specified parent parameter set while changing its name.
boolean	equals(java.lang.Object o) Compares two parameters for equality.
boolean	getBoolean() Get parameter value as boolean.
boolean[]	getBooleans() Get parameter values as array of booleans.
double	getDouble() Get parameter value as double.
double[]	getDoubles() Get parameter values as array of doubles.
float	getFloat() Get parameter value as float.
float[]	getFloats() Get parameter values as array of floats.
int	getInt() Get parameter value as int.
int[]	getInts() Get parameter values as array of ints.
long	getLong() Get parameter value as long.
long[]	getLongs() Get parameter values as array of longs.
java.lang.String	getName() Get the parameter name.
ParameterSet	getParent() Get the parameter set that contains this parameter.
java.lang.String	getString() Get parameter value as String.
java.lang.String[]	getStrings() Get parameter values as array of Strings.
int	getType() Get the parameter type.
java.lang.String	getUnits() Get the parameter units.
int	hashCode() Computes the hash code of this paramater.
boolean	isBoolean() Tests if parameter type is boolean.
boolean	isDouble() Tests if parameter type is double.
boolean	isFloat() Tests if parameter type is float.
boolean	isInt() Tests if parameter type is int.
boolean	isLong() Tests if parameter type is long.
boolean	isNull() Tests if parameter type is null.
boolean	isString() Tests if parameter type is String.
Parameter	moveTo(ParameterSet parent) Move this parameter to the specified parent parameter set without changing its name.
Parameter	moveTo(ParameterSet parent, java.lang.String name) Move this parameter to the specified parent parameter set while changing its name.
void	remove() Remove this parameter from its parent parameter set.
Parameter	replaceWith(Parameter par) Replace the contents of this parameter with a copy of the contents of the specified parameter.
void	setBoolean(boolean value) Set parameter value as boolean.
void	setBooleans(boolean[] values) Set parameter values as an array of booleans.
void	setDouble(double value) Set parameter value as double.
void	setDoubles(double[] values) Set parameter values as an array of doubles.
void	setFloat(float value) Set parameter value as float.
void	setFloats(float[] values) Set parameter values as an array of floats.
void	setInt(int value) Set parameter value as int.
void	setInts(int[] values) Set parameter values as an array of ints.
void	setLong(long value) Set parameter value as long.
void	setLongs(long[] values) Set parameter values as an array of longs.
void	setName(java.lang.String name) Set the parameter name.
void	setString(java.lang.String value) Set parameter value as String.
void	setStrings(java.lang.String[] values) Set parameter values as an array of Strings.
void	setType(int type) Set the parameter type.
void	setUnits(java.lang.String units) Set the parameter units.
java.lang.String	toString() Get a string representation of this parameter.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NULL

public static final int NULL

Parameter type null.

See Also:

Constant Field Values

BOOLEAN

public static final int BOOLEAN

Parameter type boolean.

See Also:

Constant Field Values

INT

public static final int INT

Parameter type int.

See Also:

Constant Field Values

LONG

public static final int LONG

Parameter type long.

See Also:

Constant Field Values

FLOAT

public static final int FLOAT

Parameter type float.

See Also:

Constant Field Values

DOUBLE

public static final int DOUBLE

Parameter type double.

See Also:

Constant Field Values

STRING

public static final int STRING

Parameter type string.

See Also:

Constant Field Values

Constructor Detail

Parameter

public Parameter(java.lang.String name)

Construct an empty named parameter.

Parameters:

name - parameter name.

Parameter

public Parameter(java.lang.String name,
         boolean value)

Construct a named parameter with boolean value.

Parameters:

name - parameter name.

value - parameter value.

Parameter

public Parameter(java.lang.String name,
         int value)

Construct a named parameter with int value.

Parameters:

name - parameter name.

value - parameter value.

Parameter

public Parameter(java.lang.String name,
         long value)

Construct a named parameter with long value.

Parameters:

name - parameter name.

value - parameter value.

Parameter

public Parameter(java.lang.String name,
         float value)

Construct a named parameter with float value.

Parameters:

name - parameter name.

value - parameter value.

Parameter

public Parameter(java.lang.String name,
         double value)

Construct a named parameter with double value.

Parameters:

name - parameter name.

value - parameter value.

Parameter

public Parameter(java.lang.String name,
         java.lang.String value)

Construct a named parameter with String value.

Parameters:

name - parameter name.

value - parameter value.

Parameter

public Parameter(java.lang.String name,
         boolean[] values)

Construct a named parameter with boolean values.

Parameters:

name - parameter name.

values - parameter values.

Parameter

public Parameter(java.lang.String name,
         int[] values)

Construct a named parameter with int values.

Parameters:

name - parameter name.

values - parameter values.

Parameter

public Parameter(java.lang.String name,
         long[] values)

Construct a named parameter with long values.

Parameters:

name - parameter name.

values - parameter values.

Parameter

public Parameter(java.lang.String name,
         float[] values)

Construct a named parameter with float values.

Parameters:

name - parameter name.

values - parameter values.

Parameter

public Parameter(java.lang.String name,
         double[] values)

Construct a named parameter with double values.

Parameters:

name - parameter name.

values - parameter values.

Parameter

public Parameter(java.lang.String name,
         java.lang.String[] values)

Construct a named parameter with String values.

Parameters:

name - parameter name.

values - parameter values.

Parameter

public Parameter(java.lang.String name,
         boolean value,
         java.lang.String units)

Construct a named parameter with boolean value and units.

Parameters:

name - parameter name.

value - parameter value.

units - parameter units.

Parameter

public Parameter(java.lang.String name,
         int value,
         java.lang.String units)

Construct a named parameter with int value and units.

Parameters:

name - parameter name.

value - parameter value.

units - parameter units.

Parameter

public Parameter(java.lang.String name,
         long value,
         java.lang.String units)

Construct a named parameter with long value and units.

Parameters:

name - parameter name.

value - parameter value.

units - parameter units.

Parameter

public Parameter(java.lang.String name,
         float value,
         java.lang.String units)

Construct a named parameter with float value and units.

Parameters:

name - parameter name.

value - parameter value.

units - parameter units.

Parameter

public Parameter(java.lang.String name,
         double value,
         java.lang.String units)

Construct a named parameter with double value and units.

Parameters:

name - parameter name.

value - parameter value.

units - parameter units.

Parameter

public Parameter(java.lang.String name,
         java.lang.String value,
         java.lang.String units)

Construct a named parameter with String value and units.

Parameters:

name - parameter name.

value - parameter value.

units - parameter units.

Parameter

public Parameter(java.lang.String name,
         boolean[] values,
         java.lang.String units)

Construct a named parameter with boolean values and units.

Parameters:

name - parameter name.

values - parameter values.

units - parameter units.

Parameter

public Parameter(java.lang.String name,
         int[] values,
         java.lang.String units)

Construct a named parameter with int values and units.

Parameters:

name - parameter name.

values - parameter values.

units - parameter units.

Parameter

public Parameter(java.lang.String name,
         long[] values,
         java.lang.String units)

Construct a named parameter with long values and units.

Parameters:

name - parameter name.

values - parameter values.

units - parameter units.

Parameter

public Parameter(java.lang.String name,
         float[] values,
         java.lang.String units)

Construct a named parameter with float values and units.

Parameters:

name - parameter name.

values - parameter values.

units - parameter units.

Parameter

public Parameter(java.lang.String name,
         double[] values,
         java.lang.String units)

Construct a named parameter with double values and units.

Parameters:

name - parameter name.

values - parameter values.

units - parameter units.

Parameter

public Parameter(java.lang.String name,
         java.lang.String[] values,
         java.lang.String units)

Construct a named parameter with String values and units.

Parameters:

name - parameter name.

values - parameter values.

units - parameter units.

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone this parameter. The clone will be an orphan; its parent parameter set will be null.

Overrides:

clone in class java.lang.Object

Returns:

a clone of this parameter.

Throws:

java.lang.CloneNotSupportedException

replaceWith

public Parameter replaceWith(Parameter par)

Replace the contents of this parameter with a copy of the contents of the specified parameter. Do not change this parameter's parent.

Parameters:

par - the parameter with contents that will replace those in this parameter.

Returns:

this parameter, with contents replaced.

copyTo

public Parameter copyTo(ParameterSet parent)

Copy this parameter to the specified parent parameter set without changing its name.

Parameters:

parent - the parameter set into which to copy this parameter; the parent of the destination parameter. If the parent is null, the destination parameter will be an orphan.

Returns:

the destination parameter.

copyTo

public Parameter copyTo(ParameterSet parent,
               java.lang.String name)

Copy this parameter.to the specified parent parameter set while changing its name.

Parameters:

parent - the parameter set into which to copy this parameter; the parent of the destination parameter. If the parent is null, the destination parameter will be an orphan.

name - the destination parameter name.

Returns:

the destination parameter.

moveTo

public Parameter moveTo(ParameterSet parent)

Move this parameter to the specified parent parameter set without changing its name.

Parameters:

parent - the parameter set into which to move this parameter; the parent of the destination parameter. If the parent is null, the destination parameter will be an orphan.

Returns:

the destination parameter.

moveTo

public Parameter moveTo(ParameterSet parent,
               java.lang.String name)

Move this parameter to the specified parent parameter set while changing its name.

Parameters:

parent - the parameter set into which to move this parameter; the parent of the destination parameter. If the parent is null, the destination parameter will be an orphan.

name - the destination parameter name.

Returns:

the destination parameter.

remove

public void remove()

Remove this parameter from its parent parameter set. In other words, orphan this parameter. If this parameter is already an orphan, do nothing.

getName

public java.lang.String getName()

Get the parameter name.

Returns:

parameter name.

setName

public void setName(java.lang.String name)

Set the parameter name.

Parameters:

name - parameter name. If the parameter has a parent parameter set, ignore a null name.

getUnits

public java.lang.String getUnits()

Get the parameter units.

Returns:

parameter units; null, if the parameter has no units.

setUnits

public void setUnits(java.lang.String units)

Set the parameter units.

Parameters:

units - parameter units. For no units, specify null.

getType

public int getType()

Get the parameter type.

Returns:

parameter type.

setType

public void setType(int type)

Set the parameter type. To specify a null (empty) parameter value, set its type to null.

Parameters:

type - parameter type.

Throws:

ParameterConvertException - if any of the parameter values cannot be converted to the specified type.

getParent

public ParameterSet getParent()

Get the parameter set that contains this parameter.

Returns:

parent parameter set; null, if the parameter has no parent, because it was orphaned by removing it from its parent.

getBoolean

public boolean getBoolean()
                   throws ParameterConvertException

Get parameter value as boolean. If the parameter contains an array of values, get the last value.

Returns:

parameter value.

Throws:

ParameterConvertException - if the parameter value cannot be converted to boolean.

getInt

public int getInt()
           throws ParameterConvertException

Get parameter value as int. If the parameter contains an array of values, get the last value.

Returns:

parameter value.

Throws:

ParameterConvertException - if the parameter value cannot be converted to int.

getLong

public long getLong()
             throws ParameterConvertException

Get parameter value as long. If the parameter contains an array of values, get the last value.

Returns:

parameter value.

Throws:

ParameterConvertException - if the parameter value cannot be converted to long.

getFloat

public float getFloat()
               throws ParameterConvertException

Get parameter value as float. If the parameter contains an array of values, get the last value.

Returns:

parameter value.

Throws:

ParameterConvertException - if the parameter value cannot be converted to float.

getDouble

public double getDouble()
                 throws ParameterConvertException

Get parameter value as double. If the parameter contains an array of values, get the last value.

Returns:

parameter value.

Throws:

ParameterConvertException - if the parameter value cannot be converted to double.

getString

public java.lang.String getString()
                           throws ParameterConvertException

Get parameter value as String. If the parameter contains an array of values, get the last value.

Returns:

parameter value.

Throws:

ParameterConvertException - if the parameter value cannot be converted to String.

getBooleans

public boolean[] getBooleans()
                      throws ParameterConvertException

Get parameter values as array of booleans.

Returns:

parameter values.

Throws:

ParameterConvertException - if any of the parameter values cannot be converted to boolean.

getInts

public int[] getInts()
              throws ParameterConvertException

Get parameter values as array of ints.

Returns:

parameter values.

Throws:

ParameterConvertException - if any of the parameter values cannot be converted to int.

getLongs

public long[] getLongs()
                throws ParameterConvertException

Get parameter values as array of longs.

Returns:

parameter values.

Throws:

ParameterConvertException - if any of the parameter values cannot be converted to long.

getFloats

public float[] getFloats()
                  throws ParameterConvertException

Get parameter values as array of floats.

Returns:

parameter values.

Throws:

ParameterConvertException - if any of the parameter values cannot be converted to float.

getDoubles

public double[] getDoubles()
                    throws ParameterConvertException

Get parameter values as array of doubles.

Returns:

parameter values.

Throws:

ParameterConvertException - if any of the parameter values cannot be converted to double.

getStrings

public java.lang.String[] getStrings()
                              throws ParameterConvertException

Get parameter values as array of Strings.

Returns:

parameter values.

Throws:

ParameterConvertException - if any of the parameter values cannot be converted to String.

setBoolean

public void setBoolean(boolean value)

Set parameter value as boolean.

Parameters:

value - parameter value.

setInt

public void setInt(int value)

Set parameter value as int.

Parameters:

value - parameter value.

setLong

public void setLong(long value)

Set parameter value as long.

Parameters:

value - parameter value.

setFloat

public void setFloat(float value)

Set parameter value as float.

Parameters:

value - parameter value.

setDouble

public void setDouble(double value)

Set parameter value as double.

Parameters:

value - parameter value.

setString

public void setString(java.lang.String value)

Set parameter value as String.

Parameters:

value - parameter value.

setBooleans

public void setBooleans(boolean[] values)

Set parameter values as an array of booleans.

Parameters:

values - parameter values.

setInts

public void setInts(int[] values)

Set parameter values as an array of ints.

Parameters:

values - parameter values.

setLongs

public void setLongs(long[] values)

Set parameter values as an array of longs.

Parameters:

values - parameter values.

setFloats

public void setFloats(float[] values)

Set parameter values as an array of floats.

Parameters:

values - parameter values.

setDoubles

public void setDoubles(double[] values)

Set parameter values as an array of doubles.

Parameters:

values - parameter values.

setStrings

public void setStrings(java.lang.String[] values)

Set parameter values as an array of Strings.

Parameters:

values - parameter values.

isNull

public boolean isNull()

Tests if parameter type is null.

Returns:

true, if parameter type is null; false, otherwise.

isBoolean

public boolean isBoolean()

Tests if parameter type is boolean.

Returns:

true, if parameter type is boolean; false, otherwise.

isInt

public boolean isInt()

Tests if parameter type is int.

Returns:

true, if parameter type is int; false, otherwise.

isLong

public boolean isLong()

Tests if parameter type is long.

Returns:

true, if parameter type is long; false, otherwise.

isFloat

public boolean isFloat()

Tests if parameter type is float.

Returns:

true, if parameter type is float; false, otherwise.

isDouble

public boolean isDouble()

Tests if parameter type is double.

Returns:

true, if parameter type is double; false, otherwise.

isString

public boolean isString()

Tests if parameter type is String.

Returns:

true, if parameter type is String; false, otherwise.

toString

public java.lang.String toString()

Get a string representation of this parameter. This XML-formatted string represents the parameter name, type, (optional) units and value(s).

Overrides:

toString in class java.lang.Object

Returns:

string representation of this parameter.

equals

public boolean equals(java.lang.Object o)

Compares two parameters for equality. Parameters are equal if their names, units, types, and values are equal.

Overrides:

equals in class java.lang.Object

Returns:

true, if the parameters are equal; false, otherwise.

hashCode

public int hashCode()

Computes the hash code of this paramater. The hash code depends on the parameter name, units, type, and values.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code.