Package org.geotools.referencing.cs
Class DefaultTimeCS
- Object
-
- Formattable
-
- AbstractIdentifiedObject
-
- AbstractCS
-
- DefaultTimeCS
-
- All Implemented Interfaces:
Serializable
,CoordinateSystem
,TimeCS
,IdentifiedObject
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. ATimeCS
shall have one axis.Used with CRS type(s) Temporal
- Since:
- 2.1
- Author:
- Martin Desruisseaux (IRD)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description 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 AbstractIdentifiedObject
EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR
-
Fields inherited from class Formattable
SINGLE_LINE
-
Fields inherited from interface IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
-
-
Constructor Summary
Constructors Constructor Description DefaultTimeCS(String name, CoordinateSystemAxis axis)
Constructs a coordinate system from a name.DefaultTimeCS(Map<String,?> properties, CoordinateSystemAxis axis)
Constructs a coordinate system from a set of properties.DefaultTimeCS(TimeCS cs)
Constructs a new coordinate system with the same values than the specified one.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Measure
distance(double[] coord1, double[] coord2)
Computes the time difference between two points.protected boolean
isCompatibleDirection(AxisDirection direction)
Returnstrue
if the specified axis direction is allowed for this coordinate system.protected boolean
isCompatibleUnit(AxisDirection direction, Unit<?> unit)
Returnstrue
if the specified unit is compatible with seconds.-
Methods inherited from class AbstractCS
equals, formatWKT, getAxis, getDimension, hashCode, standard, swapAndScaleAxis
-
Methods inherited from class AbstractIdentifiedObject
asSet, ensureAngularUnit, ensureLinearUnit, ensureNonNull, ensureNonNull, ensureTimeUnit, equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, nameMatches, nameMatches, nameMatches
-
Methods inherited from class Formattable
cleanupThreadLocals, toString, toWKT, toWKT, toWKT, toWKT
-
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.
-
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 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.- 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
-
isCompatibleDirection
protected boolean isCompatibleDirection(AxisDirection direction)
Returnstrue
if the specified axis direction is allowed for this coordinate system. The default implementation accepts only temporal directions (i.e.FUTURE
andPAST
).- Overrides:
isCompatibleDirection
in classAbstractCS
- 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)
Returnstrue
if the specified unit is compatible with seconds. This method is invoked at construction time for checking units compatibility.- Overrides:
isCompatibleUnit
in classAbstractCS
- 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 classAbstractCS
- Parameters:
coord1
- Coordinates of the first point.coord2
- Coordinates of the second point.- Returns:
- The time difference between
coord1
andcoord2
. - Throws:
MismatchedDimensionException
- if a coordinate doesn't have the expected dimension.
-
-