org.geotools.referencing.crs
Class AbstractCRS

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractSingleCRS, DefaultCompoundCRS

public abstract class AbstractCRS

extends AbstractReferenceSystem

implements org.opengis.referencing.crs.CoordinateReferenceSystem

Abstract coordinate reference system, usually defined by a coordinate system and a datum.

Since:

2.1

Version:

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

Author:

Martin Desruisseaux

See Also:

AbstractCS, AbstractDatum, Serialized Form

Field Summary

protected org.opengis.referencing.cs.CoordinateSystem

coordinateSystem The coordinate system.

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

AbstractCRS(org.opengis.referencing.crs.CoordinateReferenceSystem crs)
Constructs a new coordinate reference system with the same values than the specified one.

AbstractCRS(java.util.Map properties, org.opengis.referencing.cs.CoordinateSystem cs)
Constructs a coordinate reference system from a set of properties.

Method Summary

Measure	distance(double[] coord1, double[] coord2) Computes the distance between two points.
boolean	equals(AbstractIdentifiedObject object, boolean compareMetadata) Compare this coordinate reference system with the specified object for equality.
protected java.lang.String	formatWKT(Formatter formatter) Format the inner part of a Well Known Text (WKT) element.
org.opengis.referencing.cs.CoordinateSystem	getCoordinateSystem() Returns the coordinate system.
int	hashCode() Returns a hash value for this CRS.

Methods inherited from class org.geotools.referencing.AbstractReferenceSystem

getScope, getValidArea

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, nameMatches, nameMatches

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

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.ReferenceSystem

getScope, getValidArea

Methods inherited from interface org.opengis.referencing.IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Detail

coordinateSystem

protected final org.opengis.referencing.cs.CoordinateSystem coordinateSystem

The coordinate system.

Constructor Detail

AbstractCRS

public AbstractCRS(org.opengis.referencing.crs.CoordinateReferenceSystem crs)

Constructs a new coordinate 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

AbstractCRS

public AbstractCRS(java.util.Map properties,
                   org.opengis.referencing.cs.CoordinateSystem cs)

Constructs a coordinate reference system from a set of properties. The properties are given unchanged to the super-class constructor.

Parameters:

properties - Set of properties. Should contains at least "name".

cs - The coordinate system.

Method Detail

getCoordinateSystem

public org.opengis.referencing.cs.CoordinateSystem getCoordinateSystem()

Returns the coordinate system.

Specified by:

getCoordinateSystem in interface org.opengis.referencing.crs.CoordinateReferenceSystem

distance

public Measure distance(double[] coord1,
                        double[] coord2)
                 throws java.lang.UnsupportedOperationException,
                        org.opengis.spatialschema.geometry.MismatchedDimensionException

Computes the distance between two points. This convenience method delegates the work to the underlyling coordinate system, if possible.

Parameters:

coord1 - Coordinates of the first point.

coord2 - Coordinates of the second point.

Returns:

The distance between and .

Throws:

java.lang.UnsupportedOperationException - if this coordinate reference system can't compute distances.

org.opengis.spatialschema.geometry.MismatchedDimensionException - if a coordinate doesn't have the expected dimension.

equals

public boolean equals(AbstractIdentifiedObject object,
                      boolean compareMetadata)

Compare this coordinate 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 AbstractReferenceSystem

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.

hashCode

public int hashCode()

Returns a hash value for this CRS. Name, identifiers and remarks are not taken in account. In other words, two CRS objects will return the same hash value if they are equal in the sense of equals(AbstractIdentifiedObject, false).

Overrides:

hashCode in class AbstractIdentifiedObject

Returns:

The hash code value. This value doesn't need to be the same in past or future versions of this class.

formatWKT

protected java.lang.String formatWKT(Formatter formatter)

Format the inner part of a Well Known Text (WKT) element. The default implementation write the following elements:

• The unit if all axis use the same unit. Otherwise the unit is omitted and the WKT format is flagged as invalid.
• All coordinate system's axis.

Overrides:

formatWKT in class Formattable

Parameters:

formatter - The formatter to use.

Returns:

The WKT element name.

See Also:

Formattable.toWKT(), Formattable.toString()