/*
* GeoTools - The Open Source Java GIS Toolkit
* http://geotools.org
*
* (C) 2006-2012, Open Source Geospatial Foundation (OSGeo)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
package org.geotools.referencing.factory;
import java.util.Arrays;
import java.util.List;
import java.util.SortedMap;
import java.util.TreeMap;
import org.geotools.factory.Hints;
import org.geotools.util.Version;
import org.opengis.metadata.citation.Citation;
import org.opengis.referencing.AuthorityFactory;
import org.opengis.referencing.FactoryException;
import org.opengis.referencing.NoSuchAuthorityCodeException;
import org.opengis.referencing.crs.CRSAuthorityFactory;
import org.opengis.referencing.cs.CSAuthorityFactory;
import org.opengis.referencing.datum.DatumAuthorityFactory;
import org.opengis.referencing.operation.CoordinateOperationAuthorityFactory;
/**
* Base class for building OGC URN and HTTP URI wrappers around {@link AllAuthoritiesFactory}.
*
* @author Justin Deoliveira
* @author Martin Desruisseaux
* @author Ben Caradoc-Davies (CSIRO Earth Science and Resource Engineering)
*
* @source $URL$
*/
public abstract class Abstract_URI_AuthorityFactory extends AuthorityFactoryAdapter implements CRSAuthorityFactory,
CSAuthorityFactory, DatumAuthorityFactory, CoordinateOperationAuthorityFactory
{
/**
* The backing factory. Will be used as a fallback if no object
* is available for some specific version of an EPSG database.
*/
private final AllAuthoritiesFactory factory;
/**
* The authority factories by versions. Factories will be created by
* {@link #createVersionedFactory} when first needed.
*/
private final SortedMap<Version, AuthorityFactory> byVersions =
new TreeMap<Version, AuthorityFactory>();
/**
* The parser for the last code processed, or {@code null} if none.
*/
private transient URI_Parser last;
/**
* Creates a default wrapper
*
* @param hintsAuthority the name used to reference thi factory in {@link Hints#FORCE_AXIS_ORDER_HONORING}.
*/
public Abstract_URI_AuthorityFactory(String hintsAuthority) {
this((Hints) null, hintsAuthority);
}
/**
* Creates a wrapper using the specified hints. For strict compliance with OGC definitions, the supplied hints should contains at least the
* {@link Hints#FORCE_LONGITUDE_FIRST_AXIS_ORDER FORCE_LONGITUDE_FIRST_AXIS_ORDER} hint with value {@link Boolean#FALSE FALSE}.
*
* @param userHints The hints to be given to backing factories.
* @param hintsAuthority the name used to reference thi factory in {@link Hints#FORCE_AXIS_ORDER_HONORING}.
*/
public Abstract_URI_AuthorityFactory(final Hints userHints, String hintsAuthority) {
this(HTTP_AuthorityFactory.getFactory(userHints, hintsAuthority));
}
/**
* Creates a wrapper around the specified factory. The supplied factory is given unchanged
* to the {@linkplain AuthorityFactoryAdapter#AuthorityFactoryAdapter(AuthorityFactory)
* super class constructor}.
*/
public Abstract_URI_AuthorityFactory(final AllAuthoritiesFactory factory) {
super(factory);
this.factory = factory;
}
/**
* Subclasses must implement this method to return a subclass of URI_Parser appropriate to their URI.
*
* @param code the URI to be parsed
* @return
*/
protected abstract URI_Parser buildParser(String code) throws NoSuchAuthorityCodeException;
/**
* @see org.geotools.referencing.factory.AuthorityFactoryAdapter#getAuthority()
*/
@Override
public abstract Citation getAuthority();
/**
* Parses the specified code. For performance reason, returns the last result if applicable.
*
* @param code The URI to parse.
* @return parser The parser.
* @throws NoSuchAuthorityCodeException if the URI syntax is invalid.
*/
private URI_Parser getParser(String code) throws NoSuchAuthorityCodeException {
/*
* Take a local copy of the field in order to protect against changes.
* This avoid the need for synchronization (URI_Parsers are immutable,
* so it doesn't matter if the 'last' reference is changed concurrently).
*/
URI_Parser parser = last;
if (parser == null || !parser.uri.equals(code)) {
last = parser = buildParser(code);
}
return parser;
}
/**
* Returns an object factory for the specified code. This method invokes one of the
* <code>get</code><var>Type</var><code>AuthorityFactory</code> methods where
* <var>Type</var> is inferred from the code.
*
* @param code The authority code given to this class.
* @return A factory for the specified authority code (never {@code null}).
* @throws FactoryException if no suitable factory were found.
*/
@Override
protected AuthorityFactory getAuthorityFactory(final String code) throws FactoryException {
if (code != null) {
return getAuthorityFactory(getParser(code).type.type.asSubclass(AuthorityFactory.class), code);
} else {
return super.getAuthorityFactory(code);
}
}
/**
* Returns the datum factory to use for the specified URI. If the URI contains a version
* string, then this method will try to fetch a factory for that particular version. The
* {@link #createVersionedFactory} method may be invoked for that purpose. If no factory
* is provided for that specific version, then the
* {@linkplain AuthorityFactoryAdapter#getDatumAuthorityFactory default one} is used.
*
* @param code The URI given to this class.
* @return A factory for the specified URI (never {@code null}).
* @throws FactoryException if no datum factory is available.
*/
@Override
protected DatumAuthorityFactory getDatumAuthorityFactory(final String code)
throws FactoryException
{
if (code != null) {
final URI_Parser parser = getParser(code);
parser.logWarningIfTypeMismatch(this, DatumAuthorityFactory.class);
final AuthorityFactory factory = getVersionedFactory(parser);
if (factory instanceof DatumAuthorityFactory) {
return (DatumAuthorityFactory) factory;
}
}
return super.getDatumAuthorityFactory(code);
}
/**
* Returns the coordinate system factory to use for the specified URI. If the URI contains a
* version string, then this method will try to fetch a factory for that particular version.
* The {@link #createVersionedFactory} method may be invoked for that purpose. If no factory
* is provided for that specific version, then the
* {@linkplain AuthorityFactoryAdapter#getCSAuthorityFactory default one} is used.
*
* @param code The URI given to this class.
* @return A factory for the specified URI (never {@code null}).
* @throws FactoryException if no coordinate system factory is available.
*/
@Override
protected CSAuthorityFactory getCSAuthorityFactory(final String code)
throws FactoryException
{
if (code != null) {
final URI_Parser parser = getParser(code);
parser.logWarningIfTypeMismatch(this, CSAuthorityFactory.class);
final AuthorityFactory factory = getVersionedFactory(parser);
if (factory instanceof CSAuthorityFactory) {
return (CSAuthorityFactory) factory;
}
}
return super.getCSAuthorityFactory(code);
}
/**
* Returns the coordinate reference system factory to use for the specified URI.
* If the URI contains a version string, then this method will try to fetch a factory
* for that particular version. The {@link #createVersionedFactory} method may be
* invoked for that purpose. If no factory is provided for that specific version, then
* the {@linkplain AuthorityFactoryAdapter#getCRSAuthorityFactory default one} is used.
*
* @param code The URI given to this class.
* @return A factory for the specified URI (never {@code null}).
* @throws FactoryException if no coordinate reference system factory is available.
*/
@Override
protected CRSAuthorityFactory getCRSAuthorityFactory(final String code)
throws FactoryException
{
if (code != null) {
final URI_Parser parser = getParser(code);
parser.logWarningIfTypeMismatch(this, CRSAuthorityFactory.class);
final AuthorityFactory factory = getVersionedFactory(parser);
if (factory instanceof CRSAuthorityFactory) {
return (CRSAuthorityFactory) factory;
}
}
return super.getCRSAuthorityFactory(code);
}
/**
* Returns the coordinate operation factory to use for the specified URI. If the URI
* contains a version string, then this method will try to fetch a factory for that
* particular version. The {@link #createVersionedFactory} method may be invoked for
* that purpose. If no factory is provided for that specific version, then the
* {@linkplain AuthorityFactoryAdapter#getCoordinateOperationAuthorityFactory default one}
* is used.
*
* @param code The URI given to this class.
* @return A factory for the specified URI (never {@code null}).
* @throws FactoryException if no coordinate operation factory is available.
*/
@Override
protected CoordinateOperationAuthorityFactory getCoordinateOperationAuthorityFactory(final String code)
throws FactoryException
{
if (code != null) {
final URI_Parser parser = getParser(code);
parser.logWarningIfTypeMismatch(this, CoordinateOperationAuthorityFactory.class);
final AuthorityFactory factory = getVersionedFactory(parser);
if (factory instanceof CoordinateOperationAuthorityFactory) {
return (CoordinateOperationAuthorityFactory) factory;
}
}
return super.getCoordinateOperationAuthorityFactory(code);
}
/**
* Returns an authority factory for the specified version, or {@code null} if none.
* This method invokes {@link #createVersionedFactory} the first time it is invoked
* for a given version and cache the factory.
*
* @throws FactoryException if an error occurred while creating the factory.
*/
private AuthorityFactory getVersionedFactory(final URI_Parser parser)
throws FactoryException
{
final Version version = parser.version;
if (version == null) {
return null;
}
AuthorityFactory factory;
synchronized (byVersions) {
factory = byVersions.get(version);
if (factory == null) {
factory = createVersionedFactory(version);
if (factory != null) {
byVersions.put(version, factory);
}
}
}
return factory;
}
/**
* Invoked when a factory is requested for a specific version. This method should create
* a factory for the exact version specified by the argument, or return {@code null} if
* no such factory is available. In the later case, this class will fallback on the factory
* specified at {@linkplain #URI_AuthorityFactory(AuthorityFactory, String, Citation)
* construction time}.
*
* @param version The version for the factory to create.
* @return The factory, of {@code null} if there is none for the specified version.
* @throws FactoryException if an error occurred while creating the factory.
*/
protected AuthorityFactory createVersionedFactory(final Version version)
throws FactoryException
{
final Hints hints = new Hints(factory.getImplementationHints());
hints.put(Hints.VERSION, version);
final List<AuthorityFactory> factories = Arrays.asList(new AuthorityFactory[] {
new AllAuthoritiesFactory(hints),
factory
});
return FallbackAuthorityFactory.create(factories);
}
/**
* Returns a simple authority code (like "EPSG:4236") that can be passed to the wrapped factories.
*
* @param code The code given to this factory.
* @return The code to give to the underlying factories.
* @throws FactoryException if the code can't be converted.
*/
@Override
protected String toBackingFactoryCode(final String code) throws FactoryException {
return getParser(code).getAuthorityCode();
}
}