Class DefaultTemporalCRS

Object

FormattableObject

AbstractIdentifiedObject

AbstractReferenceSystem

AbstractCRS

DefaultTemporalCRS

All Implemented Interfaces:

Serializable, Formattable, Deprecable, Lenient­Comparable, Printable, Coordinate­Reference­System, Single­CRS, Temporal­CRS, Identified­Object, Reference­System

public class DefaultTemporalCRS
extends AbstractCRS
implements 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:

• to­Instant(double) for converting a temporal position to a Date.
• to­Value(Instant) for converting a Instant 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

See Also:

• Default­Temporal­Datum
• Default­Time­CS
• Geodetic­Authority­Factory.create­Temporal­CRS(String)
• Serialized Form

Field Summary

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEY

Modifier and Type	Field	Description
static final String	DEPRECATED_KEY	Optional key which can be given to the constructor for specifying the object is deprecated.
static final String	DOMAINS_KEY	Key for the "domains" property to be given to the Object­Factory.create­Foo(Map, ...) methods.
static final String	LOCALE_KEY	Optional key which can be given to the constructor for specifying the locale to use for producing error messages.

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Modifier and Type	Field	Description
static final String	ALIAS_KEY	Key for the "alias" property to be given to the object factory create­Foo(…) methods.
static final String	IDENTIFIERS_KEY	Key for the "identifiers" property to be given to the object factory create­Foo(…) methods.
static final String	NAME_KEY	Key for the "name" property to be given to the object factory create­Foo(…) methods.
static final String	REMARKS_KEY	Key for the "remarks" property to be given to the object factory create­Foo(…) methods.

Fields inherited from interface ReferenceSystem

DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY

Modifier and Type	Field	Description
static final String	DOMAIN_OF_VALIDITY_KEY	Key for the "domain­Of­Validity" property to be given to the object factory create­Foo(…) methods.
static final String	SCOPE_KEY	Key for the "scope" property to be given to the object factory create­Foo(…) methods.

Constructor Summary

Constructors

Modifier	Constructor	Description
	Default­Temporal­CRS(Map<String,?> properties, Temporal­Datum datum, Default­Datum­Ensemble<Temporal­Datum> ensemble, Time­CS cs)	Creates a coordinate reference system from the given properties, datum and coordinate system.
protected	Default­Temporal­CRS(Temporal­CRS crs)	Constructs a new coordinate reference system with the same values as the specified one.

Method Summary

Modifier and Type	Method	Description
static Default­Temporal­CRS	cast­Or­Copy(Temporal­CRS object)	Returns a SIS coordinate reference system implementation with the same values as the given arbitrary implementation.
Default­Temporal­CRS	for­Convention(Axes­Convention convention)	Returns a CRS equivalent to this one but with axes rearranged according the given convention.
protected String	format­To(Formatter formatter)	Formats this CRS as a Well Known Text Time­CRS[…] element.
Time­CS	get­Coordinate­System()	Returns the coordinate system.
Temporal­Datum	get­Datum()	Returns the definition of the relationship of a temporal CRS to a time.
Default­Datum­Ensemble<Temporal­Datum>	get­Datum­Ensemble()	Returns a collection of datums which, for low accuracy requirements, may be considered to be insignificantly different from each other.
final Temporal	get­Origin()	Returns the temporal origin which is indirectly (through a datum) associated with this CRS.
Type	get­Standard­Type()	Returns the GeoAPI interface that defines the contract of this implementation class.
final Unit<Time>	get­Unit()	Returns the unit of measurement of temporal measurement in the coordinate reference system.
Date	to­Date(double value)	Converts the given value into a Date object.
Duration	to­Duration(double delta)	Converts the given value difference into a duration object.
Instant	to­Instant(double value)	Converts the given value into an instant object.
double	to­Value(Duration delta)	Converts the given duration into a difference of values in this axis unit.
double	to­Value(Instant time)	Converts the given instant into a value in this axis unit.
double	to­Value(Date time)	Converts the given date into a value in this axis unit.

Methods inherited from class AbstractCRS

cast­Or­Copy

Modifier and Type	Method	Description
static Abstract­CRS	cast­Or­Copy(Coordinate­Reference­System object)	Returns a SIS coordinate reference system implementation with the values of the given arbitrary implementation.

Methods inherited from class AbstractReferenceSystem

get­Domain­Of­Validity, get­Scope

Modifier and Type	Method	Description
Extent	get­Domain­Of­Validity()	Deprecated. Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.
International­String	get­Scope()	Deprecated. Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.

Methods inherited from class AbstractIdentifiedObject

cast­Or­Copy, equals, format­To, get­Alias, get­Description, get­Domains, get­Identifiers, get­Interface, get­Name, get­Remarks, hash­Code, is­Deprecated, is­Heuristic­Match­For­Name

Modifier and Type	Method	Description
static Abstract­Identified­Object	cast­Or­Copy(Identified­Object object)	Returns a SIS identified object implementation with the values of the given arbitrary implementation.
final boolean	equals(Object object)	Compares the specified object with this object for equality.
void	format­To(Formatter formatter, int flags, int width, int precision)	Formats the name or identifier of this object using the provider formatter.
Collection<Generic­Name>	get­Alias()	Returns alternative names by which this object is identified.
Optional<International­String>	get­Description()	Returns a narrative explanation of the role of this object.
Collection<Default­Object­Domain>	get­Domains()	Returns the usage of this CRS-related object.
Set<Reference­Identifier>	get­Identifiers()	Returns identifiers which references elsewhere the object's defining information.
final Class<? extends Identified­Object>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Identified­Object.get­Standard­Type() for integration with Lenient­Comparable.
Reference­Identifier	get­Name()	Returns the primary name by which this object is identified.
International­String	get­Remarks()	Returns comments on or information about this object, including data source information.
final int	hash­Code()	Returns a hash value for this identified object.
boolean	is­Deprecated()	Returns true if this object is deprecated.
boolean	is­Heuristic­Match­For­Name(String name)	Returns true if either the primary name or at least one alias matches the given string according heuristic rules.

Methods inherited from class FormattableObject

print, to­String, to­String, to­WKT

Modifier and Type	Method	Description
void	print()	Prints a string representation of this object to the standard output stream.
String	to­String()	Returns a Well Known Text (WKT) or an alternative text representation for this object.
String	to­String(Convention convention)	Returns a Well Known Text (WKT) for this object using the specified convention.
String	to­WKT()	Returns a strictly compliant Well Known Text (WKT) using the default convention, symbols and indentation.

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface IdentifiedObject

to­WKT

Modifier and Type	Method	Description
String	to­WKT()	Returns a Well Known Text (WKT) for this object.

Constructor Details

DefaultTemporalCRS

public DefaultTemporalCRS(Map<String,?> properties,
 TemporalDatum datum,
 DefaultDatumEnsemble<TemporalDatum> ensemble,
 TimeCS cs)

Creates a coordinate reference system from the given properties, datum and coordinate system. At least one of the datum and ensemble arguments shall be non-null. The properties given in argument follow the same rules as 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 or String	AbstractIdentifiedObject.getName()
"alias"	GenericName or Char­Sequence (optionally as array)	AbstractIdentifiedObject.getAlias()
"identifiers"	ReferenceIdentifier (optionally as array)	AbstractIdentifiedObject.getIdentifiers()
"domains"	DefaultObjectDomain (optionally as array)	AbstractIdentifiedObject.getDomains()
"remarks"	InternationalString or String	AbstractIdentifiedObject.getRemarks()

Parameters:

properties - the properties to be given to the coordinate reference system.

datum - the datum, or null if the CRS is associated only to a datum ensemble.

ensemble - collection of reference frames which for low accuracy requirements may be considered to be insignificantly different from each other, or null if there is no such ensemble.

cs - the coordinate system.

Since:

1.5

See Also:

• Geodetic­Object­Factory.create­Temporal­CRS(Map, Temporal­Datum, Default­Datum­Ensemble, Time­CS)

DefaultTemporalCRS

protected DefaultTemporalCRS(TemporalCRS crs)

Constructs a new coordinate reference system with the same values as 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:

• cast­Or­Copy(Temporal­CRS)

Method Details

castOrCopy

public static DefaultTemporalCRS castOrCopy(TemporalCRS object)

Returns a SIS coordinate reference system implementation with the same values as the given arbitrary implementation. If the given object is null, then this method returns null. 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, or null 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.

getStandardType

public Type getStandardType()

Returns the GeoAPI interface that defines the contract of this implementation class. This is the base type required by equals(…) methods for returning a potentially true value.

Specified by:

get­Standard­Type in interface Lenient­Comparable

Returns:

Temporal­CRS.class or a user-defined sub-interface.

Since:

1.7

See Also:

• Comparison­Mode.BY_CONTRACT
• Classes.get­Raw­Class(Type)
• Classes.get­Standard­Class(Object, Class)

getDatum

public TemporalDatum getDatum()

Returns the definition of the relationship of a temporal CRS to a time. This property may be null if this CRS is related to an object identified only by a datum ensemble.

Specified by:

get­Datum in interface Single­CRS

Specified by:

get­Datum in interface Temporal­CRS

Returns:

the temporal datum, or null if this CRS is related to an object identified only by a datum ensemble.

getDatumEnsemble

public DefaultDatumEnsemble<TemporalDatum> getDatumEnsemble()

Returns a collection of datums which, for low accuracy requirements, may be considered to be insignificantly different from each other. This property may be null if this CRS is related to an object identified only by a single datum.

Warning: in a future SIS version, the return type may be changed to the org.opengis.referencing.datum.Datum­Ensemble interface. This change is pending GeoAPI revision.

Returns:

the datum ensemble, or null if this CRS is related to an object identified only by a single datum.

Since:

1.5

getCoordinateSystem

public TimeCS getCoordinateSystem()

Returns the coordinate system.

Specified by:

get­Coordinate­System in interface Coordinate­Reference­System

Specified by:

get­Coordinate­System in interface Single­CRS

Specified by:

get­Coordinate­System in interface Temporal­CRS

Overrides:

get­Coordinate­System in class Abstract­CRS

Returns:

the coordinate system.

getUnit

public final Unit<Time> getUnit()

Returns the unit of measurement of temporal measurement in the coordinate reference system. This is a convenience method for Coordinate­System­Axis.get­Unit() 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 by to­Instant(double) and to­Date(double), and the unit of the value returned by to­Value(…) methods.

Implementation note

This method is declared final and does not invoke overridden get­Coordinate­System() method because this get­Unit() method is invoked indirectly by constructors. Another reason is that the overriding point is the Coordinate­System­Axis.get­Unit() 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

getOrigin

public final Temporal getOrigin()

Returns the temporal origin which is indirectly (through a datum) associated with this CRS. If the datum is non-null, then this method returns the datum origin. Otherwise, if all members of the datum ensemble use the same origin, then this method returns that origin.

Returns:

the origin indirectly associated with this CRS.

Throws:

Null­Pointer­Exception - if an origin, which are mandatory, is null.

Geodetic­Exception - if the origin is not the same for all members of the datum ensemble.

Since:

1.5

forConvention

public DefaultTemporalCRS forConvention(AxesConvention convention)

Returns a CRS 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 returns this.

Overrides:

for­Convention in class Abstract­CRS

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:

• Abstract­CS.for­Convention(Axes­Convention)

toInstant

public Instant toInstant(double value)

Converts the given value into an instant object. If the given value is NaN or infinite, then this method returns null. This method is the converse of to­Value(Instant).

Parameters:

value - a value in this axis. Unit of measurement is given by get­Unit().

Returns:

the value as an instant, or null if the given value is NaN or infinite.

Since:

1.0

toDate

public Date toDate(double value)

Converts the given value into a Date object. If the given value is is NaN or infinite, then this method returns null. This method is the converse of to­Value(Date).

This method is provided for interoperability with legacy java.util.Date object. New code should use to­Instant(double) instead.

Parameters:

value - a value in this axis unit. Unit of measurement is given by get­Unit().

Returns:

the value as a date, or null if the given value is NaN or infinite.

toDuration

public Duration toDuration(double delta)

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 returns null. This method is the converse of to­Value(Duration).

Parameters:

delta - a difference of values in this axis. Unit of measurement is given by get­Unit().

Returns:

the value difference as a duration, or null if the duration cannot be computed.

Since:

1.3

toValue

public double toValue(Instant time)

Converts the given instant into a value in this axis unit. If the given instant is null, then this method returns Double.Na­N. This method is the converse of to­Instant(double).

Parameters:

time - the value as an instant, or null.

Returns:

the value in this axis unit, or Double.Na­N if the given instant is null. Unit of measurement is given by get­Unit().

Since:

1.0

toValue

public double toValue(Date time)

Converts the given date into a value in this axis unit. If the given time is null, then this method returns Double.Na­N. This method is the converse of to­Date(double).

This method is provided for interoperability with legacy java.util.Date object. New code should use to­Value(Instant) instead.

Parameters:

time - the value as a date, or null.

Returns:

the value in this axis unit, or Double.Na­N if the given time is null. Unit of measurement is given by get­Unit().

toValue

public double toValue(Duration delta)

Converts the given duration into a difference of values in this axis unit. If the given duration is null, or if the conversion is non-linear, then this method returns Double.Na­N. This method is the converse of to­Duration(double).

Parameters:

delta - the difference of values as a duration, or null.

Returns:

the value difference in this axis unit, or Double.Na­N if it cannot be computed. Unit of measurement is given by get­Unit().

Since:

1.3

formatTo

protected String formatTo(Formatter formatter)

Formats this CRS as a Well Known Text Time­CRS[…] element.

Compatibility note

Time­CRS is defined in the WKT 2 specification only.

Overrides:

format­To in class Abstract­CRS

Parameters:

formatter - the formatter where to format the inner content of this WKT element.

Returns:

"Time­CRS".

See Also:

• Formattable­Object.to­WKT()
• Formattable­Object.to­String()