Module org.opengis.geoapi

Package org.opengis.parameter

Interface GeneralParameterDescriptor

All Superinterfaces:

IdentifiedObject

All Known Subinterfaces:

ParameterDescriptor<T>, ParameterDescriptorGroup

@Classifier(ABSTRACT)
@UML(identifier="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), filter encoding (ISO 19143) and Web Processing Services (WPS) standards. The main information are:

Main parameter properties and their mapping to other standards

Getter method	ISO 19111	ISO 19115	ISO 19157	ISO 19143	WPS	Remarks
getName()	name	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	type		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:

• GeneralParameterValue

Departure from OGC/ISO standard in the name

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 org.opengis.referencing.IdentifiedObject

ALIAS_KEY, DOMAINS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Method Summary

Modifier and Type	Method	Description
GeneralParameterValue	createValue()	Creates a new instance of parameter value or group initialized with the default value(s).
default Optional<InternationalString>	getDescription()	Returns a narrative explanation of the role of this parameter.
default ParameterDirection	getDirection()	Returns whether the parameter is an input to the service, an output or both.
default int	getMaximumOccurs()	Returns the maximum number of times that values for this parameter or parameter group can be included.
default int	getMinimumOccurs()	Returns the minimum number of times that values for this parameter or parameter group are required.
ReferenceIdentifier	getName()	Returns the name, as used by the service or operation for this parameter.

Methods inherited from interface org.opengis.referencing.IdentifiedObject

getAlias, getDomains, getIdentifiers, getRemarks, toWKT

Method Details

getName

@UML(identifier="name",
     obligation=MANDATORY,
     specification=ISO_19111)
ReferenceIdentifier getName()

Returns the name, as used by the service or operation for this parameter.

Unified parameter API

The metadata standard (ISO 19115) defines the name property as of type MemberName instead of Identifier, 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 its Identifier parent interface. Consequently this method return type will be changed to Identifier in GeoAPI 4.0.

Specified by:

getName in interface IdentifiedObject

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()

Returns whether the parameter is an input to the service, an output or both. This information applies mostly to service metadata. The default value is ParameterDirection.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 Optional<InternationalString> getDescription()

Returns a narrative explanation of the role of this parameter.

Returns:

a narrative explanation of the role of this parameter.

Since:

3.1

See Also:

• getName()
• IdentifiedObject.getRemarks()

getMinimumOccurs

@UML(identifier="OperationParameterGroup.minimumOccurs",
     obligation=OPTIONAL,
     specification=ISO_19111)
default int getMinimumOccurs()

Returns the minimum number of times that values for this parameter or parameter group are required. The default value is 1. A value of 0 means an optional parameter.

Returns:

the minimum occurrence.

See Also:

• getMaximumOccurs()

getMaximumOccurs

@UML(identifier="OperationParameterGroup.maximumOccurs",
     obligation=OPTIONAL,
     specification=ISO_19111)
default int getMaximumOccurs()

Returns the maximum number of times that values for this parameter or parameter group 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 of OperationMethod parameters, then the value shall be 1. If this parameter is an instance of ParameterDescriptorGroup, or if this parameter is used in the context of service metadata, then maximumOccurs value may vary.

Returns:

the maximum occurrence, or Integer.MAX_VALUE if there is no limit.

See Also:

• getMinimumOccurs()

Departure from OGC/ISO standard by generalization

Moved up (in the interface hierarchy) the maximumOccurs method from ParameterDescriptorGroup into this super-interface, for parallelism with the minimumOccurs 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 be this object.

Returns:

a new parameter initialized to its default value.

Extension to OGC/ISO standard

This method is not part of the ISO specification. It is provided in GeoAPI as a kind of factory method.