001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2013 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.referencing.crs;
033
034 import org.opengis.referencing.datum.Datum;
035 import org.opengis.referencing.cs.CoordinateSystem;
036 import org.opengis.annotation.UML;
037 import org.opengis.annotation.Classifier;
038 import org.opengis.annotation.Stereotype;
039
040 import static org.opengis.annotation.Obligation.*;
041 import static org.opengis.annotation.Specification.*;
042
043
044 /**
045 * Abstract coordinate reference system, consisting of a single
046 * {@linkplain CoordinateSystem Coordinate System} and a single
047 * {@linkplain Datum Datum} (as opposed to {@linkplain CompoundCRS Compound CRS}).
048 *
049 * <p>A coordinate reference system consists of an ordered sequence of coordinate system
050 * axes that are related to the earth through a datum. A coordinate reference system
051 * is defined by one datum and by one coordinate system. Most coordinate reference system
052 * do not move relative to the earth, except for engineering coordinate reference systems
053 * defined on moving platforms such as cars, ships, aircraft, and spacecraft.</p>
054 *
055 * <p>Coordinate reference systems are commonly divided into sub-types. The common classification
056 * criterion for sub-typing of coordinate reference systems is the way in which they deal with
057 * earth curvature. This has a direct effect on the portion of the earth's surface that can be
058 * covered by that type of CRS with an acceptable degree of error. The exception to the rule is
059 * the subtype "Temporal" which has been added by analogy.</p>
060 *
061 * @author Martin Desruisseaux (IRD)
062 * @version 3.1
063 * @since 2.0
064 *
065 * @see org.opengis.referencing.cs.CoordinateSystem
066 * @see org.opengis.referencing.datum.Datum
067 *
068 * @navassoc 1 - - Datum
069 */
070 @Classifier(Stereotype.ABSTRACT)
071 @UML(identifier="SC_SingleCRS", specification=ISO_19111)
072 public interface SingleCRS extends CoordinateReferenceSystem {
073 /**
074 * Returns the coordinate system.
075 */
076 @Override
077 @UML(identifier="coordinateSystem", obligation=MANDATORY, specification=ISO_19111)
078 CoordinateSystem getCoordinateSystem();
079
080 /**
081 * Returns the datum.
082 *
083 * @departure historic
084 * This method is conform to ISO 19111:2003. The 2007 revision moved this attribute to subclasses,
085 * where it is repeated with different return types. While ISO does not provide explanation for this move,
086 * one possible reason may have been to enforce type safety in languages that do not support type covariance.
087 * Since Java 5 and later supports return type covariance, this method has been keep in this parent class
088 * both for historical and for genericity reasons.
089 *
090 * @return The datum.
091 */
092 @UML(identifier="datum", obligation=OPTIONAL, specification=ISO_19111)
093 Datum getDatum();
094 }