Module org.opengis.geoapi
Package org.opengis.parameter

Interface GeneralParameterDescriptor

All Superinterfaces:
IdentifiedObject
All Known Subinterfaces:
ParameterDescriptor<T>, ParameterDescriptorGroup
@UML(identifier="CC_GeneralOperationParameter", specification=ISO_19111) public interface GeneralParameterDescriptor extends IdentifiedObject
Abstract definition of a parameter or group of parameters used by an operation method.
Since:
2.0
See Also:
Departure from OGC/ISO abstract specification:
Change of name without change in functionality GeoAPI uses a name which contains the "Descriptor" word for consistency with other libraries in Java (e.g. ParameterListDescriptor in Java Advanced Imaging).

  • Method Details

    • createValue

      GeneralParameterValue createValue()
      Creates a new instance of parameter value or group initialized with the default value(s). The parameter value descriptor for the created parameter value(s) will be this object.
      Returns:
      A new parameter initialized to its default value.
      Departure from OGC/ISO abstract specification:
      Addition of element not in the ISO/OGC specification This method is not part of the ISO specification. It is provided in GeoAPI as a kind of factory method.

    • getMinimumOccurs

      @UML(identifier="minimumOccurs", obligation=OPTIONAL, specification=ISO_19111) int getMinimumOccurs()
      The minimum number of times that values for this parameter group or parameter are required. The default value is one. A value of 0 means an optional parameter.
      Returns:
      The minimum occurrence.
      See Also:

    • getMaximumOccurs

      @UML(identifier="CC_OperationParameterGroup.maximumOccurs", obligation=OPTIONAL, specification=ISO_19111) int getMaximumOccurs()
      The maximum number of times that values for this parameter group or parameter can be included. For a single parameter, the value is always 1. For a parameter group, it may vary. The default value is one.
      Returns:
      The maximum occurrence.
      See Also:
      Departure from OGC/ISO abstract specification:
      Generalization by relaxation of ISO/OGC restriction Moved up (in the interface hierarchy) the maximumOccurs method from ParameterDescriptorGroup into this super-interface, for parallelism with the minimumOccurs method.