GeneralParameterDescriptor (Geotools modules 31-SNAPSHOT API)

All Superinterfaces:

IdentifiedObject

All Known Subinterfaces:

ParameterDescriptor<T>, ParameterDescriptorGroup

All Known Implementing Classes:

AbstractParameterDescriptor, DefaultParameterDescriptor, DefaultParameterDescriptorGroup, ExtendedImagingParameterDescriptors, ImagingParameterDescriptors, MatrixParameterDescriptors, MatrixParameters
```
public interface GeneralParameterDescriptor
extends IdentifiedObject
```
Abstract definition of a parameter or group of parameters used by an operation method.

Since:

GeoAPI 2.0

Author:

Martin Desruisseaux (IRD), Jody Garnett (Refractions Research)

See Also:

GeneralParameterValue

Field Summary
- Fields inherited from interface IdentifiedObject
  ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`GeneralParameterValue`	`createValue()`	Creates a new instance of parameter value or group initialized with the default value(s).
`int`	`getMaximumOccurs()`	The maximum number of times that values for this parameter group or parameter can be included.
`int`	`getMinimumOccurs()`	The minimum number of times that values for this parameter group or parameter are required.

Methods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT

- Method Detail
  - 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.
  - getMinimumOccurs
```
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 occurence.
    
    See Also:
    
    getMaximumOccurs()
  - 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 occurence.
    
    See Also:
    
    getMinimumOccurs()