org.geotools.referencing.cs
Class DefaultTimeCS

java.lang.Object
  org.geotools.referencing.wkt.Formattable
      org.geotools.referencing.AbstractIdentifiedObject
          org.geotools.referencing.cs.AbstractCS
              org.geotools.referencing.cs.DefaultTimeCS

All Implemented Interfaces:

org.opengis.referencing.cs.CoordinateSystem, org.opengis.referencing.IdentifiedObject, java.io.Serializable, org.opengis.referencing.cs.TimeCS

public class DefaultTimeCS

extends AbstractCS

implements org.opengis.referencing.cs.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 shall have one axis.

Used with CRS type(s)

Temporal

Since:

2.1

Version:

$Id: DefaultTimeCS.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux

See Also:

Serialized Form

Field Summary

static DefaultTimeCS

DAYS A one-dimensional temporal CS with time, axis in days.

Fields inherited from class org.geotools.referencing.AbstractIdentifiedObject

EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR

Fields inherited from interface org.opengis.referencing.IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

DefaultTimeCS(java.util.Map properties, org.opengis.referencing.cs.CoordinateSystemAxis axis)
Constructs a coordinate system from a set of properties.

DefaultTimeCS(java.lang.String name, org.opengis.referencing.cs.CoordinateSystemAxis axis)
Constructs a coordinate system from a name.

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

Method Summary

Measure	distance(double[] coord1, double[] coord2) Computes the time difference between two points.
protected boolean	isCompatibleDirection(org.opengis.referencing.cs.AxisDirection direction) Returns if the specified axis direction is allowed for this coordinate system.
protected boolean	isCompatibleUnit(org.opengis.referencing.cs.AxisDirection direction, javax.units.Unit unit) Returns if the specified unit is compatible with seconds.

Methods inherited from class org.geotools.referencing.cs.AbstractCS

equals, formatWKT, getAxis, getDimension, hashCode, standard, swapAndScaleAxis

Methods inherited from class org.geotools.referencing.AbstractIdentifiedObject

asSet, ensureAngularUnit, ensureLinearUnit, ensureNonNull, ensureNonNull, ensureTimeUnit, equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, nameMatches, nameMatches

Methods inherited from class org.geotools.referencing.wkt.Formattable

toString, toWKT, toWKT, toWKT

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opengis.referencing.cs.CoordinateSystem

getAxis, getDimension

Methods inherited from interface org.opengis.referencing.IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Detail

DAYS

public static DefaultTimeCS DAYS

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

Constructor Detail

DefaultTimeCS

public DefaultTimeCS(org.opengis.referencing.cs.TimeCS cs)

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

Since:

2.2

DefaultTimeCS

public DefaultTimeCS(java.lang.String name,
                     org.opengis.referencing.cs.CoordinateSystemAxis axis)

Constructs a coordinate system from a name.

Parameters:

name - The coordinate system name.

axis - The axis.

DefaultTimeCS

public DefaultTimeCS(java.util.Map properties,
                     org.opengis.referencing.cs.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

isCompatibleDirection

protected boolean isCompatibleDirection(org.opengis.referencing.cs.AxisDirection direction)

Returns 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

isCompatibleUnit

protected boolean isCompatibleUnit(org.opengis.referencing.cs.AxisDirection direction,
                                   javax.units.Unit unit)

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

Overrides:

isCompatibleUnit in class AbstractCS

Since:

2.2

distance

public Measure distance(double[] coord1,
                        double[] coord2)
                 throws org.opengis.spatialschema.geometry.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 and .

Throws:

org.opengis.spatialschema.geometry.MismatchedDimensionException - if a coordinate doesn't have the expected dimension.