Package org.geotools.referencing.factory
Class FallbackAuthorityFactory
- Object
-
- AbstractFactory
-
- ReferencingFactory
-
- AbstractAuthorityFactory
-
- AuthorityFactoryAdapter
-
- FallbackAuthorityFactory
-
- All Implemented Interfaces:
AuthorityFactory,Factory,Factory,OptionalFactory,RegistrableFactory
public class FallbackAuthorityFactory extends AuthorityFactoryAdapter
A factory which delegates all object creation to a primary factory, and fallback on an other one if the primary factory failed.- Since:
- 2.3
- Author:
- Martin Desruisseaux
-
-
Field Summary
-
Fields inherited from class ReferencingFactory
LOGGER
-
Fields inherited from class AbstractFactory
hints, MAXIMUM_PRIORITY, MINIMUM_PRIORITY, NORMAL_PRIORITY, priority
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedFallbackAuthorityFactory(AuthorityFactory primary, AuthorityFactory fallback)Wraps a primary and a fallback authority factories.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static <T extends AuthorityFactory>
Tcreate(Class<T> type, Collection<T> factories)Wraps the specified authority factories.static AuthorityFactorycreate(Collection<? extends AuthorityFactory> factories)Wraps the specified authority factories.CartesianCScreateCartesianCS(String code)Creates a cartesian coordinate system from a code.CompoundCRScreateCompoundCRS(String code)Creates a 3D coordinate reference system from a code.CoordinateOperationcreateCoordinateOperation(String code)Creates an operation from a single operation code.CoordinateReferenceSystemcreateCoordinateReferenceSystem(String code)Returns an arbitrary coordinate reference system from a code.CoordinateSystemcreateCoordinateSystem(String code)Returns an arbitrary coordinate system from a code.CoordinateSystemAxiscreateCoordinateSystemAxis(String code)Returns a coordinate system axis from a code.CylindricalCScreateCylindricalCS(String code)Creates a cylindrical coordinate system from a code.DatumcreateDatum(String code)Returns an arbitrary datum from a code.DerivedCRScreateDerivedCRS(String code)Creates a derived coordinate reference system from a code.EllipsoidcreateEllipsoid(String code)Returns an ellipsoid from a code.EllipsoidalCScreateEllipsoidalCS(String code)Creates an ellipsoidal coordinate system from a code.EngineeringCRScreateEngineeringCRS(String code)Creates a engineering coordinate reference system from a code.EngineeringDatumcreateEngineeringDatum(String code)Creates a engineering datum from a code.ExtentcreateExtent(String code)Returns a extent (usually an area of validity) from a code.Set<CoordinateOperation>createFromCoordinateReferenceSystemCodes(String sourceCRS, String targetCRS)Creates an operation from coordinate reference system codes.GeocentricCRScreateGeocentricCRS(String code)Returns a geocentric coordinate reference system from a code.GeodeticDatumcreateGeodeticDatum(String code)Returns a geodetic datum from a code.GeographicCRScreateGeographicCRS(String code)Returns a geographic coordinate reference system from a code.ImageCRScreateImageCRS(String code)Creates a image coordinate reference system from a code.ImageDatumcreateImageDatum(String code)Creates a image datum from a code.IdentifiedObjectcreateObject(String code)Returns an arbitrary object from a code.OperationMethodcreateOperationMethod(String code)Creates an operation method from a code.ParameterDescriptorcreateParameterDescriptor(String code)Creates a parameter descriptor from a code.PolarCScreatePolarCS(String code)Creates a polar coordinate system from a code.PrimeMeridiancreatePrimeMeridian(String code)Returns a prime meridian from a code.ProjectedCRScreateProjectedCRS(String code)Returns a projected coordinate reference system from a code.SphericalCScreateSphericalCS(String code)Creates a spherical coordinate system from a code.TemporalCRScreateTemporalCRS(String code)Creates a temporal coordinate reference system from a code.TemporalDatumcreateTemporalDatum(String code)Creates a temporal datum from a code.TimeCScreateTimeCS(String code)Creates a temporal coordinate system from a code.Unit<?>createUnit(String code)Returns an unit from a code.VerticalCRScreateVerticalCRS(String code)Creates a vertical coordinate reference system from a code.VerticalCScreateVerticalCS(String code)Creates a vertical coordinate system from a code.VerticalDatumcreateVerticalDatum(String code)Creates a vertical datum from a code.Set<String>getAuthorityCodes(Class<? extends IdentifiedObject> type)Returns the set of authority codes for the specified type.InternationalStringgetDescriptionText(String code)Returns a description for the object identified by the specified code.IdentifiedObjectFindergetIdentifiedObjectFinder(Class<? extends IdentifiedObject> type)Returns a finder which can be used for looking up unidentified objects.protected voidnotifySuccess(String method, String code, CRSAuthorityFactory factory, CoordinateReferenceSystem crs)Log a message when a CRS is found.-
Methods inherited from class AuthorityFactoryAdapter
dispose, getAuthority, getAuthorityFactory, getBackingStoreDescription, getCoordinateOperationAuthorityFactory, getCRSAuthorityFactory, getCSAuthorityFactory, getDatumAuthorityFactory, getVendor, isAvailable, toBackingFactoryCode
-
Methods inherited from class AbstractAuthorityFactory
noSuchAuthorityCode, trimAuthority
-
Methods inherited from class ReferencingFactory
ensureNonNull
-
Methods inherited from class AbstractFactory
addImplementationHints, equals, getImplementationHints, getPriority, hashCode, onDeregistration, onRegistration, toString
-
Methods inherited from interface Factory
getImplementationHints
-
-
-
-
Constructor Detail
-
FallbackAuthorityFactory
protected FallbackAuthorityFactory(AuthorityFactory primary, AuthorityFactory fallback)
Wraps a primary and a fallback authority factories.This constructor is protected because subclasses must declare which of the
DatumAuthorityFactory,CSAuthorityFactory,CRSAuthorityFactoryandCoordinateOperationAuthorityFactoryinterfaces they choose to implement.- Parameters:
primary- The primary factory.fallback- The factory to use as a fallback if the primary factory failed.- See Also:
create(java.lang.Class<T>, java.util.Collection<T>)
-
-
Method Detail
-
create
public static <T extends AuthorityFactory> T create(Class<T> type, Collection<T> factories) throws FactoryNotFoundException, ClassCastException
Wraps the specified authority factories. If the specified collection contains more than one element, then a chain ofFallbackAuthorityFactoryinstances is created.- Type Parameters:
T- The interface to implement.- Parameters:
type- The interface to implement. Should be one ofDatumAuthorityFactory,CSAuthorityFactory,CRSAuthorityFactoryorCoordinateOperationAuthorityFactory.factories- The factories to wrap, in iteration order.- Returns:
- The given factories as a chain of fallback factories.
- Throws:
FactoryNotFoundException- if the collection doesn't contains at least one element.ClassCastException- iftypeis illegal.
-
create
public static AuthorityFactory create(Collection<? extends AuthorityFactory> factories) throws FactoryNotFoundException
Wraps the specified authority factories. If the specified collection contains more than one element, then a chain ofFallbackAuthorityFactoryinstances is created. The type is inferred from the factories found in the collection.Consider using
create(type, factories)instead when the type is known at compile time.- Parameters:
factories- The factories to wrap, in iteration order.- Returns:
- The given factories as a chain of fallback factories.
- Throws:
FactoryNotFoundException- if the collection doesn't contains at least one element.- Since:
- 2.4
-
getAuthorityCodes
public Set<String> getAuthorityCodes(Class<? extends IdentifiedObject> type) throws FactoryException
Returns the set of authority codes for the specified type. The default implementation returns the union of the authority codes from the primary and the fallback factories.- Specified by:
getAuthorityCodesin interfaceAuthorityFactory- Overrides:
getAuthorityCodesin classAuthorityFactoryAdapter- Parameters:
type- The spatial reference objects type.- Returns:
- The set of authority codes for spatial reference objects of the given type. If this factory doesn't contains any object of the given type, then this method returns an empty set.
- Throws:
FactoryException- if access to the underlying database failed.
-
getDescriptionText
public InternationalString getDescriptionText(String code) throws FactoryException
Returns a description for the object identified by the specified code.- Specified by:
getDescriptionTextin interfaceAuthorityFactory- Overrides:
getDescriptionTextin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- A description of the object, or
nullif the object corresponding to the specifiedcodehas no description. - Throws:
NoSuchAuthorityCodeException- if the specifiedcodewas not found.FactoryException- if the query failed for some other reason.
-
createObject
public IdentifiedObject createObject(String code) throws FactoryException
Returns an arbitrary object from a code.- Specified by:
createObjectin interfaceAuthorityFactory- Overrides:
createObjectin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The object for the given code.
- Throws:
FactoryException- if the object creation failed.- See Also:
AuthorityFactoryAdapter.createCoordinateReferenceSystem(java.lang.String),AuthorityFactoryAdapter.createDatum(java.lang.String),AuthorityFactoryAdapter.createEllipsoid(java.lang.String),AuthorityFactoryAdapter.createUnit(java.lang.String)
-
createDatum
public Datum createDatum(String code) throws FactoryException
Returns an arbitrary datum from a code.- Overrides:
createDatumin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The datum for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.- See Also:
AuthorityFactoryAdapter.createGeodeticDatum(java.lang.String),AuthorityFactoryAdapter.createVerticalDatum(java.lang.String),AuthorityFactoryAdapter.createTemporalDatum(java.lang.String)
-
createEngineeringDatum
public EngineeringDatum createEngineeringDatum(String code) throws FactoryException
Creates a engineering datum from a code.- Overrides:
createEngineeringDatumin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The datum for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.- See Also:
AuthorityFactoryAdapter.createEngineeringCRS(java.lang.String)
-
createImageDatum
public ImageDatum createImageDatum(String code) throws FactoryException
Creates a image datum from a code.- Overrides:
createImageDatumin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The datum for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.- See Also:
AuthorityFactoryAdapter.createImageCRS(java.lang.String)
-
createVerticalDatum
public VerticalDatum createVerticalDatum(String code) throws FactoryException
Creates a vertical datum from a code.- Overrides:
createVerticalDatumin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The datum for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.- See Also:
AuthorityFactoryAdapter.createVerticalCRS(java.lang.String)
-
createTemporalDatum
public TemporalDatum createTemporalDatum(String code) throws FactoryException
Creates a temporal datum from a code.- Overrides:
createTemporalDatumin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The datum for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.- See Also:
AuthorityFactoryAdapter.createTemporalCRS(java.lang.String)
-
createGeodeticDatum
public GeodeticDatum createGeodeticDatum(String code) throws FactoryException
Returns a geodetic datum from a code.- Overrides:
createGeodeticDatumin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The datum for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.- See Also:
AuthorityFactoryAdapter.createEllipsoid(java.lang.String),AuthorityFactoryAdapter.createPrimeMeridian(java.lang.String),AuthorityFactoryAdapter.createGeographicCRS(java.lang.String),AuthorityFactoryAdapter.createProjectedCRS(java.lang.String)
-
createEllipsoid
public Ellipsoid createEllipsoid(String code) throws FactoryException
Returns an ellipsoid from a code.- Overrides:
createEllipsoidin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The ellipsoid for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.- See Also:
AuthorityFactoryAdapter.createGeodeticDatum(java.lang.String)
-
createPrimeMeridian
public PrimeMeridian createPrimeMeridian(String code) throws FactoryException
Returns a prime meridian from a code.- Overrides:
createPrimeMeridianin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The prime meridian for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.- See Also:
AuthorityFactoryAdapter.createGeodeticDatum(java.lang.String)
-
createExtent
public Extent createExtent(String code) throws FactoryException
Returns a extent (usually an area of validity) from a code.- Overrides:
createExtentin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The extent for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createCoordinateSystem
public CoordinateSystem createCoordinateSystem(String code) throws FactoryException
Returns an arbitrary coordinate system from a code.- Overrides:
createCoordinateSystemin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createCartesianCS
public CartesianCS createCartesianCS(String code) throws FactoryException
Creates a cartesian coordinate system from a code.- Overrides:
createCartesianCSin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createPolarCS
public PolarCS createPolarCS(String code) throws FactoryException
Creates a polar coordinate system from a code.- Overrides:
createPolarCSin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createCylindricalCS
public CylindricalCS createCylindricalCS(String code) throws FactoryException
Creates a cylindrical coordinate system from a code.- Overrides:
createCylindricalCSin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createSphericalCS
public SphericalCS createSphericalCS(String code) throws FactoryException
Creates a spherical coordinate system from a code.- Overrides:
createSphericalCSin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createEllipsoidalCS
public EllipsoidalCS createEllipsoidalCS(String code) throws FactoryException
Creates an ellipsoidal coordinate system from a code.- Overrides:
createEllipsoidalCSin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createVerticalCS
public VerticalCS createVerticalCS(String code) throws FactoryException
Creates a vertical coordinate system from a code.- Overrides:
createVerticalCSin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createTimeCS
public TimeCS createTimeCS(String code) throws FactoryException
Creates a temporal coordinate system from a code.- Overrides:
createTimeCSin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createCoordinateSystemAxis
public CoordinateSystemAxis createCoordinateSystemAxis(String code) throws FactoryException
Returns a coordinate system axis from a code.- Overrides:
createCoordinateSystemAxisin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The axis for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createUnit
public Unit<?> createUnit(String code) throws FactoryException
Returns an unit from a code.- Overrides:
createUnitin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The unit for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createCoordinateReferenceSystem
public CoordinateReferenceSystem createCoordinateReferenceSystem(String code) throws FactoryException
Returns an arbitrary coordinate reference system from a code.- Overrides:
createCoordinateReferenceSystemin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate reference system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.- See Also:
AuthorityFactoryAdapter.createGeographicCRS(java.lang.String),AuthorityFactoryAdapter.createProjectedCRS(java.lang.String),AuthorityFactoryAdapter.createVerticalCRS(java.lang.String),AuthorityFactoryAdapter.createTemporalCRS(java.lang.String),AuthorityFactoryAdapter.createCompoundCRS(java.lang.String)
-
createCompoundCRS
public CompoundCRS createCompoundCRS(String code) throws FactoryException
Creates a 3D coordinate reference system from a code.- Overrides:
createCompoundCRSin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate reference system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createDerivedCRS
public DerivedCRS createDerivedCRS(String code) throws FactoryException
Creates a derived coordinate reference system from a code.- Overrides:
createDerivedCRSin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate reference system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createEngineeringCRS
public EngineeringCRS createEngineeringCRS(String code) throws FactoryException
Creates a engineering coordinate reference system from a code.- Overrides:
createEngineeringCRSin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate reference system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createGeographicCRS
public GeographicCRS createGeographicCRS(String code) throws FactoryException
Returns a geographic coordinate reference system from a code.- Overrides:
createGeographicCRSin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate reference system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.- See Also:
AbstractAuthorityFactory.createGeodeticDatum(java.lang.String)
-
createGeocentricCRS
public GeocentricCRS createGeocentricCRS(String code) throws FactoryException
Returns a geocentric coordinate reference system from a code.- Overrides:
createGeocentricCRSin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate reference system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.- See Also:
AbstractAuthorityFactory.createGeodeticDatum(java.lang.String)
-
createImageCRS
public ImageCRS createImageCRS(String code) throws FactoryException
Creates a image coordinate reference system from a code.- Overrides:
createImageCRSin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate reference system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createProjectedCRS
public ProjectedCRS createProjectedCRS(String code) throws FactoryException
Returns a projected coordinate reference system from a code.- Overrides:
createProjectedCRSin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate reference system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.- See Also:
AbstractAuthorityFactory.createGeodeticDatum(java.lang.String)
-
createTemporalCRS
public TemporalCRS createTemporalCRS(String code) throws FactoryException
Creates a temporal coordinate reference system from a code.- Overrides:
createTemporalCRSin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate reference system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.- See Also:
AbstractAuthorityFactory.createTemporalDatum(java.lang.String)
-
createVerticalCRS
public VerticalCRS createVerticalCRS(String code) throws FactoryException
Creates a vertical coordinate reference system from a code.- Overrides:
createVerticalCRSin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate reference system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.- See Also:
AbstractAuthorityFactory.createVerticalDatum(java.lang.String)
-
createParameterDescriptor
public ParameterDescriptor createParameterDescriptor(String code) throws FactoryException
Creates a parameter descriptor from a code.- Overrides:
createParameterDescriptorin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The coordinate reference system for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createOperationMethod
public OperationMethod createOperationMethod(String code) throws FactoryException
Creates an operation method from a code.- Overrides:
createOperationMethodin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The operation method for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createCoordinateOperation
public CoordinateOperation createCoordinateOperation(String code) throws FactoryException
Creates an operation from a single operation code.- Overrides:
createCoordinateOperationin classAuthorityFactoryAdapter- Parameters:
code- Value allocated by authority.- Returns:
- The operation for the given code.
- Throws:
FactoryException- if the object creation failed for all factories.
-
createFromCoordinateReferenceSystemCodes
public Set<CoordinateOperation> createFromCoordinateReferenceSystemCodes(String sourceCRS, String targetCRS) throws FactoryException
Creates an operation from coordinate reference system codes.- Overrides:
createFromCoordinateReferenceSystemCodesin classAuthorityFactoryAdapter- Parameters:
sourceCRS- Coded value of source coordinate reference system.targetCRS- Coded value of target coordinate reference system.- Returns:
- The operations from
sourceCRStotargetCRS. - Throws:
FactoryException- if the object creation failed for all factories.
-
getIdentifiedObjectFinder
public IdentifiedObjectFinder getIdentifiedObjectFinder(Class<? extends IdentifiedObject> type) throws FactoryException
Returns a finder which can be used for looking up unidentified objects. The default implementation delegates the lookups to the primary factory, and fallback on the second one if the primary factory can't find a match.- Overrides:
getIdentifiedObjectFinderin classAuthorityFactoryAdapter- Parameters:
type- The type of objects to look for. Should be a GeoAPI interface likeGeographicCRS.class, but this method accepts also implementation class. If the type is unknown, useIdentifiedObject.class. A more accurate type may help to speed up the search, since it reduces the amount of tables to scan in some implementations like the factories backed by EPSG database.- Returns:
- A finder to use for looking up unidentified objects.
- Throws:
FactoryException- if the object creation failed.- Since:
- 2.4
-
notifySuccess
protected void notifySuccess(String method, String code, CRSAuthorityFactory factory, CoordinateReferenceSystem crs)
Description copied from class:AuthorityFactoryAdapterLog a message when a CRS is found. Child objects that doesn't create their own CRS-objects should not report.- Overrides:
notifySuccessin classAuthorityFactoryAdapter
-
-