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 Detail
-
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, theSV_Parameter
type defined by ISO 19115 is replaced byParameterDescriptor
in order to provide a single parameter API (seeorg.opengis.parameter
for more information). The mapping from ISO 19115 to GeoAPI is defined as bellow:Service metadata properties mapped to GeoAPI Metadata property GeoAPI equivalence name
GeneralParameterDescriptor.getName()
name.attributeType
ParameterDescriptor.getValueClass()
direction
GeneralParameterDescriptor.getDirection()
description
GeneralParameterDescriptor.getDescription()
optionality
GeneralParameterDescriptor.getMinimumOccurs() > 0
repeatability
GeneralParameterDescriptor.getMaximumOccurs() > 1
name
property, which is mapped to anIdentifier
instead thanMemberName
. TheGeneralParameterDescriptor.getName()
javadoc gives more information on the mapping of names.- Returns:
- the parameters that are required for this interface, or an empty collection if none.
- See Also:
GeneralParameterDescriptor
Departure from OGC/ISO specification:
Usage of the ISO 19115SV_Parameter
type has been replaced by usage of the ISO 19111CC_OperationParameter
type, completed with newSV_Parameter
properties, in order to provide a unified parameter API. Note thatCC_OperationParameter
is namedParameterDescriptor
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.
-
-