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.geometry.Geometry;
035    import org.opengis.referencing.crs.CoordinateReferenceSystem;
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     * The presentation of an observed or measured space surrounding a sample point in the context
044     * of some external {@linkplain CoordinateReferenceSystem coordinate reference system}.
045     *
046     * @version ISO 19123:2004
047     * @author  Martin Schouwenburg
048     * @author  Wim Koolhoven
049     * @since   GeoAPI 2.1
050     */
051    @UML(identifier="CV_FootPrint", specification=ISO_19123)
052    public interface FootPrint {
053        /**
054         * Returns the geometry that shapes the foot print. In the simplest case this
055         * can be a point, but it can also be a disc, sphere or hypersphere.
056         *
057         * @return The geometry that shapes the foot print.
058         */
059        @UML(identifier="geometry", obligation=MANDATORY, specification=ISO_19123)
060        Geometry getGeometry();
061    
062        /**
063         * Returns the {@linkplain GridPoint grid point} to which this foot print corresponds.
064         *
065         * @return the grid point to which this foot print corresponds.
066         *
067         * @see GridPoint#getFootPrint
068         *
069         * @todo his role name in ISO 19123, "center", is a misnomer.  By definition, the sample point
070         *       represented in the same external coordinate reference system as the footprint, is the
071         *       "center" of the footprint.  This "center" attribute associates the footprint with a
072         *       grid point, which represents only the index into the grid.  This implementation
073         *       specification, therefore, has renamed the association role to "index".
074         */
075        @UML(identifier="center", obligation=MANDATORY, specification=ISO_19123)
076        GridPoint getCenter();
077    }