Class DefaultPrimeMeridian

Object

FormattableObject

AbstractIdentifiedObject

DefaultPrimeMeridian

All Implemented Interfaces:

Serializable, Formattable, Deprecable, Lenient­Comparable, Printable, Prime­Meridian, Identified­Object

public class DefaultPrimeMeridian
extends AbstractIdentifiedObject
implements PrimeMeridian

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.

1. Create a Prime­Meridian from one of the static convenience shortcuts listed in Common­CRS.prime­Meridian().
2. Create a Prime­Meridian from an identifier in a database by invoking Datum­Authority­Factory.create­Prime­Meridian(String).
3. Create a Prime­Meridian by invoking the Datum­Factory.create­Prime­Meridian(…) method (implemented for example by Geodetic­Object­Factory).
4. Create a Default­Prime­Meridian by invoking the constructor.

Example: the following code gets the Greenwich prime meridian:

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:

• Common­CRS.prime­Meridian()
• Geodetic­Authority­Factory.create­Prime­Meridian(String)
• Serialized Form

Field Summary

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEY

Modifier and Type	Field	Description
static final String	DEPRECATED_KEY	Optional key which can be given to the constructor for specifying the object is deprecated.
static final String	DOMAINS_KEY	Key for the "domains" property to be given to the Object­Factory.create­Foo(Map, ...) methods.
static final String	LOCALE_KEY	Optional key which can be given to the constructor for specifying the locale to use for producing error messages.

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Modifier and Type	Field	Description
static final String	ALIAS_KEY	Key for the "alias" property to be given to the object factory create­Foo(…) methods.
static final String	IDENTIFIERS_KEY	Key for the "identifiers" property to be given to the object factory create­Foo(…) methods.
static final String	NAME_KEY	Key for the "name" property to be given to the object factory create­Foo(…) methods.
static final String	REMARKS_KEY	Key for the "remarks" property to be given to the object factory create­Foo(…) methods.

Constructor Summary

Constructors

Modifier	Constructor	Description
	Default­Prime­Meridian(Map<String,?> properties, double greenwich­Longitude, Unit<Angle> angular­Unit)	Creates a prime meridian from the given properties.
protected	Default­Prime­Meridian(Prime­Meridian meridian)	Creates a new prime meridian with the same values as the specified one.

Method Summary

Modifier and Type	Method	Description
static Default­Prime­Meridian	cast­Or­Copy(Prime­Meridian object)	Returns a SIS prime meridian implementation with the same values as the given arbitrary implementation.
protected String	format­To(Formatter formatter)	Formats this prime meridian as a Well Known Text Prime­Meridian[…] element.
Unit<Angle>	get­Angular­Unit()	Returns the angular unit of the Greenwich longitude.
double	get­Greenwich­Longitude()	Longitude of the prime meridian measured from the Greenwich meridian, positive eastward.
double	get­Greenwich­Longitude(Unit<Angle> unit)	Returns the longitude value relative to the Greenwich Meridian, expressed in the specified units.
Type	get­Standard­Type()	Returns the GeoAPI interface that defines the contract of this implementation class.

Methods inherited from class AbstractIdentifiedObject

cast­Or­Copy, equals, format­To, get­Alias, get­Description, get­Domains, get­Identifiers, get­Interface, get­Name, get­Remarks, hash­Code, is­Deprecated, is­Heuristic­Match­For­Name

Modifier and Type	Method	Description
static Abstract­Identified­Object	cast­Or­Copy(Identified­Object object)	Returns a SIS identified object implementation with the values of the given arbitrary implementation.
final boolean	equals(Object object)	Compares the specified object with this object for equality.
void	format­To(Formatter formatter, int flags, int width, int precision)	Formats the name or identifier of this object using the provider formatter.
Collection<Generic­Name>	get­Alias()	Returns alternative names by which this object is identified.
Optional<International­String>	get­Description()	Returns a narrative explanation of the role of this object.
Collection<Default­Object­Domain>	get­Domains()	Returns the usage of this CRS-related object.
Set<Reference­Identifier>	get­Identifiers()	Returns identifiers which references elsewhere the object's defining information.
final Class<? extends Identified­Object>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Identified­Object.get­Standard­Type() for integration with Lenient­Comparable.
Reference­Identifier	get­Name()	Returns the primary name by which this object is identified.
International­String	get­Remarks()	Returns comments on or information about this object, including data source information.
final int	hash­Code()	Returns a hash value for this identified object.
boolean	is­Deprecated()	Returns true if this object is deprecated.
boolean	is­Heuristic­Match­For­Name(String name)	Returns true if either the primary name or at least one alias matches the given string according heuristic rules.

Methods inherited from class FormattableObject

print, to­String, to­String, to­WKT

Modifier and Type	Method	Description
void	print()	Prints a string representation of this object to the standard output stream.
String	to­String()	Returns a Well Known Text (WKT) or an alternative text representation for this object.
String	to­String(Convention convention)	Returns a Well Known Text (WKT) for this object using the specified convention.
String	to­WKT()	Returns a strictly compliant Well Known Text (WKT) using the default convention, symbols and indentation.

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface IdentifiedObject

to­WKT

Modifier and Type	Method	Description
String	to­WKT()	Returns a Well Known Text (WKT) for this object.

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 or String	AbstractIdentifiedObject.getName()
"alias"	GenericName or Char­Sequence (optionally as array)	AbstractIdentifiedObject.getAlias()
"identifiers"	ReferenceIdentifier (optionally as array)	AbstractIdentifiedObject.getIdentifiers()
"remarks"	InternationalString or String	AbstractIdentifiedObject.getRemarks()

Parameters:

properties - the properties to be given to the identified object.

greenwich­Longitude - the longitude value relative to the Greenwich Meridian.

angular­Unit - the angular unit of the longitude.

See Also:

• Geodetic­Object­Factory.create­Prime­Meridian(Map, double, Unit)

DefaultPrimeMeridian

protected DefaultPrimeMeridian(PrimeMeridian meridian)

Creates a new prime meridian 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:

meridian - the prime meridian to copy.

See Also:

• cast­Or­Copy(Prime­Meridian)

Method Details

castOrCopy

public static DefaultPrimeMeridian castOrCopy(PrimeMeridian object)

Returns a SIS prime meridian implementation with the same values as the given arbitrary implementation. If the given object is null, then this method returns null. 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 null 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.

getStandardType

public Type getStandardType()

Returns the GeoAPI interface that defines the contract of this implementation class. This is the base type required by equals(…) methods for returning a potentially true value.

Specified by:

get­Standard­Type in interface Lenient­Comparable

Overrides:

get­Standard­Type in class Abstract­Identified­Object

Returns:

Prime­Meridian.class or a user-defined sub-interface.

Since:

1.7

See Also:

• Comparison­Mode.BY_CONTRACT
• Classes.get­Raw­Class(Type)
• Classes.get­Standard­Class(Object, Class)

getGreenwichLongitude

public double getGreenwichLongitude()

Longitude of the prime meridian measured from the Greenwich meridian, positive eastward.

Specified by:

get­Greenwich­Longitude in interface Prime­Meridian

Returns:

the prime meridian Greenwich longitude, in angular unit.

getGreenwichLongitude

public double getGreenwichLongitude(Unit<Angle> unit)

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

public Unit<Angle> getAngularUnit()

Returns the angular unit of the Greenwich longitude.

Specified by:

get­Angular­Unit in interface Prime­Meridian

Returns:

the angular unit of the Greenwich longitude.

formatTo

protected String formatTo(Formatter formatter)

Formats this prime meridian as a Well Known Text Prime­Meridian[…] element.

Overrides:

format­To in class Abstract­Identified­Object

Parameters:

formatter - the formatter where to format the inner content of this WKT element.

Returns:

"Prime­Meridian" (WKT 2) or "Prime­M" (WKT 1).

See Also:

• Formattable­Object.to­WKT()
• Formattable­Object.to­String()