Package org.apache.sis.referencing.crs

Class DefaultGeocentricCRS

java.lang.Object
org.apache.sis.io.wkt.FormattableObject
org.apache.sis.referencing.AbstractIdentifiedObject
org.apache.sis.referencing.AbstractReferenceSystem
org.apache.sis.referencing.crs.AbstractCRS
org.apache.sis.referencing.crs.DefaultGeocentricCRS
All Implemented Interfaces:
Serializable, Formattable, Deprecable, LenientComparable, org.opengis.referencing.crs.CoordinateReferenceSystem, org.opengis.referencing.crs.GeocentricCRS, org.opengis.referencing.crs.GeodeticCRS, org.opengis.referencing.crs.SingleCRS, org.opengis.referencing.IdentifiedObject, org.opengis.referencing.ReferenceSystem
public class DefaultGeocentricCRS extends AbstractCRS implements org.opengis.referencing.crs.GeocentricCRS
A 3-dimensional 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 3-dimensional spatial view, which obviates the need to model the earth's curvature.

Used with datum type: Geodetic.
Used with coordinate system types: Cartesian or Spherical.

Creating new geocentric CRS instances

New instances can be created either directly by specifying all information to a factory method (choices 3 and 4 below), or indirectly by specifying the identifier of an entry in a database (choices 1 and 2 below). Choice 1 in the following list is the easiest but most restrictive way to get a geocentric CRS. The other choices provide more freedom.
  1. Create a GeocentricCRS from one of the static convenience shortcuts listed in CommonCRS.geocentric().
  2. Create a GeocentricCRS from an identifier in a database by invoking GeodeticAuthorityFactory.createGeocentricCRS(String).
  3. Create a GeocentricCRS by invoking the CRSFactory.createGeocentricCRS(…) method (implemented for example by GeodeticObjectFactory).
  4. Create a GeocentricCRS by invoking the constructor.
Example: the following code gets a geocentric CRS using the World Geodetic System 1984 datum:

Immutability and thread safety

This class is immutable and thus thread-safe if the property values (not necessarily the map itself), the coordinate system and the datum instances given to the constructor are also immutable. Unless otherwise noted in the javadoc, this condition holds if all components were created using only SIS factories and static constants.
Since:
0.4
Version:
0.4
Author:
Martin Desruisseaux (IRD, Geomatys)
See Also:

  • Constructor Details

  • Method Details

    • castOrCopy

      public static DefaultGeocentricCRS castOrCopy(org.opengis.referencing.crs.GeocentricCRS object)
      Returns a SIS coordinate reference system implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a SIS implementation, then the given object is returned unchanged. Otherwise a new SIS implementation is created and initialized to the attribute values of the given object.
      Parameters:
      object - the object to get as a SIS implementation, or null if none.
      Returns:
      a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

    • getInterface

      public Class<? extends org.opengis.referencing.crs.GeocentricCRS> getInterface()
      Returns the GeoAPI interface implemented by this class. The SIS implementation returns GeocentricCRS.class.
      Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not define GeocentricCRS sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.
      Returns:
      GeocentricCRS.class or a user-defined sub-interface.

    • getDatum

      public final org.opengis.referencing.datum.GeodeticDatum getDatum()
      Returns the geodetic datum associated to this geocentric CRS. This is the datum given at construction time.
      Specified by:
      getDatum in interface org.opengis.referencing.crs.GeodeticCRS
      Specified by:
      getDatum in interface org.opengis.referencing.crs.SingleCRS
      Returns:
      the geodetic datum associated to this geocentric CRS.

    • forConvention

      public DefaultGeocentricCRS forConvention(AxesConvention convention)
      Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention. If this CRS is already compatible with the given convention, then this method returns this.
      Overrides:
      forConvention in class AbstractCRS
      Parameters:
      convention - the axes convention for which a coordinate reference system is desired.
      Returns:
      a coordinate reference system compatible with the given convention (may be this).
      See Also:

    • formatTo

      protected String formatTo(Formatter formatter)
      Formats this CRS as a Well Known Text GeodeticCRS[…] element.
      Example: Well-Known Text (version 2) of a geocentric coordinate reference system using the WGS 84 datum.

      Same coordinate reference system using WKT 1. Note that axis directions are totally different.

      Parameters:
      formatter - the formatter where to format the inner content of this WKT element.
      Returns:
      "GeodeticCRS" (WKT 2) or "GeocCS" (WKT 1).
      See Also: