org.geotools.parameter
Class Parameter

Object
  Formattable
      AbstractParameter
          Parameter

All Implemented Interfaces:

Serializable, Cloneable, GeneralParameterValue, ParameterValue

Direct Known Subclasses:

WMSParameterValue

public class Parameter
extends AbstractParameter
implements ParameterValue

A parameter value used by an operation method. Most CRS parameter values are numeric, but other types of parameter values are possible. The parameter type can be fetch with the getValue().getClass() idiom. The getValue() and setValue(Object) methods can be invoked at any time. Others getters and setters are parameter-type dependents.

Since:

2.1

Author:

Martin Desruisseaux, Jody Garnett (Refractions Research)

See Also:

DefaultParameterDescriptor, ParameterGroup, Serialized Form

Module:

modules/library/referencing (gt2-referencing.jar) (Maven report) (SVN head)

Constructor Summary

Parameter(ParameterDescriptor descriptor)
Constructs a parameter value from the specified descriptor.

Parameter(ParameterDescriptor descriptor, Object value)
Constructs a parameter value from the specified descriptor and value.

Parameter(String name, CodeList value)
Constructs a parameter from the specified enumeration.

Parameter(String name, double value, Unit unit)
Constructs a parameter from the specified name and value.

Parameter(String name, int value)
Constructs a parameter from the specified name and value.

Method Summary

boolean	booleanValue() Returns the boolean value of an operation parameter.
double	doubleValue() Returns the numeric value of the coordinate operation parameter with its associated unit of measure.
double	doubleValue(Unit unit) Returns the numeric value of the coordinate operation parameter in the specified unit of measure.
double[]	doubleValueList() Returns an ordered sequence of two or more numeric values of an operation parameter list, where each value has the same associated unit of measure.
double[]	doubleValueList(Unit unit) Returns an ordered sequence of numeric values in the specified unit of measure.
static void	ensureValidValue(ParameterDescriptor descriptor, Object value) Ensures that the given value is valid according the specified parameter descriptor.
boolean	equals(Object object) Compares the specified object with this parameter for equality.
Unit	getUnit() Returns the unit of measure of the parameter value.
Object	getValue() Returns the parameter value as an object.
int	hashCode() Returns a hash value for this parameter.
int	intValue() Returns the positive integer value of an operation parameter, usually used for a count.
int[]	intValueList() Returns an ordered sequence of two or more integer values of an operation parameter list, usually used for counts.
void	setValue(boolean value) Set the parameter value as a boolean.
void	setValue(double value) Set the parameter value as a floating point.
void	setValue(double[] values, Unit unit) Set the parameter value as an array of floating point and their associated unit.
void	setValue(double value, Unit unit) Set the parameter value as a floating point and its associated unit.
void	setValue(int value) Set the parameter value as an integer.
void	setValue(Object value) Set the parameter value as an object.
String	stringValue() Returns the string value of an operation parameter.
URI	valueFile() Returns a reference to a file or a part of a file containing one or more parameter values.

Methods inherited from class AbstractParameter

clone, formatWKT, getDescriptor, toString, write

Methods inherited from class Formattable

toWKT, toWKT, toWKT

Methods inherited from class Object

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

Methods inherited from interface ParameterValue

clone

Methods inherited from interface GeneralParameterValue

getDescriptor

Constructor Detail

Parameter

public Parameter(String name,
                 int value)

Constructs a parameter from the specified name and value. This convenience constructor creates a DefaultParameterDescriptor object. But if such an object was available, then the preferred way to get a ParameterValue is to invokes GeneralParameterDescriptor.createValue().

Parameters:

name - The parameter name.

value - The parameter value.

Parameter

public Parameter(String name,
                 double value,
                 Unit unit)

Constructs a parameter from the specified name and value. This convenience constructor creates a DefaultParameterDescriptor object. But if such an object was available, then the preferred way to get a ParameterValue is to invokes GeneralParameterDescriptor.createValue().

Parameters:

name - The parameter name.

value - The parameter value.

unit - The unit for the parameter value.

Parameter

public Parameter(String name,
                 CodeList value)

Constructs a parameter from the specified enumeration. This convenience constructor creates a DefaultParameterDescriptor object. But if such an object was available, then the preferred way to get a ParameterValue is to invokes GeneralParameterDescriptor.createValue().

Parameters:

name - The parameter name.

value - The parameter value.

Parameter

public Parameter(ParameterDescriptor descriptor)

Constructs a parameter value from the specified descriptor. The value will be initialized to the default value, if any.

Parameters:

descriptor - The abstract definition of this parameter.

Parameter

public Parameter(ParameterDescriptor descriptor,
                 Object value)
          throws InvalidParameterValueException

Constructs a parameter value from the specified descriptor and value.

Parameters:

descriptor - The abstract definition of this parameter.

value - The parameter value.

Throws:

InvalidParameterValueException - if the type of value is inappropriate for this parameter, or if the value is illegal for some other reason (for example the value is numeric and out of range).

Method Detail

ensureValidValue

public static void ensureValidValue(ParameterDescriptor descriptor,
                                    Object value)
                             throws InvalidParameterValueException

Ensures that the given value is valid according the specified parameter descriptor. This convenience method ensures that value is assignable to the expected class, is between the minimum and maximum values and is one of the set of valid values. If the value fails any of those tests, then an exception is thrown.

Parameters:

descriptor - The parameter descriptor to check against.

value - The value to check, or null.

Throws:

InvalidParameterValueException - if the parameter value is invalid.

getUnit

public Unit getUnit()

Returns the unit of measure of the parameter value. If the parameter value has no unit (for example because it is a String type), then this method returns null. Note that "no unit" doesn't means "dimensionless".

Specified by:

getUnit in interface ParameterValue

Returns:

The unit of measure, or null if none.

See Also:

doubleValue(), doubleValueList(), getValue()

doubleValue

public double doubleValue(Unit unit)
                   throws InvalidParameterTypeException

Returns the numeric value of the coordinate operation parameter in the specified unit of measure. This convenience method apply unit conversion on the fly as needed.

Specified by:

doubleValue in interface ParameterValue

Parameters:

unit - The unit of measure for the value to be returned.

Returns:

The numeric value represented by this parameter after conversion to type double and conversion to unit.

Throws:

InvalidParameterTypeException - if the value is not a numeric type.

IllegalArgumentException - if the specified unit is invalid for this parameter.

See Also:

getUnit(), setValue(double,Unit), doubleValueList(Unit)

doubleValue

public double doubleValue()
                   throws InvalidParameterTypeException

Returns the numeric value of the coordinate operation parameter with its associated unit of measure.

Specified by:

doubleValue in interface ParameterValue

Returns:

The numeric value represented by this parameter after conversion to type double.

Throws:

InvalidParameterTypeException - if the value is not a numeric type.

See Also:

getUnit(), setValue(double), doubleValueList()

intValue

public int intValue()
             throws InvalidParameterTypeException

Returns the positive integer value of an operation parameter, usually used for a count. An integer value does not have an associated unit of measure.

Specified by:

intValue in interface ParameterValue

Returns:

The numeric value represented by this parameter after conversion to type int.

Throws:

InvalidParameterTypeException - if the value is not an integer type.

See Also:

setValue(int), intValueList()

booleanValue

public boolean booleanValue()
                     throws InvalidParameterTypeException

Returns the boolean value of an operation parameter. A boolean value does not have an associated unit of measure.

Specified by:

booleanValue in interface ParameterValue

Returns:

The boolean value represented by this parameter.

Throws:

InvalidParameterTypeException - if the value is not a boolean type.

See Also:

setValue(boolean)

stringValue

public String stringValue()
                   throws InvalidParameterTypeException

Returns the string value of an operation parameter. A string value does not have an associated unit of measure.

Specified by:

stringValue in interface ParameterValue

Returns:

The string value represented by this parameter.

Throws:

InvalidParameterTypeException - if the value is not a string.

See Also:

getValue(), setValue(Object)

doubleValueList

public double[] doubleValueList(Unit unit)
                         throws InvalidParameterTypeException

Returns an ordered sequence of numeric values in the specified unit of measure. This convenience method apply unit conversion on the fly as needed.

Specified by:

doubleValueList in interface ParameterValue

Parameters:

unit - The unit of measure for the value to be returned.

Returns:

The sequence of values represented by this parameter after conversion to type double and conversion to unit.

Throws:

InvalidParameterTypeException - if the value is not an array of doubles.

IllegalArgumentException - if the specified unit is invalid for this parameter.

See Also:

getUnit(), setValue(double[],Unit), doubleValue(Unit)

doubleValueList

public double[] doubleValueList()
                         throws InvalidParameterTypeException

Returns an ordered sequence of two or more numeric values of an operation parameter list, where each value has the same associated unit of measure.

Specified by:

doubleValueList in interface ParameterValue

Returns:

The sequence of values represented by this parameter.

Throws:

InvalidParameterTypeException - if the value is not an array of doubles.

See Also:

getUnit(), setValue(Object), doubleValue()

intValueList

public int[] intValueList()
                   throws InvalidParameterTypeException

Returns an ordered sequence of two or more integer values of an operation parameter list, usually used for counts. These integer values do not have an associated unit of measure.

Specified by:

intValueList in interface ParameterValue

Returns:

The sequence of values represented by this parameter.

Throws:

InvalidParameterTypeException - if the value is not an array of ints.

See Also:

setValue(Object), intValue()

valueFile

public URI valueFile()
              throws InvalidParameterTypeException

Returns a reference to a file or a part of a file containing one or more parameter values. When referencing a part of a file, that file must contain multiple identified parts, such as an XML encoded document. Furthermore, the referenced file or part of a file can reference another part of the same or different files, as allowed in XML documents.

Specified by:

valueFile in interface ParameterValue

Returns:

The reference to a file containing parameter values.

Throws:

InvalidParameterTypeException - if the value is not a reference to a file or an URI.

See Also:

getValue(), setValue(Object)

getValue

public Object getValue()

Returns the parameter value as an object. The object type is typically a Double, Integer, Boolean, String, URI, double[] or int[].

Specified by:

getValue in interface ParameterValue

Returns:

The parameter value as an object.

See Also:

setValue(Object)

setValue

public void setValue(double value,
                     Unit unit)
              throws InvalidParameterValueException

Set the parameter value as a floating point and its associated unit.

Specified by:

setValue in interface ParameterValue

Parameters:

value - The parameter value.

unit - The unit for the specified value.

Throws:

InvalidParameterValueException - if the floating point type is inappropriate for this parameter, or if the value is illegal for some other reason (for example a value out of range).

See Also:

setValue(double), doubleValue(Unit)

setValue

public void setValue(double value)
              throws InvalidParameterValueException

Set the parameter value as a floating point. The unit, if any, stay unchanged.

Specified by:

setValue in interface ParameterValue

Parameters:

value - The parameter value.

Throws:

InvalidParameterValueException - if the floating point type is inappropriate for this parameter, or if the value is illegal for some other reason (for example a value out of range).

See Also:

setValue(double,Unit), doubleValue()

setValue

public void setValue(int value)
              throws InvalidParameterValueException

Set the parameter value as an integer.

Specified by:

setValue in interface ParameterValue

Parameters:

value - The parameter value.

Throws:

InvalidParameterValueException - if the integer type is inappropriate for this parameter, or if the value is illegal for some other reason (for example a value out of range).

See Also:

intValue()

setValue

public void setValue(boolean value)
              throws InvalidParameterValueException

Set the parameter value as a boolean.

Specified by:

setValue in interface ParameterValue

Parameters:

value - The parameter value.

Throws:

InvalidParameterValueException - if the boolean type is inappropriate for this parameter.

See Also:

booleanValue()

setValue

public void setValue(Object value)
              throws InvalidParameterValueException

Set the parameter value as an object. The object type is typically a Double, Integer, Boolean, String, URI, double[] or int[].

Specified by:

setValue in interface ParameterValue

Parameters:

value - The parameter value.

Throws:

InvalidParameterValueException - if the type of value is inappropriate for this parameter, or if the value is illegal for some other reason (for example the value is numeric and out of range).

See Also:

getValue()

setValue

public void setValue(double[] values,
                     Unit unit)
              throws InvalidParameterValueException

Set the parameter value as an array of floating point and their associated unit.

Specified by:

setValue in interface ParameterValue

Parameters:

values - The parameter values.

unit - The unit for the specified value.

Throws:

InvalidParameterValueException - if the floating point type is inappropriate for this parameter, or if the value is illegal for some other reason (for example a value out of range).

equals

public boolean equals(Object object)

Compares the specified object with this parameter for equality.

Overrides:

equals in class AbstractParameter

Parameters:

object - The object to compare to this.

Returns:

true if both objects are equal.

hashCode

public int hashCode()

Returns a hash value for this parameter.

Overrides:

hashCode in class AbstractParameter

Returns:

The hash code value. This value doesn't need to be the same in past or future versions of this class.