|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@UML(identifier="CC_OperationParameter", specification=ISO_19111) public interface ParameterDescriptor<T>
The definition of a parameter used by an operation method. Most parameter values are numeric, but other types of parameter values are possible.
ParameterValue
,
ParameterDescriptorGroup
Field Summary |
---|
Fields inherited from interface IdentifiedObject |
---|
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY |
Method Summary | |
---|---|
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()
Returns the unit for default, minimum and maximum values. |
Set<T> |
getValidValues()
If this parameter allows only a finite set of values, returns this set. |
Class<T> |
getValueClass()
Returns the class that describe the type of the parameter. |
Methods inherited from interface GeneralParameterDescriptor |
---|
createValue, getMaximumOccurs, getMinimumOccurs |
Methods inherited from interface IdentifiedObject |
---|
getAlias, getIdentifiers, getName, getRemarks, toWKT |
Method Detail |
---|
@UML(identifier="GC_ParameterInfo.type", obligation=MANDATORY, specification=ISO_19111) Class<T> getValueClass()
@Extension Set<T> getValidValues()
null
if this parameter
doesn't limits values to a finite set.
Note even when CodeList is used one can use this set to allow only a subset of the permissable values provided by the CodeList.
When the getValueClass() is an array or Collection getValidValues() may be used to constrain the contained elements.
null
if it doesn't apply.@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 constratin the contained elements.
Double
), or null
.@Extension Unit getUnit()
Double
).
null
if it doesn't apply to the value type.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |