Package org.opengis.example.parameter

Class SimpleParameter

Object

SimpleIdentifiedObject

SimpleParameter

All Implemented Interfaces:

Serializable, Cloneable, Identifier, GeneralParameterDescriptor, GeneralParameterValue, ParameterDescriptor<Double>, ParameterValue<Double>, IdentifiedObject, ReferenceIdentifier

public class SimpleParameter
extends SimpleIdentifiedObject
implements ParameterValue<Double>, ParameterDescriptor<Double>, Cloneable

A ParameterValue implementation for double values. In order to keep the conceptual model simpler, this parameter value is also its own descriptor. This is not quite a recommended practice (such descriptors are less suitable for use in HashMap), but allow us to keep the amount of classes smaller and closely related interfaces together.

For keeping things yet simpler, the value class is hard-coded as Double, the units of measurement are constrained to standard units (metres, decimal degrees or dimensionless) and we care only about descriptor properties (minimum, maximum, etc.) determined by our own SimpleParameter.Type enumeration. The only mutable property in this class is the numerical value.

The most interesting methods in this class are:

• SimpleIdentifiedObject.getName(), for the name of this parameter
• getUnit(), for the unit of measurement.
• getMinimumValue() and getMaximumValue(), for the range of valid values
• getValue(), doubleValue() and doubleValue(Unit), for the actual parameter value
• setValue(double), setValue(double, Unit) and setValue(Object), for setting the parameter value

Other methods can be ignored, since they are metadata or methods designed for parameter values of other kind than double. To be strict, all methods working with any value type other than double should throw an InvalidParameterTypeException. However this implementation is lenient.

Since:

3.1

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimpleParameter.Type	Determines the range of values and the unit of measurement of a parameter.

Field Summary

Fields

Modifier and Type	Field	Description
protected static boolean	LENIENT	Controls whatever this implementation can convert values between the double type and other types.
protected SimpleParameter.Type	type	The parameter type, which determines the range of values and the unit of measurement.
protected double	value	The parameter value.

Fields inherited from class SimpleIdentifiedObject

authority, code

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Fields inherited from interface Identifier

AUTHORITY_KEY, CODE_KEY, CODESPACE_KEY, DESCRIPTION_KEY, VERSION_KEY

Constructor Summary

Constructors

Constructor	Description
SimpleParameter(Citation authority, String name, SimpleParameter.Type type)	Creates a new parameter of the given authority and name.

Method Summary

Modifier and Type	Method	Description
boolean	booleanValue()	Returns the boolean value of an operation parameter.
SimpleParameter	clone()	Returns a copy of this parameter value.
SimpleParameter	createValue()	Returns a new parameter with the same authority, code and type than this parameter.
double	doubleValue()	Returns the numeric value represented by this parameter.
double	doubleValue(Unit<?> unit)	Returns the numeric value of the operation parameter in the specified unit of measure.
double[]	doubleValueList()	Returns an ordered sequence 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.
boolean	equals(Object object)	Compares the given object with this parameter for equality.
InternationalString	getDescription()	Returns a natural language description of this object.
ParameterDescriptor<Double>	getDescriptor()	Returns the descriptor of the parameter value.
ParameterDirection	getDirection()	Returns this, since this simple class is used only as input parameter.
Comparable<Double>	getMaximumValue()	Returns the maximum parameter value, or null if none.
Comparable<Double>	getMinimumValue()	Returns the minimum parameter value, or null if none.
Unit<?>	getUnit()	Returns the unit of measurement.
Double	getValue()	Returns the parameter value as an object.
Class<Double>	getValueClass()	Unconditionally returns Double.class, which is the hard-coded type of values in this parameter implementation.
int	hashCode()	Returns a hash code value for this parameter.
int	intValue()	Returns the integer value of an operation parameter, usually used for a count.
int[]	intValueList()	Returns an ordered sequence integer values of an operation parameter list.
void	setValue(boolean value)	Sets the parameter value as a boolean.
void	setValue(double value)	Sets the parameter value as a floating point.
void	setValue(double[] values, Unit<?> unit)	Sets the parameter value as an array of floating point and their associated unit.
void	setValue(double value, Unit<?> unit)	Sets the parameter to the given value and its associated unit.
void	setValue(int value)	Sets the parameter value as an integer.
void	setValue(Object value)	Sets the parameter value as an object.
String	stringValue()	Returns the string representation of an operation parameter value.
String	toString()	Returns the string representation of this parameter value.
URI	valueFile()	Thrown unconditionally the exception, since this parameter implementation can not represent URI.

Methods inherited from class SimpleIdentifiedObject

getAuthority, getCode, getCodeSpace, getDomainOfValidity, getName, getScope, toWKT

Methods inherited from class Object

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

Methods inherited from interface GeneralParameterDescriptor

getMaximumOccurs, getMinimumOccurs, getName

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getRemarks, toWKT

Methods inherited from interface Identifier

getVersion

Methods inherited from interface ParameterDescriptor

getDefaultValue, getValidValues

Field Detail

LENIENT

protected static final boolean LENIENT

Controls whatever this implementation can convert values between the double type and other types. If false, methods intValue(), intValueList(), doubleValueList(), booleanValue() and stringValue() - together with their setter companions - will always throw an InvalidParameterTypeException. If true, some conversions will be attempted.

This field is defined for two purposes:

• Developers may find convenient to set this field to false during debugging, since strict behavior often help to identify unexpected usage of parameters.
• This field make easy to spot the codes implementing a lenient behavior. Library implementors may want to remove such codes for making parameters definitively strict.

The current value is true.

See Also:

Constant Field Values

type

protected final SimpleParameter.Type type

The parameter type, which determines the range of values and the unit of measurement. This field can be null if the parameter type is none of the enumerated ones.

value

protected double value

The parameter value. This is the only mutable property of the SimpleParameter class.

See Also:

doubleValue(), setValue(double)

Constructor Detail

SimpleParameter

public SimpleParameter(Citation authority,
                       String name,
                       SimpleParameter.Type type)

Creates a new parameter of the given authority and name.

Parameters:

authority - organization responsible for definition of the parameter, or null.

name - the parameter name.

type - the parameter type, which determines the range of values and the unit of measurement. this argument can be null if the parameter type is none of the enumerated ones.

Method Detail

getDescriptor

public ParameterDescriptor<Double> getDescriptor()

Returns the descriptor of the parameter value. Since this simple class implements both the value and the descriptor interfaces, this method returns this. However more sophisticated libraries are likely to return a different object.

Specified by:

getDescriptor in interface GeneralParameterValue

Specified by:

getDescriptor in interface ParameterValue<Double>

getDescription

public InternationalString getDescription()

Returns a natural language description of this object. The default implementation returns null.

Specified by:

getDescription in interface GeneralParameterDescriptor

Specified by:

getDescription in interface Identifier

Returns:

the natural language description, or null if none.

getDirection

public ParameterDirection getDirection()

Returns this, since this simple class is used only as input parameter.

Specified by:

getDirection in interface GeneralParameterDescriptor

getValueClass

public Class<Double> getValueClass()

Unconditionally returns Double.class, which is the hard-coded type of values in this parameter implementation.

Specified by:

getValueClass in interface ParameterDescriptor<Double>

getUnit

public Unit<?> getUnit()

Returns the unit of measurement. Because this class implements both the value and descriptor interfaces, the unit of measurement applies to the parameter value as well as the default, the minimum and the maximum values.

Specified by:

getUnit in interface ParameterDescriptor<Double>

Specified by:

getUnit in interface ParameterValue<Double>

Returns:

the unit of measurement, or null if unknown.

getMinimumValue

public Comparable<Double> getMinimumValue()

Returns the minimum parameter value, or null if none. The default implementation infers this property from the type.

Specified by:

getMinimumValue in interface ParameterDescriptor<Double>

Returns:

the minimum parameter value, or null if unbounded.

getMaximumValue

public Comparable<Double> getMaximumValue()

Returns the maximum parameter value, or null if none. The default implementation infers this property from the type.

Specified by:

getMaximumValue in interface ParameterDescriptor<Double>

Returns:

the maximum parameter value, or null if unbounded.

getValue

public Double getValue()

Returns the parameter value as an object.

Specified by:

getValue in interface ParameterValue<Double>

Returns:

the parameter value as an object.

doubleValue

public double doubleValue()

Returns the numeric value represented by this parameter.

Specified by:

doubleValue in interface ParameterValue<Double>

Returns:

the numeric value represented by this parameter.

doubleValue

public double doubleValue(Unit<?> unit)
                   throws IllegalArgumentException,
                          IllegalStateException

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

Specified by:

doubleValue in interface ParameterValue<Double>

Parameters:

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

Returns:

the numeric value represented by this parameter after conversion to unit.

Throws:

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

IllegalStateException - if there is no unit associated to this parameter value.

intValue

public int intValue()
             throws InvalidParameterTypeException

Returns the integer value of an operation parameter, usually used for a count. If lenient, this method returns the value casted to the int type only if this cast can be done without lost of information. In all other cases an exception is thrown.

Specified by:

intValue in interface ParameterValue<Double>

Returns:

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

Throws:

InvalidParameterTypeException - if the value can not be casted to an integer type.

booleanValue

public boolean booleanValue()
                     throws InvalidParameterTypeException

Returns the boolean value of an operation parameter. If lenient, this method makes the following choice:

• Returns false if the value is 0
• Returns true if the value is 1
• Throws an exception in all other cases

Specified by:

booleanValue in interface ParameterValue<Double>

Returns:

the boolean value represented by this parameter.

Throws:

InvalidParameterTypeException - if the value can not be converted to a boolean.

stringValue

public String stringValue()
                   throws InvalidParameterTypeException

Returns the string representation of an operation parameter value. If lenient, this method formats the value as a string and appends the units of measurement, if any.

Specified by:

stringValue in interface ParameterValue<Double>

Returns:

the numeric value and its units of measurement as a string.

Throws:

InvalidParameterTypeException - if the value can not be converted to a string.

See Also:

toString()

toString

public String toString()

Returns the string representation of this parameter value. The default implementation returns the concatenation of the identifier string, the " = " string, then the same string than the string value.

Overrides:

toString in class SimpleIdentifiedObject

See Also:

stringValue()

doubleValueList

public double[] doubleValueList(Unit<?> unit)
                         throws IllegalArgumentException,
                                IllegalStateException

Returns an ordered sequence of numeric values in the specified unit of measure. If lenient, this method returns doubleValue(Unit) in an array of length 1.

Specified by:

doubleValueList in interface ParameterValue<Double>

Throws:

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

IllegalStateException - if there is no unit associated to this parameter value.

InvalidParameterTypeException - if the value can not be converted to an array.

doubleValueList

public double[] doubleValueList()
                         throws InvalidParameterTypeException

Returns an ordered sequence numeric values of an operation parameter list, where each value has the same associated unit of measure. If lenient, this method returns doubleValue() in an array of length 1.

Specified by:

doubleValueList in interface ParameterValue<Double>

Returns:

the sequence of values represented by this parameter.

Throws:

InvalidParameterTypeException - if the value can not be converted to an array.

intValueList

public int[] intValueList()
                   throws InvalidParameterTypeException

Returns an ordered sequence integer values of an operation parameter list. If lenient, this method returns intValue() in an array of length 1.

Specified by:

intValueList in interface ParameterValue<Double>

Returns:

the sequence of values represented by this parameter.

Throws:

InvalidParameterTypeException - if the value can not be converted to an array.

valueFile

public URI valueFile()
              throws InvalidParameterTypeException

Thrown unconditionally the exception, since this parameter implementation can not represent URI.

Specified by:

valueFile in interface ParameterValue<Double>

Returns:

never returned.

Throws:

InvalidParameterTypeException - Always thrown.

setValue

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

Sets the parameter to the given value and its associated unit. The default implementation converts the given value to the units associated to this parameter, then delegates to setValue(double).

Specified by:

setValue in interface ParameterValue<Double>

Parameters:

value - the parameter value.

unit - the unit for the specified value.

Throws:

InvalidParameterValueException - if this parameter can not be set to the given value.

setValue

public void setValue(double value)
              throws InvalidParameterValueException

Sets the parameter value as a floating point. This method ensures that the given value is inside the range of valid values, then assign the new value to the value field.

Specified by:

setValue in interface ParameterValue<Double>

Throws:

InvalidParameterValueException - if the parameter value is out of range.

setValue

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

Sets the parameter value as an array of floating point and their associated unit. If lenient, this method ensures that the array length is exactly 1, then delegates to setValue(double, Unit).

Specified by:

setValue in interface ParameterValue<Double>

Parameters:

values - the parameter values.

unit - the unit for the specified values.

Throws:

InvalidParameterValueException - if this parameter can not be set to the given value.

setValue

public void setValue(int value)
              throws InvalidParameterValueException

Sets the parameter value as an integer. If lenient, this method delegates to setValue(double).

Specified by:

setValue in interface ParameterValue<Double>

Throws:

InvalidParameterValueException - if this parameter can not be set to the given value.

setValue

public void setValue(boolean value)
              throws InvalidParameterValueException

Sets the parameter value as a boolean. If lenient, the boolean value true is stored as the numeric value 1 and the boolean value false is stored as the numeric value 0.

Specified by:

setValue in interface ParameterValue<Double>

Throws:

InvalidParameterValueException - if this parameter can not be set to the given value.

setValue

public void setValue(Object value)
              throws InvalidParameterValueException

Sets the parameter value as an object. If lenient, then the object type can be any Number or CharSequence parseable as a floating point number. If not lenient, then the type must be restricted to Double.

Specified by:

setValue in interface ParameterValue<Double>

Parameters:

value - the parameter value.

Throws:

InvalidParameterValueException - if the value can not be stored as a double.

createValue

public SimpleParameter createValue()

Returns a new parameter with the same authority, code and type than this parameter. The value is left to their default value.

Implementation note: Since this simple class implements both the value and the descriptor interfaces, this method is very similar to the clone() method. However in more sophisticated libraries, the ParameterDescriptor.createValue() and ParameterValue.clone() methods are likely to be defined in different objects.

Specified by:

createValue in interface GeneralParameterDescriptor

Specified by:

createValue in interface ParameterDescriptor<Double>

Returns:

a new parameter with the same authority, code and type than this parameter.

See Also:

clone()

clone

public SimpleParameter clone()

Returns a copy of this parameter value. This method is similar to createValue() except for the following:

• This method returns an instance of the same class.
• The value is initialized to the same value than the cloned parameter.

Specified by:

clone in interface GeneralParameterValue

Specified by:

clone in interface ParameterValue<Double>

Overrides:

clone in class Object

See Also:

createValue()

equals

public boolean equals(Object object)

Compares the given object with this parameter for equality.

Overrides:

equals in class SimpleIdentifiedObject

Parameters:

object - the object to compare with this SimpleIdentifiedObject.

Returns:

true if the given object is equals to this object.

hashCode

public int hashCode()

Returns a hash code value for this parameter.

Overrides:

hashCode in class SimpleIdentifiedObject