org.deegree.cs.configuration
Interface CRSProvider

All Known Implementing Classes:

AbstractCRSProvider, DeegreeCRSProvider, GMLCRSProvider, PROJ4CRSProvider

public interface CRSProvider

The CRSProvider will allow the support for different crs-definitions formats within the crs package. All implementation should consider the fact that the deegree-crs package will assume all incoming and outgoing latitude/longitude coordinates in radians. Dependent on the forceXY flag it is possible to set the axis order to x/y (EAST/NORTH; WEST/SOUTH). If this flag is true and the defined axis order is not x/y, the axis order will be swapped. By default the defined axis order will be used.

Version:

$Revision: 25628 $, $Date: 2010-08-02 10:16:18 +0200 (Mo, 02. Aug 2010) $

Author:

Rutger Bezema, last edited by: $Author: lbuesching $

Method Summary

boolean	canExport()
void	export(java.lang.StringBuilder sb, java.util.List<CoordinateSystem> crsToExport) Exports the crs to the implemented format.
java.util.List<CRSCodeType[]>	getAvailableCRSCodes() This method should be called if one is only interested in the available identifiers and not in the coordinatesystems themselves.
java.util.List<CoordinateSystem>	getAvailableCRSs() This method should be called to see if the provider is able to create all defined crs's, thus verifying the correctness of the configuration.
CoordinateSystem	getCRSByCode(CRSCodeType id)
CoordinateSystem	getCRSByCode(CRSCodeType id, boolean forceXY)
CRSIdentifiable	getIdentifiable(CRSCodeType id) This method is more general than the getCRSByCode(CRSCodeType), because it represents a possibility to return an arbitrary CRSIdentifiable Object from the providers backend.
Transformation	getTransformation(CoordinateSystem sourceCRS, CoordinateSystem targetCRS) This method is should retrieve a transformation (chain) which transforms coordinates from the given source into the given target crs.

Method Detail

getTransformation

Transformation getTransformation(CoordinateSystem sourceCRS,
                                 CoordinateSystem targetCRS)
                                 throws CRSConfigurationException

This method is should retrieve a transformation (chain) which transforms coordinates from the given source into the given target crs. If no such transformation could be found or the implementation does not support inverse lookup of transformations null should be returned.

Parameters:

sourceCRS - start of the transformation (chain)

targetCRS - end point of the transformation (chain).

Returns:

the Transformation Object or null if no such Object was found.

Throws:

CRSConfigurationException - if the implementation was confronted by an exception and could not deliver the requested Object. This exception should not be thrown no Transformation was found, in this case null should be returned.

getIdentifiable

CRSIdentifiable getIdentifiable(CRSCodeType id)
                                throws CRSConfigurationException

This method is more general than the getCRSByCode(CRSCodeType), because it represents a possibility to return an arbitrary CRSIdentifiable Object from the providers backend.

Parameters:

id - string representation of the resource to retrieve

Returns:

the CRSIdentifiable Object or null if no such Object was found.

Throws:

CRSConfigurationException - if the implementation was confronted by an exception and could not deliver the requested Object. This exception should not be thrown if the given id wasn't found, in this case null should be returned.

getCRSByCode

CoordinateSystem getCRSByCode(CRSCodeType id)
                              throws CRSConfigurationException

Parameters:

id - string representation of the CoordinateSystem

Returns:

the identified CRS or null if no such CRS was found.

Throws:

CRSConfigurationException - if the implementation was confronted by an exception and could not deliver the requested crs. This exception should not be thrown if the given id wasn't found, in this case null should be returned.

getCRSByCode

CoordinateSystem getCRSByCode(CRSCodeType id,
                              boolean forceXY)
                              throws CRSConfigurationException

Parameters:

id - string representation of the CoordinateSystem

forceXY - true if the axis order of the coordinate system should be x/y (EAST/NORTH; WEST/SOUTH); false if the defined axis order should be used

Returns:

the identified CRS or null if no such CRS was found.

Throws:

CRSConfigurationException - if the implementation was confronted by an exception and could not deliver the requested crs. This exception should not be thrown if the given id wasn't found, in this case null should be returned.

getAvailableCRSs

java.util.List<CoordinateSystem> getAvailableCRSs()
                                                  throws CRSConfigurationException

This method should be called to see if the provider is able to create all defined crs's, thus verifying the correctness of the configuration.

Returns:

all configured CRSs.

Throws:

CRSConfigurationException - if the implementation was confronted by an exception and could not deliver the requested crs. This exception should not be thrown if no CoordinateSystems were found, in the latter case an empty List ( a list with size == 0 ) should be returned.

getAvailableCRSCodes

java.util.List<CRSCodeType[]> getAvailableCRSCodes()
                                                   throws CRSConfigurationException

This method should be called if one is only interested in the available identifiers and not in the coordinatesystems themselves.

Returns:

the identifiers of all configured CRSs.

Throws:

CRSConfigurationException - if the implementation was confronted by an exception and could not deliver the requested crs. This exception should not be thrown if no CoordinateSystems were found, in the latter case an empty List ( a list with size == 0 ) should be returned.

export

void export(java.lang.StringBuilder sb,
            java.util.List<CoordinateSystem> crsToExport)

Exports the crs to the implemented format. Try calling canExport() before executing this method.

Parameters:

sb - the StringBuilder which will contain the exported version of the given crs.

crsToExport - the CoordinateSystems to export.

See Also:

canExport()

canExport

boolean canExport()

Returns:

true if this provider can export a given crs.