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 org.opengis.coverage.GeometryValuePair;
035    import org.opengis.util.Record;
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     * A {@linkplain GeometryValuePair geometry value pair} that has a {@linkplain GridPoint grid point}
044     * as the value of its geometry attribute.
045     *
046     * @version ISO 19123:2004
047     * @author  Wim Koolhoven
048     * @author  Martin Desruisseaux (IRD)
049     * @since   GeoAPI 2.1
050     */
051    @UML(identifier="CV_GridPointValuePair", specification=ISO_19123)
052    public interface GridPointValuePair extends GeometryValuePair {
053        /**
054         * The grid point that is a member of this <var>grid point</var>-<var>value</var> pair.
055         * It is one of the {@linkplain GridPoint grid points} linked to the
056         * {@linkplain GridValuesMatrix grid value matrix} through {@link Grid#getIntersections}.
057         *
058         * @return The geometry member of the pair.
059         */
060        @UML(identifier="geometry", obligation=MANDATORY, specification=ISO_19123)
061        GridPoint getGeometry();
062    
063        /**
064         * Holds the record of feature attribute values associated with the grid point.
065         *
066         * @return The value member of the pair.
067         */
068        @UML(identifier="value", obligation=MANDATORY, specification=ISO_19123)
069        Record getValue();
070    }