Class DefaultGeographicCRS
Object
FormattableObject
AbstractIdentifiedObject
AbstractReferenceSystem
AbstractCRS
DefaultGeographicCRS
- All Implemented Interfaces:
- Serializable,- Formattable,- Deprecable,- LenientComparable,- Printable,- CoordinateReferenceSystem,- GeodeticCRS,- GeographicCRS,- SingleCRS,- IdentifiedObject,- ReferenceSystem
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 GeographicCRSfrom one of the static convenience shortcuts listed inCommonCRS.geographic()orCommonCRS.geographic3D().
- Create a GeographicCRSfrom an identifier in a database by invokingGeodeticAuthorityFactory.createGeographicCRS(String).
- Create a GeographicCRSby invoking theCRSFactory.createGeographicCRS(…)method (implemented for example byGeodeticObjectFactory).
- Create a GeographicCRSby invoking the constructor.
GeodeticDatum datum = CommonCRS.WGS84.geographic();
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
- See Also:
- 
Field SummaryFields inherited from class AbstractIdentifiedObjectDEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEYFields inherited from interface IdentifiedObjectALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEYFields inherited from interface ReferenceSystemDOMAIN_OF_VALIDITY_KEY, SCOPE_KEY
- 
Constructor SummaryConstructorsModifierConstructorDescriptionDefaultGeographicCRS(Map<String, ?> properties, GeodeticDatum datum, DefaultDatumEnsemble<GeodeticDatum> ensemble, EllipsoidalCS cs) Creates a coordinate reference system from the given properties, datum and coordinate system.DefaultGeographicCRS(Map<String, ?> properties, GeodeticDatum datum, EllipsoidalCS cs) Deprecated, for removal: This API element is subject to removal in a future version.protectedConstructs a new coordinate reference system with the same values as the specified one.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultGeographicCRScastOrCopy(GeographicCRS object) Returns a SIS coordinate reference system implementation with the same values as the given arbitrary implementation.forConvention(AxesConvention convention) Returns a CRS equivalent to this one but with axes rearranged according the given convention.protected StringFormats this CRS as a Well Known TextGeographicCRS[…]element.Returns the coordinate system.final GeodeticDatumReturns the geodetic reference frame associated to this geographic CRS.Returns a collection of datums which, for low accuracy requirements, may be considered to be insignificantly different from each other.Returns the ellipsoid which is indirectly (through a datum) associated to this CRS.Class<? extends GeographicCRS> Returns the GeoAPI interface implemented by this class.Returns the prime meridian which is indirectly (through a datum) associated to this CRS.Methods inherited from class AbstractCRScastOrCopyMethods inherited from class AbstractReferenceSystemgetDomainOfValidity, getScopeMethods inherited from class AbstractIdentifiedObjectcastOrCopy, equals, formatTo, getAlias, getDescription, getDomains, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForNameMethods inherited from class FormattableObjectprint, toString, toString, toWKTMethods inherited from class Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface IdentifiedObjectgetAlias, getIdentifiers, getName, getRemarks, toWKTMethods inherited from interface ReferenceSystemgetDomainOfValidity, getScope
- 
Constructor Details- 
DefaultGeographicCRSpublic DefaultGeographicCRS(Map<String, ?> properties, GeodeticDatum datum, DefaultDatumEnsemble<GeodeticDatum> ensemble, EllipsoidalCS cs) Creates a coordinate reference system from the given properties, datum and coordinate system. At least one of thedatumandensemblearguments shall be non-null. The properties given in argument follow the same rules as 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" ReferenceIdentifierorStringAbstractIdentifiedObject.getName()"alias" GenericNameorCharSequence(optionally as array)AbstractIdentifiedObject.getAlias()"identifiers" ReferenceIdentifier(optionally as array)AbstractIdentifiedObject.getIdentifiers()"domains" DefaultObjectDomain(optionally as array)AbstractIdentifiedObject.getDomains()"remarks" InternationalStringorStringAbstractIdentifiedObject.getRemarks()- Parameters:
- properties- the properties to be given to the coordinate reference system.
- datum- the datum, or- nullif the CRS is associated only to a datum ensemble.
- ensemble- collection of reference frames which for low accuracy requirements may be considered to be insignificantly different from each other, or- nullif there is no such ensemble.
- cs- the two- or three-dimensional coordinate system.
- Since:
- 1.5
- See Also:
 
- 
DefaultGeographicCRS@Deprecated(since="1.5", forRemoval=true) public DefaultGeographicCRS(Map<String, ?> properties, GeodeticDatum datum, EllipsoidalCS cs) Deprecated, for removal: This API element is subject to removal in a future version.ADefaultDatumEnsembleargument has been added.
- 
DefaultGeographicCRSConstructs a new coordinate reference system with the same values as 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:
 
 
- 
- 
Method Details- 
castOrCopyReturns a SIS coordinate reference system implementation with the same values as 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, or- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- 
getInterfaceReturns the GeoAPI interface implemented by this class. The SIS implementation returnsGeographicCRS.class.Note for implementersSubclasses usually do not need to override this method since GeoAPI does not defineGeographicCRSsub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.- Returns:
- GeographicCRS.classor a user-defined sub-interface.
 
- 
getPrimeMeridianReturns the prime meridian which is indirectly (through a datum) associated to this CRS. If the datum is non-null, then this method returns the datum prime meridian. Otherwise, if all members of the datum ensemble use the same prime meridian, then this method returns that meridian.- Returns:
- the prime meridian indirectly associated to this CRS.
- Throws:
- NoSuchElementException- if there is no datum and the ensemble does not contain at least one member.
- GeodeticException- if the prime meridian is not the same for all members of the datum ensemble.
- Since:
- 1.5
 
- 
getEllipsoidReturns the ellipsoid which is indirectly (through a datum) associated to this CRS. If the datum is non-null, then this method returns the datum ellipsoid. Otherwise, if all members of the datum ensemble use the same ellipsoid, then this method returns that ellipsoid.- Returns:
- the ellipsoid indirectly associated to this CRS.
- Throws:
- NoSuchElementException- if there is no datum and the ensemble does not contain at least one member.
- GeodeticException- if the ellipsoid is not the same for all members of the datum ensemble.
- Since:
- 1.5
 
- 
getDatumReturns the geodetic reference frame associated to this geographic CRS. This property may be null if this CRS is related to an object identified only by a datum ensemble.- Specified by:
- getDatumin interface- GeodeticCRS
- Specified by:
- getDatumin interface- SingleCRS
- Returns:
- the geodetic reference frame, or nullif this CRS is related to an object identified only by a datum ensemble.
 
- 
getDatumEnsembleReturns a collection of datums which, for low accuracy requirements, may be considered to be insignificantly different from each other. This property may be null if this CRS is related to an object identified only by a single datum.Warning: in a future SIS version, the return type may be changed to theorg.opengis.referencing.datum.DatumEnsembleinterface. This change is pending GeoAPI revision.- Returns:
- the datum ensemble, or nullif this CRS is related to an object identified only by a single datum.
- Since:
- 1.5
 
- 
getCoordinateSystemReturns the coordinate system.- Specified by:
- getCoordinateSystemin interface- CoordinateReferenceSystem
- Specified by:
- getCoordinateSystemin interface- GeographicCRS
- Specified by:
- getCoordinateSystemin interface- SingleCRS
- Overrides:
- getCoordinateSystemin class- AbstractCRS
- Returns:
- the coordinate system.
 
- 
forConventionReturns a CRS 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:
- forConventionin 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:
 
- 
formatToFormats this CRS as a Well Known TextGeographicCRS[…]element.ExampleWell-Known Text (version 2) of a geographic coordinate reference system using the WGS 84 datum.GeographicCRS["WGS 84", Datum["World Geodetic System 1984", Ellipsoid["WGS84", 6378137.0, 298.257223563, LengthUnit["metre", 1]]], PrimeMeridian["Greenwich", 0.0, AngleUnit["degree", 0.017453292519943295]], CS["ellipsoidal", 2], Axis["Latitude", north], Axis["Longitude", east], AngleUnit["degree", 0.017453292519943295], Area["World"], BBox[-90.00, -180.00, 90.00, 180.00], Scope["Used by GPS satellite navigation system."], Id["EPSG", 4326, Citation["IOGP"], URI["urn:ogc:def:crs:EPSG::4326"]]]Same coordinate reference system using WKT 1. GEOGCS["WGS 84", DATUM["World Geodetic System 1984", SPHEROID["WGS84", 6378137.0, 298.257223563]], PRIMEM["Greenwich", 0.0], UNIT["degree", 0.017453292519943295], AXIS["Latitude", NORTH], AXIS["Longitude", EAST], AUTHORITY["EPSG", "4326"]]- Parameters:
- formatter- the formatter where to format the inner content of this WKT element.
- Returns:
- "GeodeticCRS"(WKT 2) or- "GeogCS"(WKT 1).
- See Also:
 
 
- 
DefaultDatumEnsembleargument has been added.