Package org.geotools.api.parameter
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 modelling is not mandatory; all coordinate operation parameters may be assigned directly to the coordinate operation method.
- Since:
- GeoAPI 1.0
-
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.Parameter<T> General parameter interface.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 Throws if adding a parameter value to a group would result in more parameters than the maximum occurence allowed.InvalidParameterNameException Thrown when an unexpected parameter was found in a parameter group.InvalidParameterTypeException Thrown when a parameter can't be cast to the requested type.InvalidParameterValueException Thrown when an invalid value was given to a parameter.ParameterNotFoundException Thrown when a required parameter was not found in a parameter group.