Module org.apache.sis.referencing
Package org.apache.sis.referencing.datum
Class DefaultPrimeMeridian
Object
FormattableObject
AbstractIdentifiedObject
DefaultPrimeMeridian
- All Implemented Interfaces:
Serializable
,Formattable
,Deprecable
,LenientComparable
,PrimeMeridian
,IdentifiedObject
Defines the origin from which longitude values are determined.
Creating new prime meridian 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). In particular, the EPSG repository provides definitions for many prime meridians, and Apache SIS provides convenience shortcuts for some of them.Choice 1 in the following list is the easiest but most restrictive way to get a prime meridian. The other choices provide more freedom. Each choice delegates its work to the subsequent items (in the default configuration), so this list can be seen as top to bottom API.
- Create a
PrimeMeridian
from one of the static convenience shortcuts listed inCommonCRS.primeMeridian()
. - Create a
PrimeMeridian
from an identifier in a database by invokingDatumAuthorityFactory.createPrimeMeridian(String)
. - Create a
PrimeMeridian
by invoking theDatumFactory.createPrimeMeridian(…)
method (implemented for example byGeodeticObjectFactory
). - Create a
DefaultPrimeMeridian
by invoking the constructor.
PrimeMeridian pm = CommonCRS.WGS84.primeMeridian();
Immutability and thread safety
This class is immutable and thus thread-safe if the property values (not necessarily the map itself) 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 Summary
Fields inherited from class AbstractIdentifiedObject
DEPRECATED_KEY, LOCALE_KEY
Fields inherited from interface IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
-
Constructor Summary
ModifierConstructorDescriptionDefaultPrimeMeridian
(Map<String, ?> properties, double greenwichLongitude, Unit<Angle> angularUnit) Creates a prime meridian from the given properties.protected
DefaultPrimeMeridian
(PrimeMeridian meridian) Creates a new prime meridian with the same values than the specified one. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultPrimeMeridian
castOrCopy
(PrimeMeridian object) Returns a SIS prime meridian implementation with the same values than the given arbitrary implementation.protected long
Invoked byhashCode()
for computing the hash code when first needed.boolean
equals
(Object object, ComparisonMode mode) Compares this prime meridian with the specified object for equality.protected String
Formats this prime meridian as a Well Known TextPrimeMeridian[…]
element.Returns the angular unit of the Greenwich longitude.double
Longitude of the prime meridian measured from the Greenwich meridian, positive eastward.double
getGreenwichLongitude
(Unit<Angle> unit) Returns the longitude value relative to the Greenwich Meridian, expressed in the specified units.Class
<? extends PrimeMeridian> Returns the GeoAPI interface implemented by this class.Methods inherited from class AbstractIdentifiedObject
castOrCopy, equals, formatTo, getAlias, getDescription, getDomains, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForName
Methods inherited from class FormattableObject
print, toString, toString, toWKT
Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
-
Constructor Details
-
DefaultPrimeMeridian
public DefaultPrimeMeridian(Map<String, ?> properties, double greenwichLongitude, Unit<Angle> angularUnit) Creates a prime meridian from the given properties. The properties map is given unchanged to 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()
- Parameters:
properties
- the properties to be given to the identified object.greenwichLongitude
- the longitude value relative to the Greenwich Meridian.angularUnit
- the angular unit of the longitude.- See Also:
-
DefaultPrimeMeridian
Creates a new prime meridian 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:
meridian
- the prime meridian to copy.- See Also:
-
-
Method Details
-
castOrCopy
Returns a SIS prime meridian 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 returnsPrimeMeridian.class
.Note for implementers
Subclasses usually do not need to override this method since GeoAPI does not definePrimeMeridian
sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.- Overrides:
getInterface
in classAbstractIdentifiedObject
- Returns:
PrimeMeridian.class
or a user-defined sub-interface.
-
getGreenwichLongitude
public double getGreenwichLongitude()Longitude of the prime meridian measured from the Greenwich meridian, positive eastward.- Specified by:
getGreenwichLongitude
in interfacePrimeMeridian
- Returns:
- the prime meridian Greenwich longitude, in angular unit.
-
getGreenwichLongitude
Returns the longitude value relative to the Greenwich Meridian, expressed in the specified units. This convenience method makes it easier to obtain longitude in decimal degrees using the following code, regardless of the underlying angular units of this prime meridian:double longitudeInDegrees = primeMeridian.getGreenwichLongitude(Units.DEGREE);
- Parameters:
unit
- the unit in which to express longitude.- Returns:
- the Greenwich longitude in the given units.
-
getAngularUnit
Returns the angular unit of the Greenwich longitude.- Specified by:
getAngularUnit
in interfacePrimeMeridian
- Returns:
- the angular unit of the Greenwich longitude.
-
equals
Compares this prime meridian with the specified object for equality.- Specified by:
equals
in interfaceLenientComparable
- Overrides:
equals
in classAbstractIdentifiedObject
- Parameters:
object
- the object to compare tothis
.mode
-STRICT
for performing a strict comparison, orIGNORE_METADATA
for comparing only properties relevant to coordinate transformations.- Returns:
true
if both objects are equal.- See Also:
-
computeHashCode
protected long computeHashCode()Invoked byhashCode()
for computing the hash code when first needed. SeeAbstractIdentifiedObject.computeHashCode()
for more information.- Overrides:
computeHashCode
in classAbstractIdentifiedObject
- Returns:
- the hash code value. This value may change in any future Apache SIS version.
-
formatTo
Formats this prime meridian as a Well Known TextPrimeMeridian[…]
element.- Overrides:
formatTo
in classAbstractIdentifiedObject
- Parameters:
formatter
- the formatter where to format the inner content of this WKT element.- Returns:
"PrimeMeridian"
(WKT 2) or"PrimeM"
(WKT 1).- See Also:
-