org.geotools.referencing
Class AbstractReferenceSystem

java.lang.Object
  org.geotools.referencing.wkt.Formattable
      org.geotools.referencing.AbstractIdentifiedObject
          org.geotools.referencing.AbstractReferenceSystem

All Implemented Interfaces:

org.opengis.referencing.IdentifiedObject, org.opengis.referencing.ReferenceSystem, java.io.Serializable

Direct Known Subclasses:

AbstractCRS

public class AbstractReferenceSystem

extends AbstractIdentifiedObject

implements org.opengis.referencing.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 prefix instead. An exception to this rule may occurs when it is not possible to identify the exact type.

Since:

2.1

Version:

$Id: AbstractReferenceSystem.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux

See Also:

Serialized Form

Field Summary

Fields inherited from class org.geotools.referencing.AbstractIdentifiedObject

EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR

Fields inherited from interface org.opengis.referencing.ReferenceSystem

SCOPE_KEY, VALID_AREA_KEY

Fields inherited from interface org.opengis.referencing.IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

AbstractReferenceSystem(java.util.Map properties)
Constructs a reference system from a set of properties.

AbstractReferenceSystem(org.opengis.referencing.ReferenceSystem object)
Constructs a new reference system with the same values than the specified one.

Method Summary

boolean	equals(AbstractIdentifiedObject object, boolean compareMetadata) Compare this reference system with the specified object for equality.
org.opengis.util.InternationalString	getScope() Description of domain of usage, or limitations of usage, for which this (coordinate) reference system object is valid.
org.opengis.metadata.extent.Extent	getValidArea() Area for which the (coordinate) reference system is valid.

Methods inherited from class org.geotools.referencing.AbstractIdentifiedObject

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

Methods inherited from class org.geotools.referencing.wkt.Formattable

formatWKT, toString, toWKT, toWKT, toWKT

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opengis.referencing.IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Constructor Detail

AbstractReferenceSystem

public AbstractReferenceSystem(org.opengis.referencing.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.

Since:

2.2

AbstractReferenceSystem

public AbstractReferenceSystem(java.util.Map 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
"validArea"	Extent	getValidArea()
"scope"	String or InternationalString	getScope()

Method Detail

getValidArea

public org.opengis.metadata.extent.Extent getValidArea()

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

Specified by:

getValidArea in interface org.opengis.referencing.ReferenceSystem

getScope

public org.opengis.util.InternationalString getScope()

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

Specified by:

getScope in interface org.opengis.referencing.ReferenceSystem

equals

public boolean equals(AbstractIdentifiedObject object,
                      boolean compareMetadata)

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

Overrides:

equals in class AbstractIdentifiedObject

Parameters:

object - The object to compare to .

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

Returns:

if both objects are equal.