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.annotation.UML;
036    
037    import static org.opengis.annotation.Obligation.*;
038    import static org.opengis.annotation.Specification.*;
039    
040    
041    /**
042     * A grid cell delineated by the grid lines of a {@linkplain Grid grid}. Its corners
043     * are associated with the {@linkplain GridPoint grid points} at the intersections of
044     * the grid lines that bound it
045     *
046     * @version ISO 19123:2004
047     * @author  Martin Schouwenburg
048     * @author  Wim Koolhoven
049     * @author  Martin Desruisseaux (IRD)
050     * @since   GeoAPI 2.1
051     */
052    @UML(identifier="CV_GridCell", specification=ISO_19123)
053    public interface GridCell {
054        /**
055         * Returns the collection of {@linkplain GridPoint grid points} at the corners of the grid cell.
056         * The size of this collection has no upper bound, to allow for grids of any dimension.
057         * In a quadrilateral grid, the multiplicity of corner equals 2&times;<var>d</var>, where
058         * <var>d</var> is the value of {@link Grid#getDimension}.
059         *
060         * @return The corners of the grid cell.
061         *
062         * @see GridPoint#getCells
063         */
064        @UML(identifier="corner", obligation=MANDATORY, specification=ISO_19123)
065        Set<GridPoint> getCorners();
066    
067        /**
068         * Returns the {@linkplain Grid grid} of which this cell is a component.
069         *
070         * @return The grid of which this cell is a component.
071         *
072         * @see Grid#getCells
073         */
074        @UML(identifier="framework", obligation=MANDATORY, specification=ISO_19123)
075        Grid getFramework();
076    }