DefaultTemporalDatum (Apache SIS 1.6 API)
JavaScript is disabled on your browser.
   
Skip navigation links
Overview
Class
Use
Tree
New
Deprecated
Index
Search
Help
org.apache.sis.referencing
org.apache.sis.referencing.datum
DefaultTemporalDatum
Contents 
Description
Creating new temporal datum instances
Immutability and thread safety
Field Summary
Constructor Summary
Method Summary
Constructor Details
DefaultTemporalDatum(Map, Temporal)
DefaultTemporalDatum(Map, Date)
DefaultTemporalDatum(TemporalDatum)
Method Details
castOrCopy(TemporalDatum)
getInterface()
getOrigin()
formatTo(Formatter)
Hide sidebar  Show sidebar
Class DefaultTemporalDatum
Object
FormattableObject
AbstractIdentifiedObject
AbstractDatum
DefaultTemporalDatum
All Implemented Interfaces:
Serializable, Formattable, Deprecable, Lenient­Comparable, Printable, Datum, Temporal­Datum, Identified­Object
public class DefaultTemporalDatum
extends AbstractDatum
implements TemporalDatum
Defines the origin of a temporal coordinate reference system.
Creating new temporal datum instances
New instances can be created either directly by specifying all information to a factory method (choices 3
and 4 below), or indirectly by specifying the identifier of an entry in a database (choices 1 and 2 below).
Choice 1 in the following list is the easiest but most restrictive way to get a temporal datum.
The other choices provide more freedom.
Create a Temporal­Datum from one of the static convenience shortcuts listed in
Common­CRS​.Temporal​.datum().
Create a Temporal­Datum from an identifier in a database by invoking
Datum­Authority­Factory​.create­Temporal­Datum(String).
Create a Temporal­Datum by invoking the Datum­Factory​.create­Temporal­Datum(…) method,
(implemented for example by Geodetic­Object­Factory).
Create a Default­Temporal­Datum by invoking the
constructor.
Example: the following code gets a temporal datum having its origin at January 1st, 4713 BC at 12:00 UTC:
Copy
TemporalDatum datum = CommonCRS.Temporal.JULIAN.datum();
Immutability and thread safety
This class is immutable and thus thread-safe if the property values (not necessarily the map itself)
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:
Common­CRS​.Temporal​.datum()
Default­Time­CS
Default­Temporal­CRS
Geodetic­Authority­Factory​.create­Temporal­Datum(String)
Serialized Form
Field Summary
Fields inherited from class AbstractDatum
ANCHOR_DEFINITION_KEY, ANCHOR_EPOCH_KEY, CONVENTIONAL_RS_KEY, PUBLICATION_DATE_KEY
Fields inherited from class AbstractIdentifiedObject
DEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEY
Fields inherited from interface Datum
ANCHOR_POINT_KEY, DOMAIN_OF_VALIDITY_KEY, REALIZATION_EPOCH_KEY, SCOPE_KEY
Fields inherited from interface IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
Constructor Summary
Constructors
Modifier
Constructor
Description
 
Default­Temporal­Datum(Map<String,?> properties,
Temporal origin)
Creates a temporal datum from the given properties.
 
Default­Temporal­Datum(Map<String,?> properties,
Date origin)
Deprecated.
Use Default­Temporal­Datum(Map, Temporal) instead.
protected
Default­Temporal­Datum(Temporal­Datum datum)
Creates a new datum with the same values as the specified one.
Method Summary
All MethodsStatic MethodsInstance MethodsConcrete Methods
Modifier and Type
Method
Description
static Default­Temporal­Datum
cast­Or­Copy(Temporal­Datum object)
Returns a SIS datum implementation with the same values as the given arbitrary implementation.
protected String
format­To(Formatter formatter)
Formats this datum as a Well Known Text Time­Datum[…] element.
Class<? extends Temporal­Datum>
get­Interface()
Returns the GeoAPI interface implemented by this class.
Date
get­Origin()
Returns the date and time origin of this temporal datum.
Methods inherited from class AbstractDatum
cast­Or­Copy, get­Anchor­Definition, get­Anchor­Epoch, get­Anchor­Point, get­Conventional­RS, get­Domain­Of­Validity, get­Publication­Date, get­Realization­Epoch, get­Scope, is­Heuristic­Match­For­Name
Methods inherited from class AbstractIdentifiedObject
cast­Or­Copy, equals, format­To, get­Alias, get­Description, get­Domains, get­Identifiers, get­Name, get­Remarks, hash­Code, is­Deprecated
Methods inherited from class FormattableObject
print, to­String, to­String, to­WKT
Methods inherited from class Object
clone, finalize, get­Class, notify, notify­All, wait, wait, wait
Methods inherited from interface Datum
get­Domain­Of­Validity, get­Scope
Methods inherited from interface IdentifiedObject
get­Alias, get­Identifiers, get­Name, get­Remarks, to­WKT
Methods inherited from interface TemporalDatum
get­Anchor­Point, get­Realization­Epoch
Constructor Details
DefaultTemporalDatum
public DefaultTemporalDatum(Map<String,?> properties,
Temporal origin)
Creates a temporal datum from the given properties. The properties map is given
unchanged to 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()
"anchorPoint"
InternationalString or String
AbstractDatum.getAnchorDefinition()
"anchorEpoch"
Temporal
AbstractDatum.getAnchorEpoch()
Parameters:
properties - the properties to be given to the identified object.
origin - the date and time origin of this temporal datum.
Since:
1.5
See Also:
Geodetic­Object­Factory​.create­Temporal­Datum(Map, Date)
DefaultTemporalDatum
@Deprecated(since="1.5")
public DefaultTemporalDatum(Map<String,?> properties,
Date origin)
Deprecated.
Use Default­Temporal­Datum(Map, Temporal) instead.
Creates a temporal datum from the given properties.
Parameters:
properties - the properties to be given to the identified object.
origin - the date and time origin of this temporal datum.
DefaultTemporalDatum
protected DefaultTemporalDatum(TemporalDatum datum)
Creates a new datum 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:
datum - the datum to copy.
See Also:
cast­Or­Copy(Temporal­Datum)
Method Details
castOrCopy
public static DefaultTemporalDatum castOrCopy(TemporalDatum object)
Returns a SIS datum 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.
getInterface
public Class<? extends TemporalDatum> getInterface()
Returns the GeoAPI interface implemented by this class.
The SIS implementation returns Temporal­Datum​.class.
Note for implementers
Subclasses usually do not need to override this method since GeoAPI does not define Temporal­Datum
sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their
own set of interfaces.
Overrides:
get­Interface in class Abstract­Datum
Returns:
Temporal­Datum​.class or a user-defined sub-interface.
getOrigin
public Date getOrigin()
Returns the date and time origin of this temporal datum.
Specified by:
get­Origin in interface Temporal­Datum
Returns:
the date and time origin of this temporal datum.
formatTo
protected String formatTo(Formatter formatter)
Formats this datum as a Well Known Text Time­Datum[…] element.
Compatibility note
Time­Datum is defined in the WKT 2 specification only.
Apache SIS accepts this type as members of datum ensembles,
but this is not valid WKT according ISO 19162:2019.
Overrides:
format­To in class Abstract­Datum
Parameters:
formatter - the formatter where to format the inner content of this WKT element.
Returns:
"TDatum" or "Time­Datum".
May also be "Member" if this datum is inside a WKT Ensemble[…] element.
See Also:
Formattable­Object​.to­WKT()
Formattable­Object​.to­String()