Interface TemporalDatum

All Superinterfaces:

Datum, Identified­Object

All Known Implementing Classes:

Default­Temporal­Datum

@UML(identifier="CD_TemporalDatum",
     specification=ISO_19111)
public interface TemporalDatum
extends Datum

A temporal datum defines the origin of a temporal coordinate reference system.

Since:

1.0

Field Summary

Fields inherited from interface Datum

ANCHOR_POINT_KEY, DOMAIN_OF_VALIDITY_KEY, REALIZATION_EPOCH_KEY, SCOPE_KEY

Modifier and Type	Field	Description
static final String	ANCHOR_POINT_KEY	Key for the "anchor­Point" property to be given to the datum factory create­Foo(…) methods.
static final String	DOMAIN_OF_VALIDITY_KEY	Key for the "domain­Of­Validity" property to be given to the datum factory create­Foo(…) methods.
static final String	REALIZATION_EPOCH_KEY	Key for the "realization­Epoch" property to be given to the datum factory create­Foo(…) methods.
static final String	SCOPE_KEY	Key for the "scope" property to be given to the datum factory create­Foo(…) methods.

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.

Method Summary

Modifier and Type	Method	Description
International­String	get­Anchor­Point()	This attribute is defined in the Datum parent interface, but is not used by a temporal datum.
Date	get­Origin()	The date and time origin of this temporal datum.
Date	get­Realization­Epoch()	This attribute is defined in the Datum parent interface, but is not used by a temporal datum.

Methods inherited from interface Datum

get­Domain­Of­Validity, get­Scope

Modifier and Type	Method	Description
Extent	get­Domain­Of­Validity()	Area or region or timeframe in which this datum is valid.
International­String	get­Scope()	Description of domain of usage, or limitations of usage, for which this datum object is valid.

Methods inherited from interface IdentifiedObject

get­Alias, get­Identifiers, get­Name, get­Remarks, to­WKT

Modifier and Type	Method	Description
Collection<Generic­Name>	get­Alias()	An alternative name by which this object is identified.
Set<Reference­Identifier>	get­Identifiers()	An identifier which references elsewhere the object's defining information.
Reference­Identifier	get­Name()	The primary name by which this object is identified.
International­String	get­Remarks()	Comments on or information about this object, including data source information.
String	to­WKT()	Returns a Well Known Text (WKT) for this object.

Method Details

getOrigin

@UML(identifier="origin",
     obligation=MANDATORY,
     specification=ISO_19111)
Date getOrigin()

The date and time origin of this temporal datum.

Warning: The return type of this method may change in GeoAPI 3.1 release. It may be replaced by a type matching more closely either ISO 19108 (Temporal Schema) or ISO 19103.

Returns:

The date and time origin of this temporal datum.

getAnchorPoint

@UML(identifier="anchorPoint",
     obligation=FORBIDDEN,
     specification=ISO_19111)
InternationalString getAnchorPoint()

This attribute is defined in the Datum parent interface, but is not used by a temporal datum.

Specified by:

get­Anchor­Point in interface Datum

Returns:

Always null.

getRealizationEpoch

@UML(identifier="realizationEpoch",
     obligation=FORBIDDEN,
     specification=ISO_19111)
Date getRealizationEpoch()

This attribute is defined in the Datum parent interface, but is not used by a temporal datum.

Warning: The return type of this method may change in GeoAPI 3.1 release. It may be replaced by a type matching more closely either ISO 19108 (Temporal Schema) or ISO 19103.

Specified by:

get­Realization­Epoch in interface Datum

Returns:

Always null.