org.geotools.referencing.crs
Class DefaultProjectedCRS

Object
  extended by Formattable
      extended by AbstractIdentifiedObject
          extended by AbstractReferenceSystem
              extended by AbstractCRS
                  extended by AbstractSingleCRS
                      extended by AbstractDerivedCRS
                          extended by DefaultProjectedCRS
All Implemented Interfaces:
Serializable, CoordinateReferenceSystem, GeneralDerivedCRS, ProjectedCRS, SingleCRS, IdentifiedObject, ReferenceSystem

public class DefaultProjectedCRS
extends AbstractDerivedCRS
implements ProjectedCRS

A 2D coordinate reference system used to approximate the shape of the earth on a planar surface. It is done in such a way that the distortion that is inherent to the approximation is carefully controlled and known. Distortion correction is commonly applied to calculated bearings and distances to produce values that are a close match to actual field values.

Used with CS type(s)
Cartesian

Since:
2.1
Author:
Martin Desruisseaux (IRD)
See Also:
Serialized Form
Module:
modules/library/referencing (gt-referencing.jar)

Field Summary
 
Fields inherited from class AbstractDerivedCRS
_COMPARING, baseCRS, CONVERSION_TYPE_KEY, conversionFromBase
 
Fields inherited from class AbstractSingleCRS
datum
 
Fields inherited from class AbstractCRS
coordinateSystem
 
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
DefaultProjectedCRS(Map<String,?> properties, Conversion conversionFromBase, GeographicCRS base, MathTransform baseToDerived, CartesianCS derivedCS)
          Constructs a projected CRS from a defining conversion.
DefaultProjectedCRS(Map<String,?> properties, GeographicCRS base, MathTransform baseToDerived, CartesianCS derivedCS)
          Constructs a projected CRS from a set of properties.
DefaultProjectedCRS(Map<String,?> properties, OperationMethod method, GeographicCRS base, MathTransform baseToDerived, CartesianCS derivedCS)
          Deprecated. Create explicitly a DefiningConversion instead.
DefaultProjectedCRS(ProjectedCRS crs)
          Constructs a new projected CRS with the same values than the specified one.
DefaultProjectedCRS(String name, GeographicCRS base, MathTransform baseToDerived, CartesianCS derivedCS)
          Constructs a projected CRS from a name.
 
Method Summary
protected  String formatWKT(Formatter formatter)
          Format the inner part of a Well Known Text (WKT) element.
 GeographicCRS getBaseCRS()
          Returns the base coordinate reference system, which must be geographic.
 Projection getConversionFromBase()
          Returns the map projection from the base CRS to this CRS.
 CartesianCS getCoordinateSystem()
          Returns the coordinate system.
 GeodeticDatum getDatum()
          Returns the datum.
 int hashCode()
          Returns a hash value for this projected CRS.
 
Methods inherited from class AbstractDerivedCRS
equals
 
Methods inherited from class AbstractSingleCRS
getAxis, getDimension
 
Methods inherited from class AbstractCRS
distance
 
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
cleanupThreadLocals, toString, toWKT, toWKT, toWKT
 
Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ReferenceSystem
getDomainOfValidity, getScope
 
Methods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
 

Constructor Detail

DefaultProjectedCRS

public DefaultProjectedCRS(ProjectedCRS crs)
Constructs a new projected CRS 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:
crs - The coordinate reference system to copy.
Since:
2.2

DefaultProjectedCRS

public DefaultProjectedCRS(String name,
                           GeographicCRS base,
                           MathTransform baseToDerived,
                           CartesianCS derivedCS)
                    throws MismatchedDimensionException
Constructs a projected CRS from a name. A default operation method is inferred from the math transform. This is a convenience constructor that is not garanteed to work reliably for non-GeoTools implementations. Use the constructor expecting a defining conversion for more determinist result.

Parameters:
name - The name.
base - Coordinate reference system to base the derived CRS on.
baseToDerived - The transform from the base CRS to returned CRS.
derivedCS - The coordinate system for the derived CRS. The number of axes must match the target dimension of the transform baseToDerived.
Throws:
MismatchedDimensionException - if the source and target dimension of baseToDeviced don't match the dimension of base and derivedCS respectively.
Since:
2.5

DefaultProjectedCRS

public DefaultProjectedCRS(Map<String,?> properties,
                           GeographicCRS base,
                           MathTransform baseToDerived,
                           CartesianCS derivedCS)
                    throws MismatchedDimensionException
Constructs a projected CRS from a set of properties. A default operation method is inferred from the math transform. This is a convenience constructor that is not garanteed to work reliably for non-GeoTools implementations. Use the constructor expecting a defining conversion for more determinist result.

The properties are given unchanged to the super-class constructor.

Parameters:
properties - Name and other properties to give to the new derived CRS object and to the underlying projection.
base - Coordinate reference system to base the derived CRS on.
baseToDerived - The transform from the base CRS to returned CRS.
derivedCS - The coordinate system for the derived CRS. The number of axes must match the target dimension of the transform baseToDerived.
Throws:
MismatchedDimensionException - if the source and target dimension of baseToDeviced don't match the dimension of base and derivedCS respectively.
Since:
2.5

DefaultProjectedCRS

public DefaultProjectedCRS(Map<String,?> properties,
                           OperationMethod method,
                           GeographicCRS base,
                           MathTransform baseToDerived,
                           CartesianCS derivedCS)
                    throws MismatchedDimensionException
Deprecated. Create explicitly a DefiningConversion instead.

Constructs a projected CRS from a set of properties. The properties are given unchanged to the super-class constructor.

Parameters:
properties - Name and other properties to give to the new derived CRS object and to the underlying projection.
method - A description of the method for the conversion.
base - Coordinate reference system to base the derived CRS on.
baseToDerived - The transform from the base CRS to returned CRS.
derivedCS - The coordinate system for the derived CRS. The number of axes must match the target dimension of the transform baseToDerived.
Throws:
MismatchedDimensionException - if the source and target dimension of baseToDeviced don't match the dimension of base and derivedCS respectively.

DefaultProjectedCRS

public DefaultProjectedCRS(Map<String,?> properties,
                           Conversion conversionFromBase,
                           GeographicCRS base,
                           MathTransform baseToDerived,
                           CartesianCS derivedCS)
                    throws MismatchedDimensionException
Constructs a projected CRS from a defining conversion. The properties are given unchanged to the super-class constructor.

Parameters:
properties - Name and other properties to give to the new projected CRS object.
conversionFromBase - The defining conversion.
base - Coordinate reference system to base the projected CRS on.
baseToDerived - The transform from the base CRS to returned CRS.
derivedCS - The coordinate system for the projected CRS. The number of axes must match the target dimension of the transform baseToDerived.
Throws:
MismatchedDimensionException - if the source and target dimension of baseToDerived don't match the dimension of base and derivedCS respectively.
Method Detail

getCoordinateSystem

public CartesianCS getCoordinateSystem()
Returns the coordinate system.

Specified by:
getCoordinateSystem in interface CoordinateReferenceSystem
Specified by:
getCoordinateSystem in interface ProjectedCRS
Specified by:
getCoordinateSystem in interface SingleCRS
Overrides:
getCoordinateSystem in class AbstractCRS

getDatum

public GeodeticDatum getDatum()
Returns the datum.

Specified by:
getDatum in interface ProjectedCRS
Specified by:
getDatum in interface SingleCRS
Overrides:
getDatum in class AbstractSingleCRS
Returns:
The datum.

getBaseCRS

public GeographicCRS getBaseCRS()
Returns the base coordinate reference system, which must be geographic.

Specified by:
getBaseCRS in interface GeneralDerivedCRS
Specified by:
getBaseCRS in interface ProjectedCRS
Overrides:
getBaseCRS in class AbstractDerivedCRS
Returns:
The base CRS.

getConversionFromBase

public Projection getConversionFromBase()
Returns the map projection from the base CRS to this CRS.

Specified by:
getConversionFromBase in interface GeneralDerivedCRS
Specified by:
getConversionFromBase in interface ProjectedCRS
Overrides:
getConversionFromBase in class AbstractDerivedCRS
Returns:
The map projection from base CRS to this CRS.

hashCode

public int hashCode()
Returns a hash value for this projected CRS.

Overrides:
hashCode in class AbstractDerivedCRS
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)
Format the inner part of a Well Known Text (WKT) element.

Overrides:
formatWKT in class AbstractDerivedCRS
Parameters:
formatter - The formatter to use.
Returns:
The name of the WKT element type, which is "PROJCS".
See Also:
Formattable.toWKT(), Formattable.toString()


Copyright © 1996-2010 Geotools. All Rights Reserved.