org.deegree.model.csct.cs
Class TemporalCoordinateSystem

java.lang.Object
  org.deegree.model.csct.cs.Info
      org.deegree.model.csct.cs.CoordinateSystem
          org.deegree.model.csct.cs.TemporalCoordinateSystem

All Implemented Interfaces:

Serializable, Dimensioned

public class TemporalCoordinateSystem
extends CoordinateSystem

A one-dimensional coordinate system suitable for time measurements.

Version:

1.0

Author:

Martin Desruisseaux

See Also:

Serialized Form

Field Summary

Fields inherited from class org.deegree.model.csct.cs.Info

pool

Constructor Summary

TemporalCoordinateSystem(Map properties, TemporalDatum datum, Unit unit, Date epoch, AxisInfo axis)
Creates a temporal coordinate system from a datum and time units.

TemporalCoordinateSystem(String name, Date epoch)
Creates a temporal coordinate system.

TemporalCoordinateSystem(String name, TemporalDatum datum, Unit unit, Date epoch, AxisInfo axis)
Creates a temporal coordinate system from a datum and time units.

Method Summary

(package private) String	addString(StringBuffer buffer) Fill the part inside "[...]".
boolean	equivalents(CoordinateSystem cs) Returns true if this coordinate system is equivalents to the specified coordinate system.
AxisInfo	getAxis(int dimension) Gets axis details for temporal dimension within coordinate system.
(package private) Datum	getDatum() Override CoordinateSystem.getDatum().
int	getDimension() Returns the dimension of this coordinate system, which is 1.
Date	getEpoch() Returns the epoch.
TemporalDatum	getTemporalDatum() Gets the temporal datum, which indicates the measurement method.
Unit	getUnits(int dimension) Gets units for dimension within coordinate system.

Methods inherited from class org.deegree.model.csct.cs.CoordinateSystem

checkAxis, equals, getDefaultEnvelope, getUnits

Methods inherited from class org.deegree.model.csct.cs.Info

addString, addUnit, ensureAngularUnit, ensureLinearUnit, ensureNonNull, ensureNonNull, ensureTimeUnit, getAbbreviation, getAlias, getAuthority, getAuthorityCode, getName, getRemarks, hashCode, readResolve, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TemporalCoordinateSystem

public TemporalCoordinateSystem(String name,
                                Date epoch)

Creates a temporal coordinate system. Datum is UTC, units are days and values are increasing toward future.

Parameters:

name - Name to give new object.

epoch - The epoch (i.e. date of origin).

TemporalCoordinateSystem

public TemporalCoordinateSystem(String name,
                                TemporalDatum datum,
                                Unit unit,
                                Date epoch,
                                AxisInfo axis)

Creates a temporal coordinate system from a datum and time units.

Parameters:

name - Name to give new object.

datum - Datum to use for new coordinate system.

unit - Units to use for new coordinate system.

epoch - The epoch (i.e. date of origin).

axis - Axis to use for new coordinate system.

TemporalCoordinateSystem

TemporalCoordinateSystem(Map properties,
                         TemporalDatum datum,
                         Unit unit,
                         Date epoch,
                         AxisInfo axis)

Creates a temporal coordinate system from a datum and time units.

Parameters:

properties - The set of properties (see Info).

datum - Datum to use for new coordinate system.

unit - Units to use for new coordinate system.

epoch - The epoch (i.e. date of origin).

axis - Axis to use for new coordinate system.

Method Detail

getDimension

public final int getDimension()

Returns the dimension of this coordinate system, which is 1.

Specified by:

getDimension in interface Dimensioned

Specified by:

getDimension in class CoordinateSystem

Returns:

the dimension of the coordinate system.

See Also:

"org.opengis.cs.CS_CoordinateSystem#getDimension()"

getDatum

final Datum getDatum()

Override CoordinateSystem.getDatum().

Overrides:

getDatum in class CoordinateSystem

Returns:

the datum.

getTemporalDatum

public TemporalDatum getTemporalDatum()

Gets the temporal datum, which indicates the measurement method.

getEpoch

public Date getEpoch()

Returns the epoch. The epoch is the origin of the time axis, i.e. the date for value zero.

getAxis

public AxisInfo getAxis(int dimension)

Gets axis details for temporal dimension within coordinate system. A temporal coordinate system have only one axis, always at index 0.

Specified by:

getAxis in class CoordinateSystem

Parameters:

dimension - Zero based index of axis.

Returns:

See Also:

"org.opengis.cs.CS_CoordinateSystem#getAxis(int)"

getUnits

public Unit getUnits(int dimension)

Gets units for dimension within coordinate system. A temporal coordinate system have only one unit, always at index 0.

Specified by:

getUnits in class CoordinateSystem

Parameters:

dimension - Must be 0.

Returns:

See Also:

"org.opengis.cs.CS_CoordinateSystem#getUnits(int)"

equivalents

public boolean equivalents(CoordinateSystem cs)

Returns true if this coordinate system is equivalents to the specified coordinate system. Two coordinate systems are considered equivalent if the CoordinateTransformation from this to cs would be the identity transform. The default implementation compare datum, units and axis, but ignore name, alias and other meta-data informations.

Overrides:

equivalents in class CoordinateSystem

Parameters:

cs - The coordinate system (may be null).

Returns:

true if both coordinate systems are equivalent.

addString

String addString(StringBuffer buffer)

Fill the part inside "[...]". Used for formatting Well Know Text (WKT).