001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2012 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.grid;
033
034 import org.opengis.parameter.ParameterValueGroup;
035 import org.opengis.annotation.UML;
036
037 import static org.opengis.annotation.Obligation.*;
038 import static org.opengis.annotation.Specification.*;
039
040
041 /**
042 * A discovery mechanism to determine the formats supported by a {@link GridCoverageExchange}
043 * implementation. A {@code GridCoverageExchange} implementation can support a number of
044 * file format or resources.
045 *
046 * <P> </P>
047 * <TABLE WIDTH="80%" ALIGN="center" CELLPADDING="18" BORDER="4" BGCOLOR="#FFE0B0">
048 * <TR><TD>
049 * <P align="justify"><STRONG>WARNING: THIS CLASS WILL CHANGE.</STRONG> Current API is derived from OGC
050 * <A HREF="http://www.opengis.org/docs/01-004.pdf">Grid Coverages Implementation specification 1.0</A>.
051 * We plan to replace it by new interfaces derived from ISO 19123 (<CITE>Schema for coverage geometry
052 * and functions</CITE>). Current interfaces should be considered as legacy and are included in this
053 * distribution only because they were part of GeoAPI 1.0 release. We will try to preserve as much
054 * compatibility as possible, but no migration plan has been determined yet.</P>
055 * </TD></TR>
056 * </TABLE>
057 *
058 * @version <A HREF="http://www.opengis.org/docs/01-004.pdf">Grid Coverage specification 1.0</A>
059 * @author Martin Desruisseaux (IRD)
060 * @since GeoAPI 2.0
061 *
062 * @deprecated In favor of migrating to ISO 19123 definition for Coverage.
063 */
064 @Deprecated
065 @UML(identifier="CV_Format", specification=OGC_01004)
066 public interface Format {
067 /**
068 * Name of the file format.
069 */
070 @UML(identifier="name", obligation=MANDATORY, specification=OGC_01004)
071 String getName();
072
073 /**
074 * Description of the file format.
075 * If no description, the value will be {@code null}.
076 */
077 @UML(identifier="description", obligation=OPTIONAL, specification=OGC_01004)
078 String getDescription();
079
080 /**
081 * Vendor or agency for the format.
082 */
083 @UML(identifier="vendor", obligation=OPTIONAL, specification=OGC_01004)
084 String getVendor();
085
086 /**
087 * Documentation URL for the format.
088 */
089 @UML(identifier="docURL", obligation=OPTIONAL, specification=OGC_01004)
090 String getDocURL();
091
092 /**
093 * Version number of the format.
094 */
095 @UML(identifier="version", obligation=OPTIONAL, specification=OGC_01004)
096 String getVersion();
097
098 /**
099 * Retrieve the parameter information for a {@link GridCoverageReader#read read} operation.
100 */
101 @UML(identifier="getParameterInfo, numParameters", obligation=MANDATORY, specification=OGC_01004)
102 ParameterValueGroup getReadParameters();
103
104 /**
105 * Retrieve the parameter information for a {@link GridCoverageWriter#write write} operation.
106 */
107 @UML(identifier="getParameterInfo, numParameters", obligation=MANDATORY, specification=OGC_01004)
108 ParameterValueGroup getWriteParameters();
109 }