Module org.opengis.geoapi
Package org.opengis.parameter

Interface ParameterValue<T>

Type Parameters:
T - the type of parameter values.
All Superinterfaces:
GeneralParameterValue
All Known Implementing Classes:
SimpleParameter
@Classifier(UNION) @UML(identifier="CC_ParameterValue", specification=ISO_19111) public interface ParameterValue<T> extends GeneralParameterValue
A single parameter value used by an operation method. Most CRS parameter values are numeric and can be obtained by the intValue() or doubleValue() methods. But other types of parameter values are possible and can be handled by the more generic getValue() and setValue(Object) methods.

All xxxValue() methods in this interface are convenience methods converting the value from Object to some commonly used types. Those types are specified in ISO 19111 as an union of attributes, listed below with the corresponding getter and setter methods:

Common value types
ISO attribute Java type Getter method Setter method
Object getValue() setValue(Object)
stringValue String stringValue() setValue(Object)
value double doubleValue() setValue(double)
double doubleValue(Unit) setValue(double, Unit)
valueList double[] doubleValueList() setValue(Object)
double[] doubleValueList(Unit) setValue(double[], Unit)
integerValue int intValue() setValue(int)
integerValueList int[] intValueList() setValue(Object)
booleanValue boolean booleanValue() setValue(boolean)
valueFile URI valueFile() setValue(Object)
valueFileCitation Citation getValue() setValue(Object)
The type and constraints on parameter values are given by the descriptor, Instances of ParameterValue are created by the ParameterDescriptor.createValue() method.
Since:
1.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    booleanValue()
    Returns the boolean value of this parameter.
    ParameterValue<T>
    clone()
    Returns a copy of this parameter value.
    double
    doubleValue()
    Returns the numeric value of this operation parameter.
    double
    doubleValue(Unit<?> unit)
    Returns the numeric value of this parameter in the specified unit of measure.
    double[]
    doubleValueList()
    Returns an ordered sequence of two or more numeric values of this parameter, 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.
    ParameterDescriptor<T>
    getDescriptor()
    Returns the abstract definition of this parameter value.
    Unit<?>
    getUnit()
    Returns the unit of measure of the parameter value.
    T
    getValue()
    Returns the parameter value as an object.
    int
    intValue()
    Returns the integer value of this parameter, usually used for a count.
    int[]
    intValueList()
    Returns an ordered sequence of two or more integer values of this parameter, usually used for counts.
    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 value as a floating point 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 value of this parameter.
    URI
    valueFile()
    Returns a reference to a file or a part of a file containing one or more parameter values.