001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2013 Open Geospatial Consortium, Inc.
006 * All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007 *
008 * Permission to use, copy, and modify this software and its documentation, with
009 * or without modification, for any purpose and without fee or royalty is hereby
010 * granted, provided that you include the following on ALL copies of the software
011 * and documentation or portions thereof, including modifications, that you make:
012 *
013 * 1. The full text of this NOTICE in a location viewable to users of the
014 * redistributed or derivative work.
015 * 2. Notice of any changes or modifications to the OGC files, including the
016 * date changes were made.
017 *
018 * THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019 * NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020 * TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021 * THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022 * PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023 *
024 * COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025 * CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026 *
027 * The name and trademarks of copyright holders may NOT be used in advertising or
028 * publicity pertaining to the software without specific, written prior permission.
029 * Title to copyright in this software and any associated documentation will at all
030 * times remain with copyright holders.
031 */
032 package org.opengis.coverage.processing;
033
034 import org.opengis.metadata.Identifier;
035 import org.opengis.metadata.citation.Citation;
036 import org.opengis.parameter.ParameterValueGroup;
037 import org.opengis.util.InternationalString;
038 import org.opengis.annotation.UML;
039
040 import static org.opengis.annotation.Obligation.*;
041 import static org.opengis.annotation.Specification.*;
042
043
044 /**
045 * This interface provides descriptive information for a grid coverage processing
046 * operation. The descriptive information includes such information as the name of
047 * the operation, operation description, number of source grid coverages required
048 * for the operation etc.
049 *
050 * <P> </P>
051 * <TABLE WIDTH="80%" ALIGN="center" CELLPADDING="18" BORDER="4" BGCOLOR="#FFE0B0">
052 * <TR><TD>
053 * <P align="justify"><STRONG>WARNING: THIS CLASS WILL CHANGE.</STRONG> Current API is derived from OGC
054 * <A HREF="http://www.opengis.org/docs/01-004.pdf">Grid Coverages Implementation specification 1.0</A>.
055 * We plan to replace it by new interfaces derived from ISO 19123 (<CITE>Schema for coverage geometry
056 * and functions</CITE>). Current interfaces should be considered as legacy and are included in this
057 * distribution only because they were part of GeoAPI 1.0 release. We will try to preserve as much
058 * compatibility as possible, but no migration plan has been determined yet.</P>
059 * </TD></TR>
060 * </TABLE>
061 *
062 * @version <A HREF="http://www.opengis.org/docs/01-004.pdf">Grid Coverage specification 1.0</A>
063 * @author Martin Desruisseaux (IRD)
064 * @since GeoAPI 1.0
065 *
066 * @todo This interface should be renamed {@code CoverageOperation}.
067 */
068 @UML(identifier="CV_Operation", specification=OGC_01004)
069 public interface Operation {
070 /**
071 * Name of the processing operation. This name is passed as a parameter to the
072 * {@link GridCoverageProcessor#doOperation doOperation} method to instantiate
073 * a new grid coverage on which the processing operation is performed.
074 *
075 * @return The name of the processing operation.
076 *
077 * @todo The return type will be changed from {@link String} to {@link Identifier}.
078 */
079 @UML(identifier="name", obligation=MANDATORY, specification=OGC_01004)
080 String getName();
081
082 /**
083 * Description of the processing operation.
084 * If no description is available, the value will be {@code null}.
085 *
086 * @return The description of the processing operation, or {@code null}.
087 *
088 * @deprecated Return type need to be changed, maybe to {@link InternationalString}.
089 */
090 @Deprecated
091 @UML(identifier="description", obligation=OPTIONAL, specification=OGC_01004)
092 String getDescription();
093
094 /**
095 * Vendor of the processing operation implementation.
096 * If no vendor name is available, the value will be {@code null}.
097 *
098 * @return The implementation vendor name, or {@code null}.
099 *
100 * @deprecated To be replaced by {@code getName().getAuthority()}.
101 */
102 @Deprecated
103 @UML(identifier="vendor", obligation=OPTIONAL, specification=OGC_01004)
104 String getVendor();
105
106 /**
107 * URL for documentation on the processing operation.
108 * If no online documentation is available the string will be {@code null}.
109 *
110 * @return The URL for documentation on the processing operation, or {@code null}.
111 *
112 * @deprecated To be replaced by a method returning a {@link Citation}.
113 */
114 @Deprecated
115 @UML(identifier="docURL", obligation=OPTIONAL, specification=OGC_01004)
116 String getDocURL();
117
118 /**
119 * Version number for the implementation.
120 *
121 * @return The version number for the implementation, or {@code null}.
122 *
123 * @deprecated Replacement to be determined.
124 */
125 @Deprecated
126 @UML(identifier="version", obligation=OPTIONAL, specification=OGC_01004)
127 String getVersion();
128
129 /**
130 * Number of source grid coverages required for the operation.
131 *
132 * @return The number of source grid coverages required for the operation.
133 */
134 @UML(identifier="numSources", obligation=OPTIONAL, specification=OGC_01004)
135 int getNumSources();
136
137 /**
138 * Retrieve the parameters information.
139 *
140 * @return The parameter informations.
141 */
142 @UML(identifier="getParameterInfo, numParameters", obligation=MANDATORY, specification=OGC_01004)
143 ParameterValueGroup getParameters();
144 }