Package org.opengis.parameter

Description and storage of parameter values.

See: Description

Interface Summary

Interface	Description
GeneralParameterDescriptor	Abstract definition of a parameter or group of parameters used by an operation method.
GeneralParameterValue	Abstract parameter value or group of parameter values.
ParameterDescriptor<T>	The definition of a parameter used by an operation method.
ParameterDescriptorGroup	The definition of a group of related parameters used by an operation method.
ParameterValue<T>	A parameter value used by an operation method.
ParameterValueGroup	A group of related parameter values.

Exception Summary

Exception	Description
InvalidParameterCardinalityException	Thrown by ParameterValueGroup if adding or removing a parameter value would result in more or less parameters than the expected range.
InvalidParameterNameException	Thrown when an unexpected parameter was found in a parameter group.
InvalidParameterTypeException	Thrown by ParameterValue getter methods when a value can not be casted to the requested type.
InvalidParameterValueException	Thrown by ParameterValue setter methods when they are given an invalid value.
ParameterNotFoundException	Thrown by ParameterValueGroup and ParameterDescriptorGroup when a parameter is requested but not found in that group.

Package org.opengis.parameter Description

Description and storage of parameter values. The first two paragraphs below are adapted from OpenGIS® Spatial Referencing by Coordinates (Topic 2) specification.

Most parameter values are numeric, but for some operation methods, notably those implementing a grid interpolation algorithm, the parameter value could be a file name and location (this may be a URI). An example is the coordinate transformation from NAD 27 to NAD 83 in the USA; depending on the locations of the points to be transformed, one of a series of grid files should be used.

Some operation methods may require a large number of coordinate operation parameters. Also, some operation methods require that groups of parameters be repeatable as a group. In such cases, it is helpful to group related parameters in parameter groups. Two or more parameter groups are then associated with a particular operation method, and each parameter group consists of a set of operation parameters, or other, nested parameter groups. This way of modeling is not mandatory; all coordinate operation parameters may be assigned directly to the coordinate operation method.

Since:

1.0

Departure from OGC/ISO specification:
Moved the GeneralParameterDescriptor, ParameterDescriptor, ParameterDescriptorGroup, GeneralParameterValue, ParameterValue, ParameterValueGroup, InvalidParameterNameException, InvalidParameterTypeException and InvalidParameterValueException interfaces from org.opengis.referencing.operation to org.opengis.parameter. With this move, GeoAPI has extended the use of these parameter classes to a more general use rather than only for referencing operation types.