001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/model/crs/CoordinateSystem.java $
002 /*---------------- FILE HEADER ------------------------------------------
003
004 This file is part of deegree
005 Copyright (C) 2001-2008 by:
006 EXSE, Department of Geography, University of Bonn
007 http://www.giub.uni-bonn.de/deegree/
008 lat/lon GmbH
009 http://www.lat-lon.de
010
011 This library is free software; you can redistribute it and/or
012 modify it under the terms of the GNU Lesser General Public
013 License as published by the Free Software Foundation; either
014 version 2.1 of the License, or (at your option) any later version.
015
016 This library is distributed in the hope that it will be useful,
017 but WITHOUT ANY WARRANTY; without even the implied warranty of
018 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019 Lesser General Public License for more details.
020
021 You should have received a copy of the GNU Lesser General Public
022 License along with this library; if not, write to the Free Software
023 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
024
025 Contact:
026
027 Andreas Poth
028 lat/lon GmbH
029 Aennchenstr. 19
030 53177 Bonn
031 Germany
032 E-Mail: poth@lat-lon.de
033
034 Klaus Greve
035 Department of Geography
036 University of Bonn
037 Meckenheimer Allee 166
038 53115 Bonn
039 Germany
040 E-Mail: klaus.greve@giub.uni-bonn.de
041
042 ---------------------------------------------------------------------------*/
043 package org.deegree.model.crs;
044
045 // OpenGIS dependencies
046 import java.net.URI;
047
048 import org.deegree.datatypes.QualifiedName;
049
050 /**
051 * A coordinate system is a mathematical space, where the elements of the space are called positions. Each position is
052 * described by a list of numbers. The length of the list corresponds to the dimension of the coordinate system. So in a
053 * 2D coordinate system each position is described by a list containing 2 numbers. <br>
054 * <br>
055 * However, in a coordinate system, not all lists of numbers correspond to a position - some lists may be outside the
056 * domain of the coordinate system. For example, in a 2D Lat/Lon coordinate system, the list (91,91) does not correspond
057 * to a position. <br>
058 * <br>
059 * Some coordinate systems also have a mapping from the mathematical space into locations in the real world. So in a
060 * Lat/Lon coordinate system, the mathematical position (lat, long) corresponds to a location on the surface of the
061 * Earth. This mapping from the mathematical space into real-world locations is called a Datum.
062 *
063 * @version $Revision: 9528 $
064 * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
065 * @author last edited by: $Author: hrubach $
066 *
067 * @version 1.0. $Revision: 9528 $, $Date: 2008-01-14 16:24:05 +0100 (Mo, 14 Jan 2008) $
068 *
069 * @since 2.0
070 */
071 public class CoordinateSystem extends QualifiedName {
072
073 /**
074 *
075 */
076 private static final long serialVersionUID = -170831086069691683L;
077
078 private org.deegree.crs.coordinatesystems.CoordinateSystem realCRS;
079
080 private final String requestedID;
081
082 /**
083 *
084 * @param prefix
085 * must be not null
086 * @param localName
087 * @param namespace
088 * @deprecated use {@link #CoordinateSystem(org.deegree.crs.coordinatesystems.CoordinateSystem, String)} instead
089 */
090 @Deprecated
091 CoordinateSystem( String prefix, String localName, URI namespace ) {
092 super( prefix.toLowerCase(), localName, namespace );
093 requestedID = localName;
094 }
095
096 /**
097 *
098 * @param name
099 * @param namespace
100 * @deprecated use {@link #CoordinateSystem(org.deegree.crs.coordinatesystems.CoordinateSystem, String)}
101 */
102 @Deprecated
103 CoordinateSystem( String name, URI namespace ) {
104 super( name, namespace );
105 requestedID = name;
106 }
107
108 /**
109 * e.g. epgs:4326, should not be used.
110 *
111 * @param name
112 * @deprecated use {@link #CoordinateSystem(org.deegree.crs.coordinatesystems.CoordinateSystem, String)}
113 */
114 @Deprecated
115 protected CoordinateSystem( String name ) {
116 super( name );
117 requestedID = name;
118 }
119
120 /**
121 * Creates a CoordinateSystem as a wrapper to the real CRS.
122 *
123 * @param realCRS
124 */
125 CoordinateSystem( org.deegree.crs.coordinatesystems.CoordinateSystem realCRS, String requestedID ) {
126 super( realCRS.getIdentifier() );
127 this.realCRS = realCRS;
128 this.requestedID = requestedID;
129 }
130
131 /**
132 * returns the name of the CRS, this method is actually mapped to {@link #getIdentifier()}
133 *
134 * @return the name of the CRS
135 * @deprecated use {@link #getIdentifier()} instead
136 */
137 @Deprecated
138 public String getName() {
139 return getIdentifier();
140 }
141
142 /**
143 * This method returns the requested id (given in the constructor) and not the
144 * {@link org.deegree.crs.coordinatesystems.CoordinateSystem#getIdentifier()} which only returns the first
145 * configured id.
146 *
147 * @return the requested id.
148 */
149 public String getIdentifier() {
150 return requestedID;
151 }
152
153 /**
154 * Since the crs uses a different namespace system as {@link QualifiedName} this method only returns the {@link #getIdentifier()}.
155 */
156 @Override
157 public String getPrefixedName(){
158 return getIdentifier();
159 }
160
161 /**
162 * returns the CRSs code. In case of EPSG:4326 it will be 4326; in case of adv:DE_DHDN_3GK2_NW177 it will be
163 * DE_DHDN_3GK2_NW177
164 *
165 * @return the CRSs code
166 * @deprecated has no relevance, returns a bogus value.
167 */
168 @Deprecated
169 public String getCode() {
170 return getLocalName();
171 }
172
173 /**
174 * returns the units of the encapsulated CRS
175 *
176 * @return the units of the encapsulated CRS
177 */
178 public String getUnits() {
179 return realCRS.getUnits().toString();
180 }
181
182 /**
183 * @return the dimension of the encapsulated CRS
184 */
185 public int getDimension() {
186 return realCRS.getDimension();
187 }
188
189 /**
190 * @return the encapsulated CRS.
191 */
192 public org.deegree.crs.coordinatesystems.CoordinateSystem getCRS() {
193 return realCRS;
194 }
195
196 @Override
197 public boolean equals( Object other ) {
198 if ( other != null && other instanceof CoordinateSystem ) {
199 final CoordinateSystem that = (CoordinateSystem) other;
200 return this.realCRS.equals( that.realCRS );
201 }
202 return false;
203 }
204 }