/*
* GeoTools - The Open Source Java GIS Toolkit
* http://geotools.org
*
* (C) 2001-2008, Open Source Geospatial Foundation (OSGeo)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* This package contains documentation from OpenGIS specifications.
* OpenGIS consortium's work is fully acknowledged here.
*/
package org.geotools.referencing.crs;
import java.util.Collections;
import java.util.Map;
import javax.measure.unit.Unit;
import org.opengis.referencing.cs.CartesianCS;
import org.opengis.referencing.cs.SphericalCS;
import org.opengis.referencing.crs.GeocentricCRS;
import org.opengis.referencing.datum.GeodeticDatum;
import org.geotools.referencing.wkt.Formatter;
import org.geotools.referencing.AbstractReferenceSystem;
import org.geotools.referencing.cs.DefaultCartesianCS;
import org.geotools.referencing.cs.DefaultSphericalCS;
import org.geotools.referencing.datum.DefaultGeodeticDatum;
import org.geotools.resources.i18n.VocabularyKeys;
/**
* A 3D coordinate reference system with the origin at the approximate centre of mass of the earth.
* A geocentric CRS deals with the earth's curvature by taking a 3D spatial view, which obviates
* the need to model the earth's curvature.
*
* <TABLE CELLPADDING='6' BORDER='1'>
* <TR BGCOLOR="#EEEEFF"><TH NOWRAP>Used with CS type(s)</TH></TR>
* <TR><TD>
* {@link CartesianCS Cartesian},
* {@link SphericalCS Spherical}
* </TD></TR></TABLE>
*
* @since 2.1
*
* @source $URL$
* @version $Id$
* @author Martin Desruisseaux (IRD)
*/
public class DefaultGeocentricCRS extends AbstractSingleCRS implements GeocentricCRS {
/**
* Serial number for interoperability with different versions.
*/
private static final long serialVersionUID = 6784642848287659827L;
/**
* The default geocentric CRS with a
* {@linkplain DefaultCartesianCS#GEOCENTRIC cartesian coordinate system}.
* Prime meridian is Greenwich, geodetic datum is WGS84 and linear units are metres.
* The <var>X</var> axis points towards the prime meridian.
* The <var>Y</var> axis points East.
* The <var>Z</var> axis points North.
*/
public static final DefaultGeocentricCRS CARTESIAN = new DefaultGeocentricCRS(
name(VocabularyKeys.CARTESIAN),
DefaultGeodeticDatum.WGS84, DefaultCartesianCS.GEOCENTRIC);
/**
* The default geocentric CRS with a
* {@linkplain DefaultSphericalCS#GEOCENTRIC spherical coordinate system}.
* Prime meridian is Greenwich, geodetic datum is WGS84 and linear units are metres.
*/
public static final DefaultGeocentricCRS SPHERICAL = new DefaultGeocentricCRS(
name(VocabularyKeys.SPHERICAL),
DefaultGeodeticDatum.WGS84, DefaultSphericalCS.GEOCENTRIC);
/**
* Constructs a new geocentric CRS with the same values than the specified one.
* This copy constructor provides a way to wrap an arbitrary implementation into a
* Geotools one or a user-defined one (as a subclass), usually in order to leverage
* some implementation-specific API. This constructor performs a shallow copy,
* i.e. the properties are not cloned.
*
* @param crs The coordinate reference system to copy.
*
* @since 2.2
*/
public DefaultGeocentricCRS(final GeocentricCRS crs) {
super(crs);
}
/**
* Constructs a geocentric CRS from a name.
*
* @param name The name.
* @param datum The datum.
* @param cs The coordinate system.
*/
public DefaultGeocentricCRS(final String name,
final GeodeticDatum datum,
final CartesianCS cs)
{
this(Collections.singletonMap(NAME_KEY, name), datum, cs);
}
/**
* Constructs a geocentric CRS from a name.
*
* @param name The name.
* @param datum The datum.
* @param cs The coordinate system.
*/
public DefaultGeocentricCRS(final String name,
final GeodeticDatum datum,
final SphericalCS cs)
{
this(Collections.singletonMap(NAME_KEY, name), datum, cs);
}
/**
* Constructs a geographic CRS from a set of properties. The properties are given unchanged to
* the {@linkplain AbstractReferenceSystem#AbstractReferenceSystem(Map) super-class constructor}.
*
* @param properties Set of properties. Should contains at least {@code "name"}.
* @param datum The datum.
* @param cs The coordinate system.
*/
public DefaultGeocentricCRS(final Map<String,?> properties,
final GeodeticDatum datum,
final CartesianCS cs)
{
super(properties, datum, cs);
}
/**
* Constructs a geographic CRS from a set of properties.
* The properties are given unchanged to the
* {@linkplain AbstractReferenceSystem#AbstractReferenceSystem(Map) super-class constructor}.
*
* @param properties Set of properties. Should contains at least {@code "name"}.
* @param datum The datum.
* @param cs The coordinate system.
*/
public DefaultGeocentricCRS(final Map<String,?> properties,
final GeodeticDatum datum,
final SphericalCS cs)
{
super(properties, datum, cs);
}
/**
* Returns the datum.
*/
@Override
public GeodeticDatum getDatum() {
return (GeodeticDatum) super.getDatum();
}
/**
* Returns a hash value for this geocentric CRS.
*
* @return The hash code value. This value doesn't need to be the same
* in past or future versions of this class.
*/
@Override
public int hashCode() {
return (int)serialVersionUID ^ super.hashCode();
}
/**
* Format the inner part of a
* <A HREF="http://geoapi.sourceforge.net/snapshot/javadoc/org/opengis/referencing/doc-files/WKT.html"><cite>Well
* Known Text</cite> (WKT)</A> element.
*
* @param formatter The formatter to use.
* @return The name of the WKT element type, which is {@code "GEOCCS"}.
*/
@Override
protected String formatWKT(final Formatter formatter) {
final Unit<?> unit = getUnit();
formatter.append(datum);
formatter.append(((GeodeticDatum) datum).getPrimeMeridian());
formatter.append(unit);
final int dimension = coordinateSystem.getDimension();
for (int i=0; i<dimension; i++) {
formatter.append(coordinateSystem.getAxis(i));
}
if (unit == null) {
formatter.setInvalidWKT(GeocentricCRS.class);
}
return "GEOCCS";
}
}