Package org.geotoolkit.parameter

Parameter descriptor and parameter value implementations.

See:
Description

Class Summary

AbstractParameter	The root class of ParameterValue and ParameterValueGroup implementations.
AbstractParameterDescriptor	The root class of ParameterDescriptor and ParameterDescriptorGroup implementations.
AbstractParameterValue<T>	The base class of ParameterValue implementations.
DefaultParameterDescriptor<T>	The definition of a parameter used by an operation method.
DefaultParameterDescriptorGroup	The definition of a group of related parameters used by an operation method.
FloatParameter	A parameter value as a floating point (double precision) number.
ImagingParameterDescriptors	Wraps a JAI's ParameterListDescriptor.
ImagingParameters	Wraps a JAI's ParameterList.
MatrixParameterDescriptors	A parameter group for Matrix elements.
MatrixParameters	The values for a group of matrix parameters.
Parameter<T>	A parameter value used by an operation method.
ParameterGroup	A group of related parameter values.
Parameters	Helper methods for working with the parameter API from org.opengis.parameter package.
ParameterWriter	Formats parameter descriptors or parameter values in a tabular format.

Package org.geotoolkit.parameter Description

Parameter descriptor and parameter value implementations. An explanation for this package is provided in the OpenGIS® javadoc. The remaining discussion on this page is specific to the Geotk implementation.

The starting point is often DefaultParameterDescriptorGroup. Operation implementations need to defines one. The following example creates a group of two parameters. The first parameter accepts integers ranging from 0 to 3 inclusive, with a default value of 2. The second parameter accepts real numbers ranging from 0 to 100 kilometres inclusive, with no default value:

// Creates the group of parameters named "MyOperation".
ParameterDescriptorGroup myOperation = new DefaultParameterDescriptorGroup("MyOperation",
        DefaultParameterDescriptor.create("dimension", 2, 0, 3),
        DefaultParameterDescriptor.create("distance", Double.NaN, 0, 100, SI.KILOMETER));

Operation usages typically invoke the ParameterDescriptorGroup.createValue() method on the above parameters instance, and fill the returned object with parameter values. Example:

ParameterValueGroup group = myOperation.createValue();
group.parameter("dimension").setValue(3);
group.parameter("distance").setValue(200.0, SI.METRE);

This Geotk package provides the following implementations:

• DefaultParameterDescriptorGroup for the general case.
• MatrixParameterDescriptors for matrix parameters, including the number of rows and columns. The total number of parameters in this group vary according the number of rows and columns.

Since:

2.0

Version:

3.20

Author:

Martin Desruisseaux (IRD, Geomatys)

Module:

referencing/geotk-referencing (download)