org.jscience.geography.coordinates.crs
Class CoordinateReferenceSystem<C extends Coordinates<?>>

java.lang.Object
  org.jscience.geography.coordinates.crs.CoordinateReferenceSystem<C>

All Implemented Interfaces:

org.opengis.referencing.crs.CoordinateReferenceSystem, org.opengis.referencing.IdentifiedObject, org.opengis.referencing.ReferenceSystem

Direct Known Subclasses:

CompoundCRS, GeocentricCRS, GeographicCRS, ProjectedCRS, TemporalCRS, VerticalCRS

public abstract class CoordinateReferenceSystem<C extends Coordinates<?>>
extends java.lang.Object
implements org.opengis.referencing.crs.CoordinateReferenceSystem

This class represents an arbitrary system of reference for which coordinates of same significance can be stated.

Version:

3.0, February 13, 2006

Author:

Jean-Marie Dautelle

Nested Class Summary

protected static class

CoordinateReferenceSystem.AbsolutePosition This class represents an absolute position (can be be extended)

Field Summary

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

CoordinateReferenceSystem()

Method Summary

protected abstract C	coordinatesOf(CoordinateReferenceSystem.AbsolutePosition position) Returns the coordinates in this reference system of the specified absolute position.
java.util.Collection<java.lang.String>	getAlias() OpenGIS® - An alternative name by which this object is identified.
<T extends Coordinates<?>> CoordinatesConverter<C,T>	getConverterTo(CoordinateReferenceSystem<T> that) Returns the converter between this coordinate reference system and the one specified.
abstract org.opengis.referencing.cs.CoordinateSystem	getCoordinateSystem() Returns the OpenGIS coordinate system associated to this coordinate reference system.
java.util.Set<java.lang.String>	getIdentifiers() OpenGIS® - An identifier which references elsewhere the object's defining information.
org.opengis.metadata.Identifier	getName() OpenGIS® - The primary name by which this object is identified.
org.opengis.util.InternationalString	getRemarks() OpenGIS® - Comments on or information about this object, including data source information.
org.opengis.util.InternationalString	getScope() OpenGIS® - Description of domain of usage, or limitations of usage, for which this (coordinate) reference system object is valid.
org.opengis.metadata.extent.Extent	getValidArea() OpenGIS® - Area for which the (coordinate) reference system is valid.
protected abstract CoordinateReferenceSystem.AbsolutePosition	positionOf(C coordinates, CoordinateReferenceSystem.AbsolutePosition position) Returns the absolute position from the coordinates in this reference system.
java.lang.String	toWKT() OpenGIS® - Returns a Well Known Text (WKT) for this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CoordinateReferenceSystem

public CoordinateReferenceSystem()

Method Detail

getConverterTo

public <T extends Coordinates<?>> CoordinatesConverter<C,T> getConverterTo(CoordinateReferenceSystem<T> that)

Returns the converter between this coordinate reference system and the one specified.

Parameters:

that - the coordinate reference system to convert to.

Returns:

the corresponding coordinates converter.

Throws:

ConversionException - if the conversion is not possible (e.g. geographic to temporal).

coordinatesOf

protected abstract C coordinatesOf(CoordinateReferenceSystem.AbsolutePosition position)

Returns the coordinates in this reference system of the specified absolute position.

Parameters:

position - the absolute position for which the coordinates in this reference system is returned.

Returns:

the coordinates for the specified absolute position.

Throws:

ConversionException - if a conversion error occurs.

positionOf

protected abstract CoordinateReferenceSystem.AbsolutePosition positionOf(C coordinates,
                                                                         CoordinateReferenceSystem.AbsolutePosition position)

Returns the absolute position from the coordinates in this reference system. This update may require information already supplied by the position. For example, the height for a pressure altitude might depends upon the latitude/longitude and the time.

Parameters:

coordinates - the coordinates for which the absolute position is adjusted.

position - the position object to update.

Returns:

the corresponding absolute position.

Throws:

ConversionException - if a conversion error occurs.

getCoordinateSystem

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

Returns the OpenGIS coordinate system associated to this coordinate reference system.

Specified by:

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

Returns:

the corresponding coordinate system.

getValidArea

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

OpenGIS® - Area for which the (coordinate) reference system is valid.

Specified by:

getValidArea in interface org.opengis.referencing.ReferenceSystem

Returns:

coordinate reference system valid area, or null (default) if not available.

getScope

public org.opengis.util.InternationalString getScope()

OpenGIS® - Description of domain of usage, or limitations of usage, for which this (coordinate) reference system object is valid.

Specified by:

getScope in interface org.opengis.referencing.ReferenceSystem

getName

public org.opengis.metadata.Identifier getName()

OpenGIS® - The primary name by which this object is identified.

Specified by:

getName in interface org.opengis.referencing.IdentifiedObject

Returns:

an identifier holding the class name.

getAlias

public java.util.Collection<java.lang.String> getAlias()

OpenGIS® - An alternative name by which this object is identified.

Specified by:

getAlias in interface org.opengis.referencing.IdentifiedObject

Returns:

The aliases, or an empty collection if there is none.

getIdentifiers

public java.util.Set<java.lang.String> getIdentifiers()

OpenGIS® - An identifier which references elsewhere the object's defining information. Alternatively an identifier by which this object can be referenced.

Specified by:

getIdentifiers in interface org.opengis.referencing.IdentifiedObject

Returns:

This object identifiers, or an empty set if there is none.

getRemarks

public org.opengis.util.InternationalString getRemarks()

OpenGIS® - Comments on or information about this object, including data source information.

Specified by:

getRemarks in interface org.opengis.referencing.IdentifiedObject

Returns:

null (default).

toWKT

public java.lang.String toWKT()
                       throws java.lang.UnsupportedOperationException

OpenGIS® - Returns a Well Known Text (WKT) for this object. This operation may fails if an object is too complex for the WKT format capability (for example an engineering CRS} with different unit for each axis).

Specified by:

toWKT in interface org.opengis.referencing.IdentifiedObject

Returns:

The Well Know Text for this object.

Throws:

java.lang.UnsupportedOperationException - If this object can't be formatted as WKT (default).