org.geotoolkit.referencing.crs
Class DefaultTemporalCRS

Object
  FormattableObject
      AbstractIdentifiedObject
          AbstractReferenceSystem
              AbstractCRS
                  AbstractSingleCRS
                      DefaultTemporalCRS

All Implemented Interfaces:

Serializable, Formattable, LenientComparable, CoordinateReferenceSystem, SingleCRS, TemporalCRS, IdentifiedObject, ReferenceSystem

@Immutable
public class DefaultTemporalCRS
extends AbstractSingleCRS
implements TemporalCRS

A 1D coordinate reference system used for the recording of time.

Used with CS type(s)

Time

Since:

1.2

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys)

See Also:

Serialized Form

Module:

referencing/geotk-referencing (download)

View source code for this class

Field Summary

static DefaultTemporalCRS	DUBLIN_JULIAN Time measured in days since December 31, 1899 at 12:00 UTC.
static DefaultTemporalCRS	JAVA Time measured in milliseconds since January 1st, 1970 at 00:00 UTC.
static DefaultTemporalCRS	JULIAN Time measured in days since January 1st, 4713 BC at 12:00 UTC.
static DefaultTemporalCRS	MODIFIED_JULIAN Time measured in days since November 17, 1858 at 00:00 UTC.
static DefaultTemporalCRS	TRUNCATED_JULIAN Time measured in days since May 24, 1968 at 00:00 UTC.
static DefaultTemporalCRS	UNIX Time measured in seconds since January 1st, 1970 at 00:00 UTC.

Fields inherited from class FormattableObject

EPSG, GEOTIFF, INTERNAL, OGC, SINGLE_LINE

Fields inherited from interface ReferenceSystem

DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

DefaultTemporalCRS(Map<String,?> properties, TemporalDatum datum, TimeCS cs)
Constructs a temporal CRS from a set of properties.

DefaultTemporalCRS(String name, TemporalDatum datum, TimeCS cs)
Constructs a temporal CRS from a name.

DefaultTemporalCRS(TemporalCRS crs)
Constructs a new temporal CRS with the same values than the specified one.

DefaultTemporalCRS(TemporalDatum datum, TimeCS cs)
Constructs a temporal CRS with the same properties than the given datum.

Method Summary

static DefaultTemporalCRS	castOrCopy(TemporalCRS object) Wraps an arbitrary temporal CRS into a Geotk implementation.
TimeCS	getCoordinateSystem() Returns the coordinate system.
TemporalDatum	getDatum() Returns the datum.
Date	toDate(double value) Convert the given value into a Date object.
double	toValue(Date time) Convert the given date into a value in this axis unit.
static DefaultTemporalCRS	wrap(TemporalCRS object) Deprecated. Renamed castOrCopy.

Methods inherited from class AbstractSingleCRS

computeHashCode, equals, getAxis, getDimension

Methods inherited from class AbstractCRS

distance, formatWKT

Methods inherited from class AbstractReferenceSystem

getDomainOfValidity, getScope

Methods inherited from class AbstractIdentifiedObject

equals, getAlias, getIdentifier, getIdentifiers, getName, getName, getRemarks, hashCode, nameMatches

Methods inherited from class FormattableObject

getDefaultIndentation, print, setDefaultIndentation, toString, toWKT, toWKT, toWKT

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ReferenceSystem

getDomainOfValidity, getScope

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Detail

JULIAN

public static final DefaultTemporalCRS JULIAN

Time measured in days since January 1st, 4713 BC at 12:00 UTC.

Since:

2.5

See Also:

DefaultTemporalDatum.JULIAN, DefaultTimeCS.DAYS

MODIFIED_JULIAN

public static final DefaultTemporalCRS MODIFIED_JULIAN

Time measured in days since November 17, 1858 at 00:00 UTC. A Modified Julian day (MJD) is defined relative to Julian day (JD) as MJD = JD − 2400000.5.

Since:

2.5

See Also:

DefaultTemporalDatum.MODIFIED_JULIAN, DefaultTimeCS.DAYS

TRUNCATED_JULIAN

public static final DefaultTemporalCRS TRUNCATED_JULIAN

Time measured in days since May 24, 1968 at 00:00 UTC. This epoch was introduced by NASA for the space program. A Truncated Julian day (TJD) is defined relative to Julian day (JD) as TJD = JD − 2440000.5.

Since:

2.5

See Also:

DefaultTemporalDatum.TRUNCATED_JULIAN, DefaultTimeCS.DAYS

DUBLIN_JULIAN

public static final DefaultTemporalCRS DUBLIN_JULIAN

Time measured in days since December 31, 1899 at 12:00 UTC. A Dublin Julian day (DJD) is defined relative to Julian day (JD) as DJD = JD − 2415020.

Since:

2.5

See Also:

DefaultTemporalDatum.DUBLIN_JULIAN, DefaultTimeCS.DAYS

UNIX

public static final DefaultTemporalCRS UNIX

Time measured in seconds since January 1st, 1970 at 00:00 UTC.

Since:

2.5

See Also:

DefaultTemporalDatum.UNIX, DefaultTimeCS.SECONDS

JAVA

public static final DefaultTemporalCRS JAVA

Time measured in milliseconds since January 1st, 1970 at 00:00 UTC.

Since:

2.5

See Also:

DefaultTemporalDatum.UNIX, DefaultTimeCS.MILLISECONDS

Constructor Detail

DefaultTemporalCRS

public DefaultTemporalCRS(TemporalCRS crs)

Constructs a new temporal CRS with the same values than the specified one. This copy constructor provides a way to convert an arbitrary implementation into a Geotk 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.

Since:

2.2

See Also:

castOrCopy(TemporalCRS)

DefaultTemporalCRS

public DefaultTemporalCRS(TemporalDatum datum,
                          TimeCS cs)

Constructs a temporal CRS with the same properties than the given datum. The inherited properties include the name and aliases.

Parameters:

datum - The datum.

cs - The coordinate system.

Since:

2.5

DefaultTemporalCRS

public DefaultTemporalCRS(String name,
                          TemporalDatum datum,
                          TimeCS cs)

Constructs a temporal CRS from a name.

Parameters:

name - The name.

datum - The datum.

cs - The coordinate system.

DefaultTemporalCRS

public DefaultTemporalCRS(Map<String,?> properties,
                          TemporalDatum datum,
                          TimeCS cs)

Constructs a temporal CRS from a set of properties. The properties are given unchanged to the super-class constructor.

Parameters:

properties - Set of properties. Should contains at least "name".

cs - The coordinate system.

datum - The datum.

Method Detail

castOrCopy

public static DefaultTemporalCRS castOrCopy(TemporalCRS object)

Wraps an arbitrary temporal CRS into a Geotk implementation. This method is useful if the user wants to take advantage of toDate(double) and toValue(java.util.Date) methods. If the supplied CRS is already an instance of DefaultTemporalCRS or is null, then it is returned unchanged.

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

wrap

@Deprecated
public static DefaultTemporalCRS wrap(TemporalCRS object)

Deprecated. Renamed castOrCopy.

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

The given object as a Geotk implementation.

getCoordinateSystem

public TimeCS getCoordinateSystem()

Returns the coordinate system.

Specified by:

getCoordinateSystem in interface CoordinateReferenceSystem

Specified by:

getCoordinateSystem in interface SingleCRS

Specified by:

getCoordinateSystem in interface TemporalCRS

Overrides:

getCoordinateSystem in class AbstractCRS

getDatum

public TemporalDatum getDatum()

Returns the datum.

Specified by:

getDatum in interface SingleCRS

Specified by:

getDatum in interface TemporalCRS

Overrides:

getDatum in class AbstractSingleCRS

Returns:

The datum.

toDate

public Date toDate(double value)

Convert the given value into a Date object. If the given value is NaN or infinite, then this method returns null. This is consistent with usage in DateRange, where the null value is used for unbounded ranges.

This method is the converse of toValue(Date).

Parameters:

value - A value in this axis unit.

Returns:

The value as a date, or null if the given value is NaN or infinite.

toValue

public double toValue(Date time)

Convert the given date into a value in this axis unit. If the given time is null, then this method returns NaN.

This method is the converse of toDate(double).

Parameters:

time - The value as a date, or null.

Returns:

value A value in this axis unit, or NaN if the given time is null.