org.geotools.referencing

Class AbstractReferenceSystem

Object

Formattable

AbstractIdentifiedObject

AbstractReferenceSystem

All Implemented Interfaces:

Serializable, IdentifiedObject, ReferenceSystem

Direct Known Subclasses:

AbstractCRS

public class AbstractReferenceSystem
extends AbstractIdentifiedObject
implements ReferenceSystem

Description of a spatial and temporal reference system used by a dataset.

This class is conceptually abstract, even if it is technically possible to instantiate it. Typical applications should create instances of the most specific subclass with Default prefix instead. An exception to this rule may occurs when it is not possible to identify the exact type.

Since:

2.1

Author:

Martin Desruisseaux (IRD)

See Also:

Serialized Form

Field Summary

Fields inherited from class AbstractIdentifiedObject

EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR

Fields inherited from class Formattable

SINGLE_LINE

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
AbstractReferenceSystem(Map<String,?> properties) Constructs a reference system from a set of properties.
AbstractReferenceSystem(ReferenceSystem object) Constructs a new reference system with the same values than the specified one.

Method Summary

Modifier and Type	Method and Description
boolean	equals(AbstractIdentifiedObject object, boolean compareMetadata) Compare this reference system with the specified object for equality.
Extent	getDomainOfValidity() Area or region or timeframe in which this (coordinate) reference system is valid.
InternationalString	getScope() Description of domain of usage, or limitations of usage, for which this (coordinate) reference system object is valid.
Extent	getValidArea() Deprecated. Renamed getDomainOfValidity().

Methods inherited from class AbstractIdentifiedObject

asSet, ensureAngularUnit, ensureLinearUnit, ensureNonNull, ensureNonNull, ensureTimeUnit, equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, hashCode, nameMatches, nameMatches, nameMatches

Methods inherited from class Formattable

cleanupThreadLocals, formatWKT, toString, toWKT, toWKT, toWKT, toWKT

Methods inherited from class Object

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

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Constructor Detail

AbstractReferenceSystem

public AbstractReferenceSystem(ReferenceSystem object)

Constructs a new reference system with the same values than the specified one. This copy constructor provides a way to wrap an arbitrary implementation into a Geotools 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:

object - The reference system to copy.

Since:

2.2

AbstractReferenceSystem

public AbstractReferenceSystem(Map<String,?> properties)

Constructs a reference system from a set of properties. The properties given in argument follow the same rules than for the super-class constructor. Additionally, the following properties are understood by this construtor:

Property name	Value type	Value given to
"domainOfValidity"	Extent	getDomainOfValidity()
"scope"	String or InternationalString	getScope()

Parameters:

properties - The properties to be given to this object.

Method Detail

getDomainOfValidity

public Extent getDomainOfValidity()

Area or region or timeframe in which this (coordinate) reference system is valid. Returns null if not available.

Specified by:

getDomainOfValidity in interface ReferenceSystem

Returns:

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

Since:

2.4

getValidArea

public Extent getValidArea()

Deprecated. Renamed getDomainOfValidity().

Area for which the (coordinate) reference system is valid. Returns null if not available.

getScope

public InternationalString getScope()

Description of domain of usage, or limitations of usage, for which this (coordinate) reference system object is valid. Returns null if not available.

Specified by:

getScope in interface ReferenceSystem

Returns:

The domain of usage, or null if none.

equals

public boolean equals(AbstractIdentifiedObject object,
                      boolean compareMetadata)

Compare this reference system with the specified object for equality. If compareMetadata is true, then all available properties are compared including valid area and scope.

Overrides:

equals in class AbstractIdentifiedObject

Parameters:

object - The object to compare to this.

compareMetadata - true for performing a strict comparaison, or false for comparing only properties relevant to transformations.

Returns:

true if both objects are equal.