Package org.apache.sis.referencing.crs
Class DefaultGeographicCRS
- All Implemented Interfaces:
Serializable
,Formattable
,Deprecable
,LenientComparable
,org.opengis.referencing.crs.CoordinateReferenceSystem
,org.opengis.referencing.crs.GeodeticCRS
,org.opengis.referencing.crs.GeographicCRS
,org.opengis.referencing.crs.SingleCRS
,org.opengis.referencing.IdentifiedObject
,org.opengis.referencing.ReferenceSystem
public class DefaultGeographicCRS
extends DefaultGeodeticCRS
implements org.opengis.referencing.crs.GeographicCRS
A 2- or 3-dimensional coordinate reference system based on an ellipsoidal approximation of the geoid.
This provides an accurate representation of the geometry of geographic features
for a large portion of the earth's surface.
Used with datum type:
Geodetic.
Used with coordinate system type:
Ellipsoidal.
Creating new geographic 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 geographic CRS. The other choices provide more freedom.- Create a
GeographicCRS
from one of the static convenience shortcuts listed inCommonCRS.geographic()
orCommonCRS.geographic3D()
. - Create a
GeographicCRS
from an identifier in a database by invokingGeodeticAuthorityFactory.createGeographicCRS(String)
. - Create a
GeographicCRS
by invoking theCRSFactory.createGeographicCRS(…)
method (implemented for example byGeodeticObjectFactory
). - Create a
GeographicCRS
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.6
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final byte[]
Codes in the CRS namespace for each code listed in theEPSG_CODES
list.private static final short[]
Some codes in the EPSG namespace, in ascending order.private 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.DefaultGeographicCRS
(Map<String, ?> properties, org.opengis.referencing.datum.GeodeticDatum datum, org.opengis.referencing.cs.EllipsoidalCS cs) Creates a coordinate reference system from the given properties, datum and coordinate system.(package private)
DefaultGeographicCRS
(org.opengis.referencing.crs.GeodeticCRS crs) ForSC_GeographicCRS
JAXB adapter only.protected
DefaultGeographicCRS
(org.opengis.referencing.crs.GeographicCRS crs) Constructs a new coordinate reference system with the same values than the specified one. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultGeographicCRS
castOrCopy
(org.opengis.referencing.crs.GeographicCRS 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.org.opengis.referencing.cs.EllipsoidalCS
Returns the coordinate system.final org.opengis.referencing.datum.GeodeticDatum
getDatum()
Returns the geodetic datum associated to this geographic CRS.Class
<? extends org.opengis.referencing.crs.GeographicCRS> Returns the GeoAPI interface implemented by this class.Methods inherited from class org.apache.sis.referencing.crs.AbstractCRS
castOrCopy, computeHashCode, equals, formatCS, getCached, 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.IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
Methods inherited from interface org.opengis.referencing.ReferenceSystem
getDomainOfValidity, getScope
-
Field Details
-
EPSG_CODES
private static final short[] EPSG_CODESSome codes in the EPSG namespace, in ascending order. Used for mapping toCRS_CODES
. -
CRS_CODES
private static final byte[] CRS_CODESCodes in the CRS namespace for each code listed in theEPSG_CODES
list. -
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
-
Constructor Details
-
DefaultGeographicCRS
public DefaultGeographicCRS(Map<String, ?> properties, org.opengis.referencing.datum.GeodeticDatum datum, org.opengis.referencing.cs.EllipsoidalCS 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 two- or three-dimensional coordinate system.- See Also:
-
DefaultGeographicCRS
protected DefaultGeographicCRS(org.opengis.referencing.crs.GeographicCRS 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:
-
DefaultGeographicCRS
private DefaultGeographicCRS()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. -
DefaultGeographicCRS
DefaultGeographicCRS(org.opengis.referencing.crs.GeodeticCRS crs) ForSC_GeographicCRS
JAXB adapter only. This is needed because GML does not have "GeographicCRS" type. Instead, the unmarshalling process will give us a "GeodeticCRS" object with the constraint that the coordinate system shall be ellipsoidal. This constructor will be invoked for converting the GeodeticCRS instance to a GeographicCRS instance.
-
-
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 returnsGeographicCRS.class
.Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not defineGeographicCRS
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:
GeographicCRS.class
or a user-defined sub-interface.
-
getDatum
public final org.opengis.referencing.datum.GeodeticDatum getDatum()Returns the geodetic datum associated to this geographic 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 geographic CRS.
-
getCoordinateSystem
public org.opengis.referencing.cs.EllipsoidalCS getCoordinateSystem()Returns the coordinate system.- Specified by:
getCoordinateSystem
in interfaceorg.opengis.referencing.crs.CoordinateReferenceSystem
- Specified by:
getCoordinateSystem
in interfaceorg.opengis.referencing.crs.GeographicCRS
- Specified by:
getCoordinateSystem
in interfaceorg.opengis.referencing.crs.SingleCRS
- Overrides:
getCoordinateSystem
in classAbstractCRS
- Returns:
- the coordinate system.
-
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.Special case
If the first axis is the longitude in the [-180 … +180]° range and the identifier is EPSG:4267, EPSG:4269 or EPSG:4326, then this method magically add the CRS:27, CRS:83 or CRS:84 identifier. Without this special case, the normal behavior would be no identifier. The expected behavior is thatCommonCRS.WGS84.normalizedGeographic()
returns a CRS having the "CRS:84" identifier.- Overrides:
createSameType
in classDefaultGeodeticCRS
-
formatTo
Formats this CRS as a Well Known TextGeodeticCRS[…]
element.Example: Well-Known Text (version 2) of a geographic coordinate reference system using the WGS 84 datum.Same coordinate reference system using WKT 1.
- Overrides:
formatTo
in classDefaultGeodeticCRS
- Parameters:
formatter
- the formatter where to format the inner content of this WKT element.- Returns:
"GeodeticCRS"
(WKT 2) or"GeogCS"
(WKT 1).- See Also:
-