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.DomainObject;
036 import org.opengis.geometry.Geometry;
037 import org.opengis.geometry.primitive.Point;
038 import org.opengis.referencing.crs.CoordinateReferenceSystem;
039 import org.opengis.annotation.UML;
040
041 import static org.opengis.annotation.Obligation.*;
042 import static org.opengis.annotation.Specification.*;
043
044
045 /**
046 * Point located at the intersection of two or more curves in a {@linkplain Grid grid}.
047 *
048 * @version ISO 19123:2004
049 * @author Martin Schouwenburg
050 * @author Wim Koolhoven
051 * @author Martin Desruisseaux (IRD)
052 * @since GeoAPI 2.1
053 */
054 @UML(identifier="CV_GridPoint", specification=ISO_19123)
055 public interface GridPoint extends DomainObject<Geometry> {
056 /**
057 * Returns the set of grid coordinates that specifies the location of the
058 * grid point within the {@linkplain Grid grid}.
059 *
060 * @return The coordinates that specifieds the location of the grid point.
061 */
062 @UML(identifier="gridCoord", obligation=MANDATORY, specification=ISO_19123)
063 GridCoordinates getGridCoordinates();
064
065 /**
066 * Returns the {@linkplain Grid grid} of which this grid point is an element.
067 *
068 * @return The grid of which this grid point is an element.
069 *
070 * @see Grid#getIntersections
071 */
072 @UML(identifier="framework", obligation=MANDATORY, specification=ISO_19123)
073 Grid getFramework();
074
075 /**
076 * Returns the set of {@linkplain GridCell grid cells} for which this grid point is a corner.
077 *
078 * @return The grid cells for which this grid point is a corner.
079 *
080 * @see GridCell#getCorners
081 */
082 @UML(identifier="cell", obligation=MANDATORY, specification=ISO_19123)
083 Set<GridCell> getCells();
084
085 /**
086 * Returns the representation of the grid point in an external
087 * {@linkplain CoordinateReferenceSystem coordinate reference system}.
088 *
089 * @return The representation of this grid point in an external CRS.
090 */
091 @UML(identifier="groundPoint", obligation=OPTIONAL, specification=ISO_19123)
092 Point getGroundPoint();
093
094 /**
095 * Returns the {@linkplain FootPrint foot prints} that represents the sample space in an external
096 * {@linkplain CoordinateReferenceSystem coordinate reference system} associated with this grid
097 * point. The multiplicity of the association allows for multiple external coordinate reference
098 * systems for foot print.
099 *
100 * @return The foot prints that represents the sample space in an external CRS.
101 *
102 * @see FootPrint#getCenter
103 */
104 @UML(identifier="footprint", obligation=OPTIONAL, specification=ISO_19123)
105 Set<FootPrint> getFootPrints();
106 }