org.geotools.referencing.crs
Class AbstractCRS

Object
  Formattable
      AbstractIdentifiedObject
          AbstractReferenceSystem
              AbstractCRS

All Implemented Interfaces:

Serializable, CoordinateReferenceSystem, IdentifiedObject, ReferenceSystem

Direct Known Subclasses:

AbstractSingleCRS, DefaultCompoundCRS

public abstract class AbstractCRS
extends AbstractReferenceSystem
implements CoordinateReferenceSystem

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

Since:

2.1

Author:

Martin Desruisseaux

See Also:

AbstractCS, AbstractDatum, Serialized Form

Tutorial:

Coordinate Transformation Services for Geotools 2.1

Module:

modules/library/referencing (gt2-referencing.jar) (Maven report) (SVN head)

Field Summary

protected CoordinateSystem

coordinateSystem The coordinate system.

Fields inherited from class AbstractIdentifiedObject

EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR

Fields inherited from interface ReferenceSystem

DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY, VALID_AREA_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

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

AbstractCRS(Map properties, 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 String	formatWKT(Formatter formatter) Formats the inner part of a Well Known Text (WKT) element.
CoordinateSystem	getCoordinateSystem() Returns the coordinate system.
int	hashCode() Returns a hash value for this CRS.

Methods inherited from class AbstractReferenceSystem

getDomainOfValidity, getScope, getValidArea

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

Methods inherited from class Formattable

toString, toWKT, toWKT, toWKT

Methods inherited from class Object

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

Methods inherited from interface ReferenceSystem

getDomainOfValidity, getScope, getValidArea

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Detail

coordinateSystem

protected final CoordinateSystem coordinateSystem

The coordinate system.

Constructor Detail

AbstractCRS

public AbstractCRS(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(Map properties,
                   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 CoordinateSystem getCoordinateSystem()

Returns the coordinate system.

Specified by:

getCoordinateSystem in interface CoordinateReferenceSystem

distance

public Measure distance(double[] coord1,
                        double[] coord2)
                 throws UnsupportedOperationException,
                        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 coord1 and coord2.

Throws:

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

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 compareMetadata is true, then all available properties are compared including valid area and scope.

Overrides:

equals in class AbstractReferenceSystem

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.

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 String formatWKT(Formatter formatter)

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

• The datum, if any.
• 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 name of the WKT element type (e.g. "GEOGCS").

See Also:

Formattable.toWKT(), Formattable.toString()