org.opengis.parameter
Interface ParameterDescriptorGroup
- All Superinterfaces:
- GeneralParameterDescriptor, IdentifiedObject
@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:
- 2.0
- See Also:
ParameterValueGroup
,
ParameterDescriptor
Departure from OGC/ISO specification:
GeoAPI uses a name which contains the "Descriptor
" word for consistency with other
libraries in Java (e.g. ParameterListDescriptor
in Java Advanced Imaging).
createValue
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.
Departure from OGC/ISO specification:
This method is not part of the ISO specification. It is provided in GeoAPI as a kind of
factory method.
descriptors
@UML(identifier="parameter",
obligation=MANDATORY,
specification=ISO_19111)
List<GeneralParameterDescriptor> descriptors()
- Returns the parameters in this group.
- Returns:
- The descriptor of this group.
descriptor
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.Departure from OGC/ISO specification:
This method is not part of the ISO specification. It has been added in an attempt to make
this interface easier to use.
Copyright © 1994-2011 Open Geospatial Consortium. All Rights Reserved.