Module org.opengis.geoapi

Package org.opengis.metadata.identification

Interface OperationMetadata

@UML(identifier="SV_OperationMetadata",
     specification=ISO_19115)
public interface OperationMetadata

Describes the signature of one and only one method provided by the service.

Since:

3.1

Method Summary

Modifier and Type	Method	Description
Collection<? extends OnlineResource>	getConnectPoints()	Handle for accessing the service interface.
default List<? extends OperationMetadata>	getDependsOn()	List of operation that must be completed immediately before current operation is invoked.
Collection<DistributedComputingPlatform>	getDistributedComputingPlatforms()	Distributed computing platforms (DCPs) on which the operation has been implemented.
default InternationalString	getInvocationName()	The name used to invoke this interface within the context of the DCP.
default InternationalString	getOperationDescription()	Free text description of the intent of the operation and the results of the operation.
String	getOperationName()	An unique identifier for this interface.
default Collection<? extends ParameterDescriptor<?>>	getParameters()	The parameters that are required for this interface.

Method Details

getOperationName

@UML(identifier="operationName",
     obligation=MANDATORY,
     specification=ISO_19115)
String getOperationName()

An unique identifier for this interface.

Returns:

an unique identifier for this interface.

getDistributedComputingPlatforms

@UML(identifier="distributedComputingPlatform",
     obligation=MANDATORY,
     specification=ISO_19115)
Collection<DistributedComputingPlatform> getDistributedComputingPlatforms()

Distributed computing platforms (DCPs) on which the operation has been implemented.

Returns:

distributed computing platforms on which the operation has been implemented.

getOperationDescription

@UML(identifier="operationDescription",
     obligation=OPTIONAL,
     specification=ISO_19115)
default InternationalString getOperationDescription()

Free text description of the intent of the operation and the results of the operation.

Returns:

free text description of the intent of the operation and the results of the operation, or null if none.

getInvocationName

@UML(identifier="invocationName",
     obligation=OPTIONAL,
     specification=ISO_19115)
default InternationalString getInvocationName()

The name used to invoke this interface within the context of the DCP. The name is identical for all Distributed computing platforms (DCPs).

Returns:

the name used to invoke this interface within the context of the DCP, or null if none.

getConnectPoints

@UML(identifier="connectPoint",
     obligation=MANDATORY,
     specification=ISO_19115)
Collection<? extends OnlineResource> getConnectPoints()

Handle for accessing the service interface.

Returns:

handle for accessing the service interface.

getParameters

@UML(identifier="parameter",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends ParameterDescriptor<?>> getParameters()

The parameters that are required for this interface. Returns an empty collection if none.

Unified parameter API

In GeoAPI, the SV_Parameter type defined by ISO 19115 is replaced by ParameterDescriptor in order to provide a single parameter API (see org.opengis.parameter for more information). The mapping from ISO 19115 to GeoAPI is defined in the following table. The equivalences are straightforward except for the name property, which is mapped to an Identifier instead of MemberName (more information on the mapping of names).

Service metadata properties mapped to GeoAPI

SV_Parameter property	ParameterDescriptor property
name	name
name.attributeType	valueClass
direction	direction
description	description
optionality	minimumOccurs > 0
repeatability	maximumOccurs > 1

Returns:

the parameters that are required for this interface, or an empty collection if none.

See Also:

• GeneralParameterDescriptor

Departure from OGC/ISO standard for harmonization between different specifications

Usage of the ISO 19115 SV_Parameter type has been replaced by usage of the ISO 19111 OperationParameter type, completed with new SV_Parameter properties, in order to provide a unified parameter API. Note that OperationParameter is named org.opengis.parameter.ParameterDescriptor in GeoAPI to reflect its extended scope.

getDependsOn

@UML(identifier="dependsOn",
     obligation=OPTIONAL,
     specification=ISO_19115)
default List<? extends OperationMetadata> getDependsOn()

List of operation that must be completed immediately before current operation is invoked. The return value is structured as a list for capturing alternate predecessor paths and sets for capturing parallel predecessor paths.

Returns:

list of operation that must be completed immediately, or an empty list if none.