org.geotools.temporal.reference

Class DefaultTemporalReferenceSystem

Object

DefaultTemporalReferenceSystem

All Implemented Interfaces:

IdentifiedObject, ReferenceSystem, TemporalReferenceSystem

Direct Known Subclasses:

DefaultCalendar, DefaultClock, DefaultOrdinalReferenceSystem, DefaultTemporalCoordinateSystem

public class DefaultTemporalReferenceSystem
extends Object
implements TemporalReferenceSystem

Author:

Mehdi Sidhoum (Geomatys)

Field Summary

Fields inherited from interface ReferenceSystem

DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

Constructors

Constructor and Description
DefaultTemporalReferenceSystem(ReferenceIdentifier name, Extent domainOfValidity) Creates a new instance of TemporalReferenceSystem by passing a ReferenceIdentifier name and a domain of validity.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
Collection<GenericName>	getAlias() An alternative name by which this object is identified.
Extent	getDomainOfValidity() Identifies the space and time within which the reference system is applicable.
Set<ReferenceIdentifier>	getIdentifiers() An identifier which references elsewhere the object's defining information.
ReferenceIdentifier	getName() Provides a name that uniquely identifies the temporal referece system.
InternationalString	getRemarks() Comments on or information about this object, including data source information.
InternationalString	getScope() Description of domain of usage, or limitations of usage, for which this (coordinate) reference system object is valid.
Extent	getValidArea() Deprecated.
int	hashCode()
void	setDomainOfValidity(Extent domainOfValidity)
void	setName(ReferenceIdentifier name) This is a name that uniquely identifies the temporal reference system.
void	setScope(InternationalString scope)
void	setValidArea(Extent validArea)
String	toString()
String	toWKT() Returns a Well Known Text (WKT) for this object.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultTemporalReferenceSystem

public DefaultTemporalReferenceSystem(ReferenceIdentifier name,
                                      Extent domainOfValidity)

Creates a new instance of TemporalReferenceSystem by passing a ReferenceIdentifier name and a domain of validity.

Parameters:

name -

domainOfValidity -

Method Detail

getName

public ReferenceIdentifier getName()

Description copied from interface: TemporalReferenceSystem

Provides a name that uniquely identifies the temporal referece system.

Currently returns MD_Identifier, which is defined in ISO 19115, while ISO 19108 requires that RS_Identifier (defined in ISO 19111 and http://www.opengis.org/docs/03-073r1.zip) is returned. From the looks of it, org.opengis.referencing.ReferenceSystem could also fit the bill.

Specified by:

getName in interface IdentifiedObject

Specified by:

getName in interface TemporalReferenceSystem

Returns:

ReferenceIdentifier for the temporal reference system

getDomainOfValidity

public Extent getDomainOfValidity()

Description copied from interface: TemporalReferenceSystem

Identifies the space and time within which the reference system is applicable. The return type allows for describing both spatial and temporal extent. This attribute shall be used whenever an application schema includes TemporalPositions referenced to a reference system which has a valid extent that is less than the extent of a data set containing such values.

Please note this is very similar to ReferenceSystem.getValidArea() from ISO 19115.

Specified by:

getDomainOfValidity in interface ReferenceSystem

Specified by:

getDomainOfValidity in interface TemporalReferenceSystem

Returns:

The reference system valid domain, or null if not available.

getValidArea

@Deprecated
public Extent getValidArea()

Deprecated.

This method is deprecated, please use getDomainOfValidity() method.

Returns:

getScope

public InternationalString getScope()

Description copied from interface: ReferenceSystem

Description of domain of usage, or limitations of usage, for which this (coordinate) reference system object is valid.

Specified by:

getScope in interface ReferenceSystem

Returns:

The domain of usage, or null if none.

getAlias

public Collection<GenericName> getAlias()

Description copied from interface: IdentifiedObject

An alternative name by which this object is identified.

Specified by:

getAlias in interface IdentifiedObject

Returns:

The aliases, or an empty collection if there is none.

getIdentifiers

public Set<ReferenceIdentifier> getIdentifiers()

Description copied from interface: IdentifiedObject

An identifier which references elsewhere the object's defining information. Alternatively an identifier by which this object can be referenced.

Specified by:

getIdentifiers in interface IdentifiedObject

Returns:

This object identifiers, or an empty set if there is none.

getRemarks

public InternationalString getRemarks()

Description copied from interface: IdentifiedObject

Comments on or information about this object, including data source information.

Specified by:

getRemarks in interface IdentifiedObject

Returns:

The remarks, or null if none.

toWKT

public String toWKT()
             throws UnsupportedOperationException

Description copied from interface: IdentifiedObject

Returns a Well Known Text (WKT) for this object. This operation may fails if an object is too complex for the WKT format capability (for example an engineering CRS with different unit for each axis).

Specified by:

toWKT in interface IdentifiedObject

Returns:

The Well Know Text for this object.

Throws:

UnsupportedOperationException - If this object can't be formatted as WKT.

setName

public void setName(ReferenceIdentifier name)

This is a name that uniquely identifies the temporal reference system.

setDomainOfValidity

public void setDomainOfValidity(Extent domainOfValidity)

setValidArea

public void setValidArea(Extent validArea)

setScope

public void setScope(InternationalString scope)

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object