Package org.opengis.parameter

Interface GeneralParameterDescriptor

All Superinterfaces:

IdentifiedObject

All Known Subinterfaces:

ParameterDescriptor<T>, ParameterDescriptorGroup

@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) and Web Processing Services (WPS) standards. The main information are:

Main parameter properties

Getter method	ISO 19111	WPS	ISO 19115	Remarks
getName()	name	Identifier	name	See method javadoc for MemberName ↔ Identifier mapping.
getDescription()		Abstract	description	Also known as “definition”.
getDirection()			direction	Tells if the parameter is a WPS Input or Output structure.
getMinimumOccurs()	minimumOccurs	MinOccurs	optionality	optionality = (minimumOccurs > 0)
getMaximumOccurs()	maximumOccurs	MaxOccurs	repeatability	repeatability = (maximumOccurs > 1)

Since:

2.0

See Also:

GeneralParameterValue

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

Field Summary

Fields inherited from interface IdentifiedObject

ALIAS_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 InternationalString	getDescription()	A narrative explanation of the role of the parameter.
default ParameterDirection	getDirection()	Indication if the parameter is an input to the service, an output or both.
default int	getMaximumOccurs()	The maximum number of times that values for this parameter group or parameter can be included.
default int	getMinimumOccurs()	The minimum number of times that values for this parameter group or parameter are required.
ReferenceIdentifier	getName()	The name, as used by the service or operation for this parameter.

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getRemarks, toWKT

Method Detail

getName

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

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

Note on Service Metadata name
The metadata standard (ISO 19115) defines the name property as of type MemberName instead than Identifier. The details of mapping the former to the later are left to implementors, but the following can be used as guidelines:

Suggested mapping from MemberName to Identifier

Member name property	Equivalence	Remarks
GenericName.scope().name().toString()	Identifier.getCodeSpace()
MemberName.toString()	Identifier.getCode()
MemberName.getAttributeType()	ParameterDescriptor.getValueClass()	See TypeName for a suggested mapping to Class.

Some implementations may allow the Identifier to be casted to MemberName. Alternatively, the member type can also be specified in the aliases list.

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="direction",
     obligation=OPTIONAL,
     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.

Returns:

indication if the parameter is an input to the service, an output or both, or null if unspecified.

Since:

3.1

getDescription

@UML(identifier="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:

getName(), IdentifiedObject.getRemarks()

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

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 of OperationMethod 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:

getMinimumOccurs()

Departure from OGC/ISO specification:
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.

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.