Package org.geotools.referencing.datum
Class DefaultPrimeMeridian
Object
Formattable
AbstractIdentifiedObject
DefaultPrimeMeridian
- All Implemented Interfaces:
Serializable
,PrimeMeridian
,IdentifiedObject
,PROJFormattable
public class DefaultPrimeMeridian
extends AbstractIdentifiedObject
implements PrimeMeridian, PROJFormattable
A prime meridian defines the origin from which longitude values are determined. The
name
initial
value is "Greenwich", and that value shall be used when the greenwich longitude
value is zero.- Since:
- 2.1
- Author:
- Martin Desruisseaux (IRD)
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final DefaultPrimeMeridian
The Greenwich meridian, with angular measurements in decimal degrees.Fields inherited from class AbstractIdentifiedObject
EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR
Fields inherited from class Formattable
SINGLE_LINE
Fields inherited from interface IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
-
Constructor Summary
ConstructorsConstructorDescriptionDefaultPrimeMeridian
(String name, double greenwichLongitude) Constructs a prime meridian from a name.DefaultPrimeMeridian
(String name, double greenwichLongitude, Unit<Angle> angularUnit) Constructs a prime meridian from a name.DefaultPrimeMeridian
(Map<String, ?> properties, double greenwichLongitude, Unit<Angle> angularUnit) Constructs a prime meridian from a set of properties.DefaultPrimeMeridian
(PrimeMeridian meridian) Constructs a new prime meridian with the same values than the specified one. -
Method Summary
Modifier and TypeMethodDescriptionboolean
equals
(AbstractIdentifiedObject object, boolean compareMetadata) Compare this prime meridian with the specified object for equality.formatPROJ
(PROJFormatter formatter) Format the inner part of a PROJFormattable object.protected String
Format the inner part of a Well Known Text (WKT) element.Unit<Angle>
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> targetUnit) Returns the longitude value relative to the Greenwich Meridian, expressed in the specified units.int
hashCode()
Returns a hash value for this prime meridian.Methods inherited from class AbstractIdentifiedObject
asSet, ensureAngularUnit, ensureLinearUnit, ensureNonNull, ensureNonNull, ensureTimeUnit, equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, nameMatches, nameMatches, nameMatches
Methods inherited from class Formattable
cleanupThreadLocals, toString, toWKT, toWKT, toWKT, toWKT
Methods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
-
Field Details
-
GREENWICH
The Greenwich meridian, with angular measurements in decimal degrees.
-
-
Constructor Details
-
DefaultPrimeMeridian
Constructs a new prime meridian with the same values than the specified one. This copy constructor provides a way to wrap an arbitrary implementation into a Geotools 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.- Since:
- 2.2
-
DefaultPrimeMeridian
Constructs a prime meridian from a name. ThegreenwichLongitude
value is assumed in decimal degrees.- Parameters:
name
- The datum name.greenwichLongitude
- The longitude value relative to the Greenwich Meridian.
-
DefaultPrimeMeridian
Constructs a prime meridian from a name.- Parameters:
name
- The datum name.greenwichLongitude
- The longitude value relative to the Greenwich Meridian.angularUnit
- The angular unit of the longitude.
-
DefaultPrimeMeridian
public DefaultPrimeMeridian(Map<String, ?> properties, double greenwichLongitude, Unit<Angle> angularUnit) Constructs a prime meridian from a set of properties. The properties map is given unchanged to the super-class constructor.- Parameters:
properties
- Set of properties. Should contains at least"name"
.greenwichLongitude
- The longitude value relative to the Greenwich Meridian.angularUnit
- The angular unit of the longitude.
-
-
Method Details
-
getGreenwichLongitude
public double getGreenwichLongitude()Longitude of the prime meridian measured from the Greenwich meridian, positive eastward. ThegreenwichLongitude
initial value is zero, and that value shall be used when the meridian name value is "Greenwich".- Specified by:
getGreenwichLongitude
in interfacePrimeMeridian
- Returns:
- The prime meridian Greenwich longitude, in angular unit.
-
getGreenwichLongitude
public double getGreenwichLongitude(Unit<Angle> targetUnit) 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 (getGreenwichLongitude(NonSI.DEGREE_ANGLE)
), regardless of the underlying angular units of this prime meridian.- Parameters:
targetUnit
- The unit in which to express longitude.- Returns:
- The Greenwich longitude in the given units.
-
getAngularUnit
public Unit<Angle> getAngularUnit()Returns the angular unit of the Greenwich longitude.- Specified by:
getAngularUnit
in interfacePrimeMeridian
- Returns:
- The angular unit of greenwich longitude.
-
equals
Compare this prime meridian with the specified object for equality.- Overrides:
equals
in classAbstractIdentifiedObject
- Parameters:
object
- The object to compare tothis
.compareMetadata
-true
for performing a strict comparaison, orfalse
for comparing only properties relevant to transformations.- Returns:
true
if both objects are equal.
-
hashCode
public int hashCode()Returns a hash value for this prime meridian. Name, remarks and the like are not taken in account. In other words, two prime meridians will return the same hash value if they are equal in the sense ofequals
(AbstractIdentifiedObject, false)- Overrides:
hashCode
in classAbstractIdentifiedObject
- Returns:
- The hash code value. This value doesn't need to be the same in past or future versions of this class.
-
formatWKT
Format the inner part of a Well Known Text (WKT) element.- Overrides:
formatWKT
in classFormattable
- Parameters:
formatter
- The formatter to use.- Returns:
- The WKT element name, which is "PRIMEM"
- See Also:
-
formatPROJ
Description copied from interface:PROJFormattable
Format the inner part of a PROJFormattable object.This method is automatically invoked by
PROJFormatter.append(PROJFormattable)
.For example for a element (
DefaultOperationMethod
) of type Projection, the formatter will invoke this method to prepend the "+proj=" String for completing the PROJ String before appending the Projection Name (e.g. lcc for a Lambert Conformal Conic)- Specified by:
formatPROJ
in interfacePROJFormattable
- Parameters:
formatter
- The PROJFormatter to use.- Returns:
- The proj String of the PROJ element type if any. (e.g. +ellps= for named ellipsoids, +datum= for named datums).
-