- All Superinterfaces:
IdentifiedObject
- All Known Subinterfaces:
ParameterDescriptor<T>
,ParameterDescriptorGroup
- All Known Implementing Classes:
SimpleParameter
,SimpleParameterGroup
@Classifier(ABSTRACT)
@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.
This interface combines information provided by Referencing by Coordinates (ISO 19111),
Service Metadata (ISO 19115), Data Quality (ISO 19157)
and Web Processing Services (WPS) standards.
The main information are:
Getter method | ISO 19111 | ISO 19115 | ISO 19157 | WPS | Remarks |
---|---|---|---|---|---|
getName() |
name |
name |
name |
Identifier |
See method javadoc for MemberName ↔ Identifier mapping. |
getAlias() |
alias |
||||
getIdentifiers() |
identifier |
Optional, contrarily to name which is mandatory. | |||
getName().getDescription() |
definition |
Should be a short sentence. | |||
getDescription() |
description |
description |
Abstract |
Explanation more detailed than the definition. | |
getRemarks() |
remarks |
||||
getValueType() |
valueType |
Name that describes the type of parameter values. | |||
getDirection() |
direction |
Tells if the parameter is a WPS Input or Output structure. |
|||
getMinimumOccurs() |
minimumOccurs |
optionality |
MinOccurs |
optionality = (minimumOccurs > 0) |
|
getMaximumOccurs() |
maximumOccurs |
repeatability |
MaxOccurs |
repeatability = (maximumOccurs > 1) |
- 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).
-
Field Summary
Fields inherited from interface IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
-
Method Summary
Modifier and TypeMethodDescriptionCreates a new instance of parameter value or group initialized with the default value(s).default InternationalString
A narrative explanation of the role of the parameter.default ParameterDirection
Indication if the parameter is an input to the service, an output or both.default int
The maximum number of times that values for this parameter group or parameter can be included.default int
The minimum number of times that values for this parameter group or parameter are required.getName()
The name, as used by the service or operation for this parameter.Methods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getRemarks, toWKT
-
Method Details
-
getName
@UML(identifier="name", obligation=MANDATORY, specification=ISO_19111) ReferenceIdentifier getName()The name, as used by the service or operation for this parameter.Unified parameter API
The metadata standard (ISO 19115) defines thename
property as of typeMemberName
instead ofIdentifier
, while the data quality standard (ISO 19157) defines equivalent properties directly in its parameter class. The following table provides the suggested mapping from ISO models to parameter descriptor.Mapping from ISO abstract models to unified parameter API Name used by ISO 19115 Property in ISO 19157 Property in unified parameter API MemberName.scope().name().toString()
Identifier.getCodeSpace()
MemberName.toString()
DQM_Parameter.name
Identifier.getCode()
MemberName.getAttributeType()
DQM_Parameter.valueType
ParameterDescriptor.getValueType()
DQM_Parameter.definition
Identifier.getDescription()
Upcoming API change — generalization
As of ISO 19115:2014,ReferenceIdentifier
has been merged with itsIdentifier
parent interface. Consequently this method return type will be changed toIdentifier
in GeoAPI 4.0.- Specified by:
getName
in interfaceIdentifiedObject
- Returns:
- the name, as used by the service or operation for this parameter.
-
getDirection
@UML(identifier="SV_Parameter.direction", obligation=MANDATORY, specification=ISO_19115) default ParameterDirection getDirection()Indication if the parameter is an input to the service, an output or both. This information applies mostly to service metadata. The default value isParameterDirection.IN
.- Returns:
- indication if the parameter is an input to the service, an output or both.
- Since:
- 3.1
-
getDescription
@UML(identifier="SV_Parameter.description", obligation=OPTIONAL, specification=ISO_19115) default InternationalString getDescription()A narrative explanation of the role of the parameter.- Returns:
- a narrative explanation of the role of the parameter, or
null
if none. - Since:
- 3.1
- See Also:
-
getMinimumOccurs
@UML(identifier="minimumOccurs", obligation=OPTIONAL, specification=ISO_19111) default int getMinimumOccurs()The minimum number of times that values for this parameter group or parameter are required. The default value is 1. 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) default int getMaximumOccurs()The maximum number of times that values for this parameter group or parameter can be included. The default value is 1. A value greater than 1 means a repeatable parameter.If this parameter is an instance of
ParameterDescriptor
used for the description ofOperationMethod
parameters, then the value is always 1. In other contexts (e.g. parameter group or service metadata) it may vary.- Returns:
- the maximum occurrence, or
Integer.MAX_VALUE
if there is no limit. - See Also:
- Departure from OGC/ISO abstract specification:
Generalization by relaxation of ISO/OGC restriction
Moved up (in the interface hierarchy) themaximumOccurs
method fromParameterDescriptorGroup
into this super-interface, for parallelism with theminimumOccurs
method.
-
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 bethis
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.
-