Interface Operation


  • @UML(identifier="CV_Operation",
         specification=OGC_01004)
    public interface Operation
    This interface provides descriptive information for a grid coverage processing operation. The descriptive information includes such information as the name of the operation, operation description, number of source grid coverages required for the operation etc.
    Warning — this class will change
    Current API is derived from OGC Grid Coverages Implementation specification 1.0. We plan to replace it by new interfaces derived from ISO 19123 (Schema for coverage geometry and functions). Current interfaces should be considered as legacy and are included in this distribution only because they were part of GeoAPI 1.0 release. We will try to preserve as much compatibility as possible, but no migration plan has been determined yet.
    Since:
    GeoAPI 1.0
    TODO:
    This interface should be renamed CoverageOperation.
    • Method Detail

      • getName

        @UML(identifier="name",
             obligation=MANDATORY,
             specification=OGC_01004)
        String getName()
        Name of the processing operation. This name is passed as a parameter GridCoverageProcessor to instantiate a new grid coverage on which the processing operation is performed.
        Returns:
        the name of the processing operation.
        TODO:
        The return type will be changed from String to Identifier.
      • getDescription

        @Deprecated
        @UML(identifier="description",
             obligation=OPTIONAL,
             specification=OGC_01004)
        String getDescription()
        Deprecated.
        Return type need to be changed, maybe to InternationalString.
        Description of the processing operation. If no description is available, the value will be null.
        Returns:
        the description of the processing operation, or null.
      • getVendor

        @Deprecated
        @UML(identifier="vendor",
             obligation=OPTIONAL,
             specification=OGC_01004)
        String getVendor()
        Deprecated.
        To be replaced by getName().getAuthority().
        Vendor of the processing operation implementation. If no vendor name is available, the value will be null.
        Returns:
        the implementation vendor name, or null.
      • getDocURL

        @Deprecated
        @UML(identifier="docURL",
             obligation=OPTIONAL,
             specification=OGC_01004)
        String getDocURL()
        Deprecated.
        To be replaced by a method returning a Citation.
        URL for documentation on the processing operation. If no online documentation is available the string will be null.
        Returns:
        the URL for documentation on the processing operation, or null.
      • getVersion

        @Deprecated
        @UML(identifier="version",
             obligation=OPTIONAL,
             specification=OGC_01004)
        String getVersion()
        Deprecated.
        Replacement to be determined.
        Version number for the implementation.
        Returns:
        the version number for the implementation, or null.
      • getNumSources

        @UML(identifier="numSources",
             obligation=OPTIONAL,
             specification=OGC_01004)
        int getNumSources()
        Number of source grid coverages required for the operation.
        Returns:
        the number of source grid coverages required for the operation.
      • getParameters

        @UML(identifier="getParameterInfo, numParameters",
             obligation=MANDATORY,
             specification=OGC_01004)
        ParameterValueGroup getParameters()
        Retrieve the parameters information.
        Returns:
        the parameter informations.