Package org.apache.sis.referencing.crs
Class DefaultTemporalCRS
java.lang.Object
org.apache.sis.io.wkt.FormattableObject
org.apache.sis.referencing.AbstractIdentifiedObject
org.apache.sis.referencing.AbstractReferenceSystem
org.apache.sis.referencing.crs.AbstractCRS
org.apache.sis.referencing.crs.DefaultTemporalCRS
- All Implemented Interfaces:
Serializable
,Formattable
,Deprecable
,LenientComparable
,org.opengis.referencing.crs.CoordinateReferenceSystem
,org.opengis.referencing.crs.SingleCRS
,org.opengis.referencing.crs.TemporalCRS
,org.opengis.referencing.IdentifiedObject
,org.opengis.referencing.ReferenceSystem
public class DefaultTemporalCRS
extends AbstractCRS
implements org.opengis.referencing.crs.TemporalCRS
A 1-dimensional coordinate reference system used for the recording of time.
The Apache SIS implementation provides the following methods in addition to the OGC/ISO properties:
toInstant(double)
for converting a temporal position to aDate
.toValue(Instant)
for converting aInstant
to a temporal position.
Used with datum type:
Temporal.
Used with coordinate system type:
Time.
Immutability and thread safety
This class is immutable and thus thread-safe if the property values (not necessarily the map itself), the coordinate system and the datum instances given to the constructor are also immutable. Unless otherwise noted in the javadoc, this condition holds if all components were created using only SIS factories and static constants.- Since:
- 0.4
- Version:
- 1.3
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.opengis.referencing.datum.TemporalDatum
The datum.private long
The origin in seconds since January 1st, 1970.private static final long
Serial number for inter-operability with different versions.private javax.measure.UnitConverter
Conversion factor from values in this CRS to values in seconds.Fields inherited from class org.apache.sis.referencing.AbstractIdentifiedObject
DEPRECATED_KEY, LOCALE_KEY
Fields inherited from interface org.opengis.referencing.IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
Fields inherited from interface org.opengis.referencing.ReferenceSystem
DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Constructs a new object in which every attributes are set to a null value.DefaultTemporalCRS
(Map<String, ?> properties, org.opengis.referencing.datum.TemporalDatum datum, org.opengis.referencing.cs.TimeCS cs) Creates a coordinate reference system from the given properties, datum and coordinate system.protected
DefaultTemporalCRS
(org.opengis.referencing.crs.TemporalCRS crs) Constructs a new coordinate reference system with the same values than the specified one. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultTemporalCRS
castOrCopy
(org.opengis.referencing.crs.TemporalCRS object) Returns a SIS coordinate reference system implementation with the same values than the given arbitrary implementation.(package private) final AbstractCRS
createSameType
(Map<String, ?> properties, org.opengis.referencing.cs.CoordinateSystem cs) Returns a coordinate reference system of the same type than this CRS but with different axes.forConvention
(AxesConvention convention) Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention.protected String
Formats this CRS as a Well Known TextTimeCRS[…]
element.org.opengis.referencing.cs.TimeCS
Returns the coordinate system.org.opengis.referencing.datum.TemporalDatum
getDatum()
Returns the datum.Class<? extends org.opengis.referencing.crs.TemporalCRS>
Returns the GeoAPI interface implemented by this class.final javax.measure.Unit<javax.measure.quantity.Time>
getUnit()
Returns the unit of measurement of temporal measurement in the coordinate reference system.private void
Initialize the fields required fortoInstant(double)
andtoValue(Instant)
operations.private void
Invoked on deserialization for restoring the transient fields.private void
setCoordinateSystem
(org.opengis.referencing.cs.TimeCS cs) Used by JAXB only (invoked by reflection).private void
setDatum
(org.opengis.referencing.datum.TemporalDatum value) Invoked by JAXB at unmarshalling time.toDate
(double value) Converts the given value into aDate
object.toDuration
(double delta) Converts the given value difference into a duration object.toInstant
(double value) Converts the given value into an instant object.double
Converts the given duration into a difference of values in this axis unit.double
Converts the given instant into a value in this axis unit.double
Converts the given date into a value in this axis unit.Methods inherited from class org.apache.sis.referencing.crs.AbstractCRS
castOrCopy, computeHashCode, equals, formatCS, getCached, getCoordinateSystem, isBaseCRS, setCached, setCoordinateSystem
Methods inherited from class org.apache.sis.referencing.AbstractReferenceSystem
getDomainOfValidity, getScope
Methods inherited from class org.apache.sis.referencing.AbstractIdentifiedObject
castOrCopy, equals, formatTo, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForName
Methods inherited from class org.apache.sis.io.wkt.FormattableObject
print, toString, toString, toWKT
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.opengis.referencing.IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
Methods inherited from interface org.opengis.referencing.ReferenceSystem
getDomainOfValidity, getScope
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
datum
private org.opengis.referencing.datum.TemporalDatum datumThe datum.Consider this field as final! This field is modified only at unmarshalling time by
setDatum(TemporalDatum)
- See Also:
-
toSeconds
private transient javax.measure.UnitConverter toSecondsConversion factor from values in this CRS to values in seconds. We useUnitConverter
instead ofdouble
because the SIS implementation ofUnitConverter
performs some extra steps against rounding errors.- See Also:
-
origin
private transient long originThe origin in seconds since January 1st, 1970. This field could be implicit in thetoSeconds
converter, but we still handle it explicitly in order to use integer arithmetic.
-
-
Constructor Details
-
DefaultTemporalCRS
public DefaultTemporalCRS(Map<String, ?> properties, org.opengis.referencing.datum.TemporalDatum datum, org.opengis.referencing.cs.TimeCS cs) Creates a coordinate reference system from the given properties, datum and coordinate system. The properties given in argument follow the same rules than for the super-class constructor. The following table is a reminder of main (not all) properties:Recognized properties (non exhaustive list) Property name Value type Returned by "name" ReferenceIdentifier
orString
AbstractIdentifiedObject.getName()
"alias" GenericName
orCharSequence
(optionally as array)AbstractIdentifiedObject.getAlias()
"identifiers" ReferenceIdentifier
(optionally as array)AbstractIdentifiedObject.getIdentifiers()
"remarks" InternationalString
orString
AbstractIdentifiedObject.getRemarks()
"domainOfValidity" Extent
AbstractReferenceSystem.getDomainOfValidity()
"scope" InternationalString
orString
AbstractReferenceSystem.getScope()
- Parameters:
properties
- the properties to be given to the coordinate reference system.datum
- the datum.cs
- the coordinate system.- See Also:
-
DefaultTemporalCRS
protected DefaultTemporalCRS(org.opengis.referencing.crs.TemporalCRS crs) Constructs a new coordinate reference system with the same values than the specified one. This copy constructor provides a way to convert an arbitrary implementation into a SIS 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.- See Also:
-
DefaultTemporalCRS
private DefaultTemporalCRS()Constructs a new object in which every attributes are set to a null value. This is not a valid object. This constructor is strictly reserved to JAXB, which will assign values to the fields using reflection.
-
-
Method Details
-
castOrCopy
Returns a SIS coordinate reference system implementation with the same values than the given arbitrary implementation. If the given object isnull
, then this method returnsnull
. Otherwise if the given object is already a SIS implementation, then the given object is returned unchanged. Otherwise a new SIS implementation is created and initialized to the attribute values of the given object.- Parameters:
object
- the object to get as a SIS implementation, ornull
if none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
null
if the argument was null.
-
readObject
Invoked on deserialization for restoring the transient fields.- Parameters:
in
- the input stream from which to deserialize an attribute.- Throws:
IOException
- if an I/O error occurred while reading or if the stream contains invalid data.ClassNotFoundException
- if the class serialized on the stream is not on the classpath.
-
initializeConverter
private void initializeConverter()Initialize the fields required fortoInstant(double)
andtoValue(Instant)
operations. -
getInterface
Returns the GeoAPI interface implemented by this class. The SIS implementation returnsTemporalCRS.class
.Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not defineTemporalCRS
sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.- Overrides:
getInterface
in classAbstractCRS
- Returns:
TemporalCRS.class
or a user-defined sub-interface.
-
getDatum
public org.opengis.referencing.datum.TemporalDatum getDatum()Returns the datum.- Specified by:
getDatum
in interfaceorg.opengis.referencing.crs.SingleCRS
- Specified by:
getDatum
in interfaceorg.opengis.referencing.crs.TemporalCRS
- Overrides:
getDatum
in classAbstractCRS
- Returns:
- the datum.
-
getCoordinateSystem
public org.opengis.referencing.cs.TimeCS getCoordinateSystem()Returns the coordinate system.- Specified by:
getCoordinateSystem
in interfaceorg.opengis.referencing.crs.CoordinateReferenceSystem
- Specified by:
getCoordinateSystem
in interfaceorg.opengis.referencing.crs.SingleCRS
- Specified by:
getCoordinateSystem
in interfaceorg.opengis.referencing.crs.TemporalCRS
- Overrides:
getCoordinateSystem
in classAbstractCRS
- Returns:
- the coordinate system.
-
getUnit
public final javax.measure.Unit<javax.measure.quantity.Time> getUnit()Returns the unit of measurement of temporal measurement in the coordinate reference system. This is a convenience method forCoordinateSystemAxis.getUnit()
on the unique axis of this coordinate reference system. The unit of measurement returned by this method is the unit of the value expected in argument bytoInstant(double)
andtoDate(double)
, and the unit of the value returned bytoValue(…)
methods.Implementation note: this method is declared final and does not invoke overriddengetCoordinateSystem()
method because thisgetUnit()
method is invoked indirectly by constructors. Another reason is that the overriding point is theCoordinateSystemAxis.getUnit()
method and we want to avoid introducing another overriding point that could be inconsistent with above method.- Returns:
- the temporal unit of measurement of coordinates in this CRS.
- Since:
- 1.0
-
forConvention
Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention. If this CRS is already compatible with the given convention, then this method returnsthis
.- Overrides:
forConvention
in classAbstractCRS
- Parameters:
convention
- the axes convention for which a coordinate reference system is desired.- Returns:
- a coordinate reference system compatible with the given convention (may be
this
). - See Also:
-
createSameType
final AbstractCRS createSameType(Map<String, ?> properties, org.opengis.referencing.cs.CoordinateSystem cs) Returns a coordinate reference system of the same type than this CRS but with different axes.- Overrides:
createSameType
in classAbstractCRS
-
toInstant
Converts the given value into an instant object. If the given value is NaN or infinite, then this method returnsnull
. This method is the converse oftoValue(Instant)
.- Parameters:
value
- a value in this axis. Unit of measurement is given bygetUnit()
.- Returns:
- the value as an instant, or
null
if the given value is NaN or infinite. - Since:
- 1.0
-
toDate
Converts the given value into aDate
object. If the given value is is NaN or infinite, then this method returnsnull
. This method is the converse oftoValue(Date)
.This method is provided for interoperability with legacy
java.util.Date
object. New code should usetoInstant(double)
instead. -
toDuration
Converts the given value difference into a duration object. If the given value is NaN or infinite, or if the conversion is non-linear, then this method returnsnull
. This method is the converse oftoValue(Duration)
.- Parameters:
delta
- a difference of values in this axis. Unit of measurement is given bygetUnit()
.- Returns:
- the value difference as a duration, or
null
if the duration cannot be computed. - Since:
- 1.3
-
toValue
Converts the given instant into a value in this axis unit. If the given instant isnull
, then this method returnsDouble.NaN
. This method is the converse oftoInstant(double)
.- Parameters:
time
- the value as an instant, ornull
.- Returns:
- the value in this axis unit, or
Double.NaN
if the given instant isnull
. Unit of measurement is given bygetUnit()
. - Since:
- 1.0
-
toValue
Converts the given date into a value in this axis unit. If the given time isnull
, then this method returnsDouble.NaN
. This method is the converse oftoDate(double)
.This method is provided for interoperability with legacy
java.util.Date
object. New code should usetoValue(Instant)
instead.- Parameters:
time
- the value as a date, ornull
.- Returns:
- the value in this axis unit, or
Double.NaN
if the given time isnull
. Unit of measurement is given bygetUnit()
.
-
toValue
Converts the given duration into a difference of values in this axis unit. If the given duration isnull
, or if the conversion is non-linear, then this method returnsDouble.NaN
. This method is the converse oftoDuration(double)
.- Parameters:
delta
- the difference of values as a duration, ornull
.- Returns:
- the value difference in this axis unit, or
Double.NaN
if it cannot be computed. Unit of measurement is given bygetUnit()
. - Since:
- 1.3
-
formatTo
Formats this CRS as a Well Known TextTimeCRS[…]
element.Compatibility note:TimeCRS
is defined in the WKT 2 specification only.- Overrides:
formatTo
in classAbstractCRS
- Parameters:
formatter
- the formatter where to format the inner content of this WKT element.- Returns:
"TimeCRS"
.- See Also:
-
setDatum
private void setDatum(org.opengis.referencing.datum.TemporalDatum value) Invoked by JAXB at unmarshalling time.- See Also:
-
setCoordinateSystem
private void setCoordinateSystem(org.opengis.referencing.cs.TimeCS cs) Used by JAXB only (invoked by reflection).- See Also:
-