T
- The type of parameter values.@UML(identifier="CC_OperationParameter", specification=ISO_19111) public interface ParameterDescriptor<T> extends GeneralParameterDescriptor
ParameterValue
,
ParameterDescriptorGroup
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).
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
Modifier and Type | Method and Description |
---|---|
ParameterValue<T> |
createValue()
Creates a new instance of parameter value initialized with the
default value.
|
T |
getDefaultValue()
Returns the default value for the parameter.
|
Comparable<T> |
getMaximumValue()
Returns the maximum parameter value.
|
Comparable<T> |
getMinimumValue()
Returns the minimum parameter value.
|
Unit<?> |
getUnit()
|
Set<T> |
getValidValues()
Returns the set of allowed values when these are restricted to some finite set or returns
null otherwise. |
Class<T> |
getValueClass()
Returns the class that describe the type of the parameter.
|
getMaximumOccurs, getMinimumOccurs
getAlias, getIdentifiers, getName, getRemarks, toWKT
ParameterValue<T> createValue()
this
object.createValue
in interface GeneralParameterDescriptor
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.
@UML(identifier="GC_ParameterInfo.type", obligation=MANDATORY, specification=ISO_19111) Class<T> getValueClass()
Set<T> getValidValues()
null
otherwise. The returned set usually contains code list
or enumeration elements.null
if it doesn't apply.Departure from OGC/ISO specification:
This method is not part of ISO specification. It is provided as a complement of information.
@UML(identifier="GC_ParameterInfo.defaultValue", obligation=OPTIONAL, specification=ISO_19111) T getDefaultValue()
Number
or a String
. If there is no default value,
then this method returns null
.null
in none.@UML(identifier="GC_ParameterInfo.minimumValue", obligation=OPTIONAL, specification=ISO_19111) Comparable<T> getMinimumValue()
null
.
When the getValueClass() is an array or Collection getMinimumValue may be used to constrain the contained elements.
Double
), or null
.@UML(identifier="GC_ParameterInfo.maximumValue", obligation=OPTIONAL, specification=ISO_19111) Comparable<T> getMaximumValue()
null
.
When the getValueClass() is an array or Collection getMaximumValue may be used to constraint the contained elements.
Double
), or null
.Unit<?> getUnit()
Double
).null
if it doesn't apply to the value type.Departure from OGC/ISO specification:
This method is not part of ISO specification. It is provided as a complement of information.
Copyright © 1994–2019 Open Geospatial Consortium. All rights reserved.