org.opengis.coverage.processing.Operation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gt-opengis Show documentation
Standard interfaces implemented throughout the library.
The newest version!
/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2011, Open Source Geospatial Foundation (OSGeo)
 *    (C) 2005 Open Geospatial Consortium Inc.
 *
 *    All Rights Reserved. http://www.opengis.org/legal/
 */

package org.opengis.coverage.processing;

import static org.opengis.annotation.Obligation.MANDATORY;
import static org.opengis.annotation.Obligation.OPTIONAL;
import static org.opengis.annotation.Specification.OGC_01004;

import org.opengis.annotation.UML;
import org.opengis.metadata.Identifier;
import org.opengis.parameter.ParameterValueGroup;

/**
 * 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.
 *
 * @version Grid Coverage specification 1.0
 * @author Martin Desruisseaux (IRD)
 * @since GeoAPI 1.0
 * @todo This interface should be renamed {@code CoverageOperation}.
 */
@UML(identifier = "CV_Operation", specification = OGC_01004)
public interface Operation {
    /**
     * Name of the processing operation. This name is passed as a parameter to the {@link
     * GridCoverageProcessor#doOperation doOperation} method to instantiate a new grid coverage on
     * which the processing operation is performed.
     *
     * @return The name of the processing operation.
     * @todo The return type will be changed from {@link String} to {@link Identifier}.
     */
    @UML(identifier = "name", obligation = MANDATORY, specification = OGC_01004)
    String getName();

    /**
     * Description of the processing operation. If no description is available, the value will be
     * {@code null}.
     *
     * @return The description of the processing operation, or {@code null}.
     */
    @UML(identifier = "description", obligation = OPTIONAL, specification = OGC_01004)
    String getDescription();

    /**
     * Vendor of the processing operation implementation. If no vendor name is available, the value
     * will be {@code null}.
     *
     * @return The implementation vendor name, or {@code null}.
     */
    @UML(identifier = "vendor", obligation = OPTIONAL, specification = OGC_01004)
    String getVendor();

    /**
     * URL for documentation on the processing operation. If no online documentation is available
     * the string will be {@code null}.
     *
     * @return The URL for documentation on the processing operation, or {@code null}.
     */
    @UML(identifier = "docURL", obligation = OPTIONAL, specification = OGC_01004)
    String getDocURL();

    /**
     * Version number for the implementation.
     *
     * @return The version number for the implementation, or {@code null}.
     */
    @UML(identifier = "version", obligation = OPTIONAL, specification = OGC_01004)
    String getVersion();

    /**
     * Number of source grid coverages required for the operation.
     *
     * @return The number of source grid coverages required for the operation.
     */
    @UML(identifier = "numSources", obligation = OPTIONAL, specification = OGC_01004)
    int getNumSources();

    /**
     * Retrieve the parameters information.
     *
     * @return The parameter informations.
     */
    @UML(
        identifier = "getParameterInfo, numParameters",
        obligation = MANDATORY,
        specification = OGC_01004
    )
    ParameterValueGroup getParameters();
}