Module org.opengis.geoapi

Package org.opengis.parameter

Interface ParameterDescriptorGroup

All Superinterfaces:

GeneralParameterDescriptor, IdentifiedObject

@UML(identifier="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 standard in the name

GeoAPI uses a name which contains the "Descriptor" word for consistency with other libraries in Java (e.g. ParameterListDescriptor in Java Advanced Imaging).

Field Summary

Fields inherited from interface org.opengis.referencing.IdentifiedObject

ALIAS_KEY, DOMAINS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Method Summary

Modifier and Type	Method	Description
ParameterValueGroup	createValue()	Creates a new instance of parameter value group initialized with the default values.
GeneralParameterDescriptor	descriptor(String name)	Returns the parameter descriptor in this group for the specified identifier code.
List<GeneralParameterDescriptor>	descriptors()	Returns the parameters in this group.

Methods inherited from interface org.opengis.parameter.GeneralParameterDescriptor

getDescription, getDirection, getMaximumOccurs, getMinimumOccurs, getName

Methods inherited from interface org.opengis.referencing.IdentifiedObject

getAlias, getDomains, getIdentifiers, getRemarks, toWKT

Method Details

descriptors

@UML(identifier="parameter",
     obligation=MANDATORY,
     specification=ISO_19111)
List<GeneralParameterDescriptor> descriptors()

Returns the parameters in this group.

Returns:

the parameter descriptors in 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.

See Also:

• Identifier.getCode()

Convenience extension to OGC/ISO standard

This method is not part of the ISO specification. It has been added in an attempt to make this interface easier to use.

createValue

ParameterValueGroup createValue()

Creates a new instance of parameter value group initialized with the default values. While not a requirement, the parameter value descriptor for the created group will typically be this descriptor instance.

The number of ParameterValue objects included must be between the minimum and maximum occurrences required. For example:

• For ParameterDescriptor with multiplicity 1:* a ParameterValue will be included with the default value (even if this default value is null).
• For ParameterDescriptor with multiplicity 0:* no entry is required. ParameterValue entries may be created only as needed.

Specified by:

createValue in interface GeneralParameterDescriptor

Returns:

a new parameter instance initialized to the default value.

See Also:

• ParameterDescriptor.getDefaultValue()

Extension to OGC/ISO standard

This method is not part of the ISO specification. It is provided in GeoAPI as a kind of factory method.