Package org.apache.sis.referencing.crs
Class 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 DefaultGeodeticCRS
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.- Create a
GeocentricCRS
from one of the static convenience shortcuts listed inCommonCRS.geocentric()
. - Create a
GeocentricCRS
from an identifier in a database by invokingGeodeticAuthorityFactory.createGeocentricCRS(String)
. - Create a
GeocentricCRS
by invoking theCRSFactory.createGeocentricCRS(…)
method (implemented for example byGeodeticObjectFactory
). - Create a
GeocentricCRS
by invoking the constructor.
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
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final long
Serial number for inter-operability with different versions.Fields inherited from class org.apache.sis.referencing.AbstractIdentifiedObject
DEPRECATED_KEY, LOCALE_KEY
Fields inherited from interface org.opengis.referencing.IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
Fields inherited from interface org.opengis.referencing.ReferenceSystem
DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Constructs a new object in which every attributes are set to a null value.DefaultGeocentricCRS
(Map<String, ?> properties, org.opengis.referencing.datum.GeodeticDatum datum, org.opengis.referencing.cs.CartesianCS cs) Creates a coordinate reference system from the given properties, datum and coordinate system.private
DefaultGeocentricCRS
(Map<String, ?> properties, org.opengis.referencing.datum.GeodeticDatum datum, org.opengis.referencing.cs.CoordinateSystem cs) ForcreateSameType(Map, CoordinateSystem)
usage only.DefaultGeocentricCRS
(Map<String, ?> properties, org.opengis.referencing.datum.GeodeticDatum datum, org.opengis.referencing.cs.SphericalCS cs) Creates a coordinate reference system from the given properties, datum and coordinate system.protected
DefaultGeocentricCRS
(org.opengis.referencing.crs.GeocentricCRS crs) Constructs a new coordinate reference system with the same values than the specified one. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultGeocentricCRS
castOrCopy
(org.opengis.referencing.crs.GeocentricCRS object) Returns a SIS coordinate reference system implementation with the same values than the given arbitrary implementation.(package private) final AbstractCRS
createSameType
(Map<String, ?> properties, org.opengis.referencing.cs.CoordinateSystem cs) Returns a coordinate reference system of the same type than this CRS but with different axes.forConvention
(AxesConvention convention) Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention.protected String
Formats this CRS as a Well Known TextGeodeticCRS[…]
element.final org.opengis.referencing.datum.GeodeticDatum
getDatum()
Returns the geodetic datum associated to this geocentric CRS.Class<? extends org.opengis.referencing.crs.GeocentricCRS>
Returns the GeoAPI interface implemented by this class.Methods inherited from class org.apache.sis.referencing.crs.AbstractCRS
castOrCopy, computeHashCode, equals, formatCS, getCached, getCoordinateSystem, getCoordinateSystem, isBaseCRS, setCached, setCoordinateSystem
Methods inherited from class org.apache.sis.referencing.AbstractReferenceSystem
getDomainOfValidity, getScope
Methods inherited from class org.apache.sis.referencing.AbstractIdentifiedObject
castOrCopy, equals, formatTo, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForName
Methods inherited from class org.apache.sis.io.wkt.FormattableObject
print, toString, toString, toWKT
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.opengis.referencing.crs.GeocentricCRS
getCoordinateSystem
Methods inherited from interface org.opengis.referencing.IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
Methods inherited from interface org.opengis.referencing.ReferenceSystem
getDomainOfValidity, getScope
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
-
Constructor Details
-
DefaultGeocentricCRS
private DefaultGeocentricCRS(Map<String, ?> properties, org.opengis.referencing.datum.GeodeticDatum datum, org.opengis.referencing.cs.CoordinateSystem cs) ForcreateSameType(Map, CoordinateSystem)
usage only. This constructor does not verify the coordinate system type. -
DefaultGeocentricCRS
public DefaultGeocentricCRS(Map<String, ?> properties, org.opengis.referencing.datum.GeodeticDatum datum, org.opengis.referencing.cs.CartesianCS cs) Creates a coordinate reference system from the given properties, datum and coordinate system. The properties given in argument follow the same rules than for the super-class constructor. The following table is a reminder of main (not all) properties:Recognized properties (non exhaustive list) Property name Value type Returned by "name" ReferenceIdentifier
orString
AbstractIdentifiedObject.getName()
"alias" GenericName
orCharSequence
(optionally as array)AbstractIdentifiedObject.getAlias()
"identifiers" ReferenceIdentifier
(optionally as array)AbstractIdentifiedObject.getIdentifiers()
"remarks" InternationalString
orString
AbstractIdentifiedObject.getRemarks()
"domainOfValidity" Extent
AbstractReferenceSystem.getDomainOfValidity()
"scope" InternationalString
orString
AbstractReferenceSystem.getScope()
- Parameters:
properties
- the properties to be given to the coordinate reference system.datum
- the datum.cs
- the coordinate system, which must be three-dimensional.- See Also:
-
DefaultGeocentricCRS
public DefaultGeocentricCRS(Map<String, ?> properties, org.opengis.referencing.datum.GeodeticDatum datum, org.opengis.referencing.cs.SphericalCS cs) Creates a coordinate reference system from the given properties, datum and coordinate system. The properties given in argument are the same than for the above constructor.- Parameters:
properties
- the properties to be given to the coordinate reference system.datum
- the datum.cs
- the coordinate system.- See Also:
-
DefaultGeocentricCRS
protected DefaultGeocentricCRS(org.opengis.referencing.crs.GeocentricCRS crs) Constructs a new coordinate reference system with the same values than the specified one. This copy constructor provides a way to convert an arbitrary implementation into a SIS 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.
- Parameters:
crs
- the coordinate reference system to copy.- See Also:
-
DefaultGeocentricCRS
private DefaultGeocentricCRS()Constructs a new object in which every attributes are set to a null value. This is not a valid object. This constructor is strictly reserved to JAXB, which will assign values to the fields using reflection.
-
-
Method Details
-
castOrCopy
Returns a SIS coordinate reference system implementation with the same values than the given arbitrary implementation. If the given object isnull
, then this method returnsnull
. 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, ornull
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
Returns the GeoAPI interface implemented by this class. The SIS implementation returnsGeocentricCRS.class
.Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not defineGeocentricCRS
sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.- Overrides:
getInterface
in classDefaultGeodeticCRS
- 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 interfaceorg.opengis.referencing.crs.GeodeticCRS
- Specified by:
getDatum
in interfaceorg.opengis.referencing.crs.SingleCRS
- Overrides:
getDatum
in classDefaultGeodeticCRS
- Returns:
- the geodetic datum associated to this geocentric CRS.
-
forConvention
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 returnsthis
.- Overrides:
forConvention
in classAbstractCRS
- 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:
-
createSameType
final AbstractCRS createSameType(Map<String, ?> properties, org.opengis.referencing.cs.CoordinateSystem cs) Returns a coordinate reference system of the same type than this CRS but with different axes.- Overrides:
createSameType
in classDefaultGeodeticCRS
-
formatTo
Formats this CRS as a Well Known TextGeodeticCRS[…]
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.
- Overrides:
formatTo
in classDefaultGeodeticCRS
- Parameters:
formatter
- the formatter where to format the inner content of this WKT element.- Returns:
"GeodeticCRS"
(WKT 2) or"GeocCS"
(WKT 1).- See Also:
-