org.opengis.parameter
Interface ParameterDescriptorGroup
- All Superinterfaces:
- GeneralParameterDescriptor, IdentifiedObject
- All Known Implementing Classes:
- DefaultParameterDescriptorGroup, ImagingParameterDescriptors, MatrixParameterDescriptors, MatrixParameters
@UML(identifier="CC_OperationParameterGroup",
specification=ISO_19111)
public interface ParameterDescriptorGroup
- extends GeneralParameterDescriptor
The definition of a group of related parameters used by an operation method.
- Since:
- GeoAPI 2.0
- Author:
- Martin Desruisseaux (IRD), Jody Garnett (Refractions Research)
- See Also:
ParameterValueGroup
,
ParameterDescriptor
createValue
@Extension
ParameterValueGroup createValue()
- Creates a new instance of parameter value group
initialized with the default values.
The parameter value descriptor
for the created group will be
this
object.
The number of ParameterValue
objects included must be between the
minimum and
maximum occurences required.
For example:
- Specified by:
createValue
in interface GeneralParameterDescriptor
- Returns:
- A new parameter instance initialized to the default value.
descriptors
@UML(identifier="includesParameter",
obligation=MANDATORY,
specification=ISO_19111)
List<GeneralParameterDescriptor> descriptors()
- Returns the parameters in this group.
- Returns:
- The descriptor of this group.
descriptor
@Extension
GeneralParameterDescriptor descriptor(String name)
throws ParameterNotFoundException
- Returns the parameter descriptor in this group for the specified
identifier code.
- Parameters:
name
- The case insensitive identifier code of the
parameter to search for.
- Returns:
- The parameter for the given identifier code.
- Throws:
ParameterNotFoundException
- if there is no parameter for the given identifier code.
Copyright © 1996-2014 Geotools. All Rights Reserved.