001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2005-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 java.util.Set;
035    import org.opengis.coverage.ValueObject;
036    import org.opengis.annotation.UML;
037    
038    import static org.opengis.annotation.Obligation.*;
039    import static org.opengis.annotation.Specification.*;
040    
041    
042    /**
043     * Basis for interpolating within a {@linkplain ContinuousQuadrilateralGridCoverage
044     * continuous quadrilateral grid coverage}. A {@code GridValueCell} is a collection
045     * of {@linkplain GridPointValuePair grid point value pairs} with a geometric structure
046     * defined by a {@linkplain GridCell grid cell}.
047     *
048     * @version ISO 19123:2004
049     * @author  Wim Koolhoven
050     * @author  Martin Schouwenburg
051     * @since   GeoAPI 2.1
052     */
053    @UML(identifier="CV_GridValueCell", specification=ISO_19123)
054    public interface GridValueCell extends ValueObject {
055        /**
056         * Returns the {@linkplain GridCell grid cell} that defines the structure of the
057         * {@linkplain GridPointValuePair grid point value pairs} that support the interpolation
058         * of a feature attribute value at a {@linkplain DirectPosition direct position} within the
059         * {@linkplain GridCell grid cell}.
060         *
061         * @departure constraint
062         *   ISO defines this method as a specialization of <code>getGeometry()</code>. We
063         *   can not reflect this association in Java because of incompatible return type.
064         *
065         * @return The structure of grid points.
066         */
067        @UML(identifier="geometry", obligation=MANDATORY, specification=ISO_19123)
068        GridCell getGridCell();
069    
070        /**
071         * Returns the set of <var>grid point</var>-<var>value</var> pairs at the corners of this
072         * {@code GridValueCell}.
073         */
074        @UML(identifier="controlValue", obligation=MANDATORY, specification=ISO_19123)
075        Set<GridPointValuePair> getControlValues();
076    }