root / org.gvsig.proj / branches / refactor2018 / org.gvsig.proj / org.gvsig.proj.catalog / org.gvsig.proj.catalog.api / src / main / java / org / gvsig / proj / catalog / datum / Datum.java @ 817
History | View | Annotate | Download (7.53 KB)
1 |
/**
|
---|---|
2 |
* gvSIG. Desktop Geographic Information System.
|
3 |
*
|
4 |
* Copyright (C) 2018 gvSIG Association.
|
5 |
*
|
6 |
* This file has been adapted from GeoAPI, see
|
7 |
* the original copyright headers bellow.
|
8 |
*
|
9 |
* This program is free software; you can redistribute it and/or
|
10 |
* modify it under the terms of the GNU General Public License
|
11 |
* as published by the Free Software Foundation; either version 2
|
12 |
* of the License, or (at your option) any later version.
|
13 |
*
|
14 |
* This program is distributed in the hope that it will be useful,
|
15 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
16 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
17 |
* GNU General Public License for more details.
|
18 |
*
|
19 |
* You should have received a copy of the GNU General Public License
|
20 |
* along with this program; if not, write to the Free Software
|
21 |
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
22 |
* MA 02110-1301, USA.
|
23 |
*
|
24 |
* For any additional information, do not hesitate to contact us
|
25 |
* at info AT gvsig.com, or visit our website www.gvsig.com.
|
26 |
*
|
27 |
* ----------
|
28 |
*
|
29 |
* GeoAPI - Java interfaces for OGC/ISO standards
|
30 |
* http://www.geoapi.org
|
31 |
*
|
32 |
* Copyright (C) 2004-2017 Open Geospatial Consortium, Inc.
|
33 |
* All Rights Reserved. http://www.opengeospatial.org/ogc/legal
|
34 |
*
|
35 |
* Permission to use, copy, and modify this software and its documentation, with
|
36 |
* or without modification, for any purpose and without fee or royalty is hereby
|
37 |
* granted, provided that you include the following on ALL copies of the software
|
38 |
* and documentation or portions thereof, including modifications, that you make:
|
39 |
*
|
40 |
* 1. The full text of this NOTICE in a location viewable to users of the
|
41 |
* redistributed or derivative work.
|
42 |
* 2. Notice of any changes or modifications to the OGC files, including the
|
43 |
* date changes were made.
|
44 |
*
|
45 |
* THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
|
46 |
* NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
|
47 |
* TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
|
48 |
* THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
|
49 |
* PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
|
50 |
*
|
51 |
* COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
|
52 |
* CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
|
53 |
*
|
54 |
* The name and trademarks of copyright holders may NOT be used in advertising or
|
55 |
* publicity pertaining to the software without specific, written prior permission.
|
56 |
* Title to copyright in this software and any associated documentation will at all
|
57 |
* times remain with copyright holders.
|
58 |
*/
|
59 |
package org.gvsig.proj.catalog.datum; |
60 |
|
61 |
import java.util.Date; |
62 |
|
63 |
/**
|
64 |
* Specifies the relationship of a coordinate system to the earth, thus creating a coordinate
|
65 |
* reference system. For geodetic and vertical coordinate reference systems, the datum relates
|
66 |
* the coordinate system to the Earth. With other types of coordinate reference systems,
|
67 |
* the datum may relate the coordinate system to another physical or virtual object.
|
68 |
*
|
69 |
* <p>A datum uses a parameter or set of parameters that determine the location of the origin of the
|
70 |
* coordinate reference system.</p>
|
71 |
*
|
72 |
* Note: gvSIG derived these interfaces from GeoAPI in order to have a simpler API and also to
|
73 |
* avoid namespace collisions (e.g. GeoAPI 3 vs GeoTools interfaces). There is no plans
|
74 |
* to evolve these interfaces to adapt them to future GeoAPI versions.
|
75 |
*
|
76 |
* @author gvSIG Team
|
77 |
* @author Martin Desruisseaux (IRD)
|
78 |
*
|
79 |
* @see org.opengis.referencing.cs.CoordinateSystem
|
80 |
* @see org.opengis.referencing.crs.CoordinateReferenceSystem
|
81 |
*/
|
82 |
public interface Datum { |
83 |
/**
|
84 |
* A common name for this datum
|
85 |
*
|
86 |
* @return the name, or {@code null} if none.
|
87 |
*/
|
88 |
String getName();
|
89 |
|
90 |
|
91 |
/**
|
92 |
* Gets a code that references an unambiguous definition of the datum for
|
93 |
* some authority. Examples: "EPSG:6326", "EPSG:6258".
|
94 |
*
|
95 |
* @return the datum identifier or null if not available
|
96 |
*/
|
97 |
String getIdentifier();
|
98 |
|
99 |
/**
|
100 |
* A description, possibly including coordinates of an identified point or points, of the
|
101 |
* relationship used to anchor the coordinate system to the Earth or alternate object.
|
102 |
* Also known as the "origin", especially for Engineering and Image Datums.
|
103 |
*
|
104 |
* <ul>
|
105 |
* <li>For a GeodeticDatum, this anchor may be a point known as the fundamental point,
|
106 |
* which is traditionally the point where the relationship between geoid and ellipsoid is defined,
|
107 |
* together with a direction from that point. In other cases, the anchor may consist of a
|
108 |
* number of points. In those cases, the parameters defining the geoid/ellipsoid relationship
|
109 |
* have then been averaged for these points, and the coordinates of the points adopted as the
|
110 |
* datum definition.</li>
|
111 |
*
|
112 |
* <li>For an EngineeringDatum, the anchor may be an identified physical point with the
|
113 |
* orientation defined relative to the object.</li>
|
114 |
*
|
115 |
* <li>For an ImageDatum, the anchor point is usually either the centre of the image or the
|
116 |
* corner of the image. The coordinate system orientation is defined through the
|
117 |
* {@link org.opengis.referencing.cs.AxisDirection} class.</li>
|
118 |
*
|
119 |
* <li>For a TemporalDatum, this attribute is not defined. Instead of the anchor point,
|
120 |
* a temporal datum carries a separate {@linkplain TemporalDatum#getOrigin() time origin}
|
121 |
* of type {@link Date}.</li>
|
122 |
* </ul>
|
123 |
*
|
124 |
* @return a description of the anchor point, or {@code null} if none.
|
125 |
*/
|
126 |
String getAnchorPoint();
|
127 |
|
128 |
/**
|
129 |
* The time after which this datum definition is valid. This time may be precise (e.g. 1997
|
130 |
* for IRTF97) or merely a year (e.g. 1983 for NAD83). In the latter case, the epoch usually
|
131 |
* refers to the year in which a major recalculation of the geodetic control network, underlying
|
132 |
* the datum, was executed or initiated.
|
133 |
*
|
134 |
* <p>An old datum can remain valid after a new datum is defined.
|
135 |
* Alternatively, a datum may be superseded by a later datum, in which case the realization epoch
|
136 |
* for the new datum defines the upper limit for the validity of the superseded datum.</p>
|
137 |
*
|
138 |
* @return the datum realization epoch, or {@code null} if not available.
|
139 |
*/
|
140 |
Date getRealizationEpoch();
|
141 |
|
142 |
/**
|
143 |
* If the datum is a geodetic datum, it returns the ellipsoid
|
144 |
*
|
145 |
* @return the ellipsoid or null if the datum does not have an ellipsoid
|
146 |
*/
|
147 |
Ellipsoid getEllipsoid(); |
148 |
|
149 |
/**
|
150 |
* If the datum is a geodetic datum, returns the prime meridian.
|
151 |
*
|
152 |
* @return the prime meridian, or null if the datum does not have a prime
|
153 |
* meridian
|
154 |
*/
|
155 |
PrimeMeridian getPrimeMeridian(); |
156 |
|
157 |
/**
|
158 |
* Whether this datum is a geodetic datum. A geodetic datum defines an ellipsoid and
|
159 |
* the location and precise orientation in 3-dimensional space of this ellipsoid in
|
160 |
* relation to the Earth.
|
161 |
*
|
162 |
* @return true if the datum is geodetic, false otherwise
|
163 |
*/
|
164 |
boolean isGeodetic();
|
165 |
|
166 |
/**
|
167 |
* Whether this datum is a vertical datum
|
168 |
*
|
169 |
* @return true if this is a vertical datum, false otherwise
|
170 |
*/
|
171 |
boolean isVertical();
|
172 |
|
173 |
/**
|
174 |
* The type of the vertical datum.
|
175 |
*
|
176 |
* @return the type of the vertical datum, or null if this datum is not a
|
177 |
* vertical datum
|
178 |
*
|
179 |
* @see #getAnchorPoint()
|
180 |
*/
|
181 |
VerticalDatumType getVerticalDatumType(); |
182 |
|
183 |
} |