org.deegree.cs.configuration
Class AbstractCRSProvider<T>

java.lang.Object
  org.deegree.cs.configuration.AbstractCRSProvider<T>

Type Parameters:

T - the type of object the parse method awaits.

All Implemented Interfaces:

CRSProvider

Direct Known Subclasses:

DeegreeCRSProvider, GMLCRSProvider, PROJ4CRSProvider

public abstract class AbstractCRSProvider<T>
extends java.lang.Object
implements CRSProvider

The base class for a CRSProvider which has a caching mechanism for CRSIdentifiables and instantiates a given resolver used for inverse lookup.

Version:

$Revision: 26874 $, $Date: 2010-09-21 13:46:17 +0200 (Di, 21. Sep 2010) $

Author:

Rutger Bezema

Constructor Summary

AbstractCRSProvider(java.util.Properties properties, java.lang.Class<K> subType, CRSResource<T> defaultResolver)

Method Summary

<V extends CRSIdentifiable> V	addIdToCache(V identifiable, boolean update) Add the id to the cache, by mapping it to all its identifiers.
void	clearCache() Clears the cache.
<V extends CRSIdentifiable> V	getCachedIdentifiable(java.lang.Class<V> expectedType, CRSCodeType id) Get a CRSIdentifiable (actually a type V that extends it) from the cache that corresponds to the a CRSCodeType.
<V extends CRSIdentifiable> V	getCachedIdentifiable(java.lang.Class<V> expectedType, CRSCodeType[] ids) Get a CRSIdentifiable (actually a type V that extends it) from the cache that corresponds to the a CRSCodeType.
<V extends CRSIdentifiable> V	getCachedIdentifiable(java.lang.Class<V> expectedType, CRSIdentifiable ids) The id are what they are, not trimming 'upcasing' or other modifications will be done in this method.
<V extends CRSIdentifiable> V	getCachedIdentifiable(java.lang.Class<V> expectedType, java.lang.String id) The id is as it is, not trimming 'upcasing' or other modifications will be done in this method.
<V extends CRSIdentifiable> V	getCachedIdentifiable(java.lang.Class<V> expectedType, java.lang.String[] ids) The id are what they are, not trimming 'upcasing' or other modifications will be done in this method.
<V extends CRSIdentifiable> V	getCachedIdentifiable(CRSCodeType id) Get a CRSIdentifiable (actually a type V that extends it) from the cache that corresponds to the a CRSCodeType.
<V extends CRSIdentifiable> V	getCachedIdentifiable(java.lang.String id) The id is as it is, not trimming 'upcasing' or other modifications will be done in this method.
CoordinateSystem	getCRSByCode(CRSCodeType id) Retrieves the CoordinateSystem from the set provider that is identified by the given CRSCodeType id.
CoordinateSystem	getCRSByCode(CRSCodeType id, boolean forceXY)
protected CRSResource<T>	getResolver()
protected abstract CoordinateSystem	parseCoordinateSystem(T crsDefinition)
abstract Transformation	parseTransformation(T transformationDefinition)
protected void	setResolver(CRSResource<T> newResolver) Set the resolver to the given resolver.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.deegree.cs.configuration.CRSProvider

canExport, export, getAvailableCRSCodes, getAvailableCRSs, getIdentifiable, getTransformation

Constructor Detail

AbstractCRSProvider

public AbstractCRSProvider(java.util.Properties properties,
                           java.lang.Class<K> subType,
                           CRSResource<T> defaultResolver)

Type Parameters:

K -

Parameters:

properties -

subType -

defaultResolver -

Method Detail

getCRSByCode

public CoordinateSystem getCRSByCode(CRSCodeType id)
                              throws CRSConfigurationException

Retrieves the CoordinateSystem from the set provider that is identified by the given CRSCodeType id.

Specified by:

getCRSByCode in interface CRSProvider

Parameters:

id - the CRSCodeType of the wanted crs

Returns:

the CoordinateSystem that corresponds to the id

Throws:

CRSConfigurationException

getCRSByCode

public CoordinateSystem getCRSByCode(CRSCodeType id,
                                     boolean forceXY)
                              throws CRSConfigurationException

Specified by:

getCRSByCode in interface CRSProvider

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.

setResolver

protected void setResolver(CRSResource<T> newResolver)

Set the resolver to the given resolver.

Parameters:

newResolver -

getResolver

protected CRSResource<T> getResolver()

Returns:

the resolver for a type.

parseCoordinateSystem

protected abstract CoordinateSystem parseCoordinateSystem(T crsDefinition)
                                                   throws CRSConfigurationException

Parameters:

crsDefinition - containing the definition of a crs in the understood type.

Returns:

a CoordinateSystem instance initialized with values from the given type definition fragment or null if the given crsDefinition is null or not known.

Throws:

CRSConfigurationException - if an error was found in the given crsDefintion

parseTransformation

public abstract Transformation parseTransformation(T transformationDefinition)
                                            throws CRSConfigurationException

Parameters:

transformationDefinition - containing the parameters needed to build a Transformation.

Returns:

a Transformation instance initialized with values from the given definition or null if the given transformationDefintion is null. If the parsed transformation is not supported or a NotSupportedTransformation will be returned.

Throws:

CRSConfigurationException - if an error was found in the given crsDefintion

clearCache

public void clearCache()

Clears the cache.

getCachedIdentifiable

public <V extends CRSIdentifiable> V getCachedIdentifiable(java.lang.Class<V> expectedType,
                                                           CRSIdentifiable ids)

The id are what they are, not trimming 'upcasing' or other modifications will be done in this method.

Type Parameters:

V - the type to cast to if the casting fails, null will be returned.

Parameters:

expectedType - The class of type T which is expected.

ids - to search the cache for

Returns:

the CRSIdentifiable of the first matching id or null if it was not found.

getCachedIdentifiable

public <V extends CRSIdentifiable> V getCachedIdentifiable(java.lang.Class<V> expectedType,
                                                           java.lang.String[] ids)

The id are what they are, not trimming 'upcasing' or other modifications will be done in this method.

Type Parameters:

V - the type to cast to if the casting fails, null will be returned.

Parameters:

expectedType - The class of type T which is expected.

ids - to search the cache for

Returns:

the CRSIdentifiable of the first matching id or null if it was not found.

getCachedIdentifiable

public <V extends CRSIdentifiable> V getCachedIdentifiable(java.lang.Class<V> expectedType,
                                                           CRSCodeType[] ids)

Get a CRSIdentifiable (actually a type V that extends it) from the cache that corresponds to the a CRSCodeType. An array of code types is given; the first identifiable that is found in (for a code, when they are checked in order) is returned

Type Parameters:

V -

Parameters:

expectedType - the type of the sought object

ids - an array of CRSCodeTypes

Returns:

the identifiable found in the cache corresponding to the (first) id

getCachedIdentifiable

public <V extends CRSIdentifiable> V getCachedIdentifiable(java.lang.Class<V> expectedType,
                                                           java.lang.String id)

The id is as it is, not trimming 'upcasing' or other modifications will be done in this method.

Type Parameters:

V - the type to cast to if the casting fails, null will be returned.

Parameters:

expectedType - The class of type T which is expected.

id - to search the cache for

Returns:

the CRSIdentifiable or null if it was not found or the wrong type was found.

getCachedIdentifiable

public <V extends CRSIdentifiable> V getCachedIdentifiable(java.lang.Class<V> expectedType,
                                                           CRSCodeType id)

Get a CRSIdentifiable (actually a type V that extends it) from the cache that corresponds to the a CRSCodeType.

Type Parameters:

V -

Parameters:

expectedType - the type of the sought object

id - a CRSCodeType

Returns:

the identifiable found in the cache corresponding to the id

getCachedIdentifiable

public <V extends CRSIdentifiable> V getCachedIdentifiable(java.lang.String id)

The id is as it is, not trimming 'upcasing' or other modifications will be done in this method.

Type Parameters:

V - the type to cast to if the casting fails, null will be returned.

Parameters:

id - to search the cache for

Returns:

the CRSIdentifiable or null if it was not found or the wrong type was found.

getCachedIdentifiable

public <V extends CRSIdentifiable> V getCachedIdentifiable(CRSCodeType id)

Get a CRSIdentifiable (actually a type V that extends it) from the cache that corresponds to the a CRSCodeType.

Type Parameters:

V -

Parameters:

id - a CRSCodeType

Returns:

a CRSIdentifiable-extending object that corresponds to the given id

addIdToCache

public <V extends CRSIdentifiable> V addIdToCache(V identifiable,
                                                  boolean update)

Add the id to the cache, by mapping it to all its identifiers.

Type Parameters:

V - type of CRSIdentifiable

Parameters:

identifiable - to insert into cache

update - if true an existing identifiable in the cache will be overwritten.

Returns:

the identifiable