org.geotoolkit.referencing.cs
Class DefaultTimeCS

Object
  FormattableObject
      AbstractIdentifiedObject
          AbstractCS
              DefaultTimeCS

All Implemented Interfaces:

Serializable, Formattable, LenientComparable, CoordinateSystem, TimeCS, IdentifiedObject

@Immutable
public class DefaultTimeCS
extends AbstractCS
implements TimeCS

A one-dimensional coordinate system containing a single time axis, used to describe the temporal position of a point in the specified time units from a specified time origin. A TimeCS shall have one axis.

Used with CRS type(s)

Temporal

Since:

2.0

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 DefaultTimeCS	DAYS A one-dimensional temporal CS with time, axis in day units.
static DefaultTimeCS	MILLISECONDS A one-dimensional temporal CS with time, axis in millisecond units.
static DefaultTimeCS	SECONDS A one-dimensional temporal CS with time, axis in second units.

Fields inherited from class FormattableObject

EPSG, GEOTIFF, INTERNAL, OGC, SINGLE_LINE

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

DefaultTimeCS(Map<String,?> properties, CoordinateSystemAxis axis)
Constructs a coordinate system from a set of properties.

DefaultTimeCS(String name, CoordinateSystemAxis axis)
Constructs a coordinate system from a name.

DefaultTimeCS(TimeCS cs)
Constructs a new coordinate system with the same values than the specified one.

Method Summary

static DefaultTimeCS	castOrCopy(TimeCS object) Returns a Geotk coordinate system implementation with the same values than the given arbitrary implementation.
Measure	distance(double[] coord1, double[] coord2) Computes the time difference between two points.
protected boolean	isCompatibleDirection(AxisDirection direction) Returns true if the specified axis direction is allowed for this coordinate system.
protected boolean	isCompatibleUnit(AxisDirection direction, Unit<?> unit) Returns true if the specified unit is compatible with seconds.
static DefaultTimeCS	wrap(TimeCS object) Deprecated. Renamed castOrCopy.

Methods inherited from class AbstractCS

computeHashCode, equals, formatWKT, getAxis, getDimension, standard, swapAndScaleAxis

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 CoordinateSystem

getAxis, getDimension

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Detail

DAYS

public static final DefaultTimeCS DAYS

A one-dimensional temporal CS with time, axis in day units.

See Also:

DefaultTemporalCRS.JULIAN, DefaultTemporalCRS.MODIFIED_JULIAN, DefaultTemporalCRS.TRUNCATED_JULIAN, DefaultTemporalCRS.DUBLIN_JULIAN

SECONDS

public static final DefaultTimeCS SECONDS

A one-dimensional temporal CS with time, axis in second units.

Since:

2.5

See Also:

DefaultTemporalCRS.UNIX

MILLISECONDS

public static final DefaultTimeCS MILLISECONDS

A one-dimensional temporal CS with time, axis in millisecond units.

Since:

2.5

See Also:

DefaultTemporalCRS.JAVA

Constructor Detail

DefaultTimeCS

public DefaultTimeCS(TimeCS cs)

Constructs a new coordinate system 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:

cs - The coordinate system to copy.

Since:

2.2

DefaultTimeCS

public DefaultTimeCS(String name,
                     CoordinateSystemAxis axis)

Constructs a coordinate system from a name.

Parameters:

name - The coordinate system name.

axis - The axis.

DefaultTimeCS

public DefaultTimeCS(Map<String,?> properties,
                     CoordinateSystemAxis axis)

Constructs a coordinate system 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".

axis - The axis.

Method Detail

castOrCopy

public static DefaultTimeCS castOrCopy(TimeCS object)

Returns a Geotk coordinate system implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object.

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.

Since:

3.18

wrap

@Deprecated
public static DefaultTimeCS wrap(TimeCS 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.

isCompatibleDirection

protected boolean isCompatibleDirection(AxisDirection direction)

Returns true if the specified axis direction is allowed for this coordinate system. The default implementation accepts only temporal directions (i.e. FUTURE and PAST).

Overrides:

isCompatibleDirection in class AbstractCS

Parameters:

direction - The direction to test for compatibility.

Returns:

true if the given direction is compatible with this coordinate system.

isCompatibleUnit

protected boolean isCompatibleUnit(AxisDirection direction,
                                   Unit<?> unit)

Returns true if the specified unit is compatible with seconds. This method is invoked at construction time for checking units compatibility.

Overrides:

isCompatibleUnit in class AbstractCS

Parameters:

direction - The direction of the axis having the given unit.

unit - The unit to test for compatibility.

Returns:

true if the given unit is compatible with this coordinate system.

Since:

2.2

distance

public Measure distance(double[] coord1,
                        double[] coord2)
                 throws MismatchedDimensionException

Computes the time difference between two points.

Overrides:

distance in class AbstractCS

Parameters:

coord1 - Coordinates of the first point.

coord2 - Coordinates of the second point.

Returns:

The time difference between coord1 and coord2.

Throws:

MismatchedDimensionException - if a coordinate doesn't have the expected dimension.