org.apache.sis.referencing.factory

Class ConcurrentAuthorityFactory<DAO extends GeodeticAuthorityFactory>

Object

AbstractFactory

GeodeticAuthorityFactory

ConcurrentAuthorityFactory<DAO>

Type Parameters:

DAO - the type of factory used as Data Access Object (DAO).

All Implemented Interfaces:

AutoCloseable, AuthorityFactory, Factory

Direct Known Subclasses:

EPSGFactory

public abstract class ConcurrentAuthorityFactory<DAO extends GeodeticAuthorityFactory>
extends GeodeticAuthorityFactory
implements AutoCloseable

A concurrent authority factory that caches all objects created by another factory. All create­Foo(String) methods first check if a previously created object exists for the given code. If such object exists, it is returned. Otherwise, the object creation is delegated to another factory given by new­Data­Access() and the result is cached in this factory.

Concurrent­Authority­Factory delays the call to new­Data­Access() until first needed, and closes the factory used as a Data Access Object (DAO) after some timeout. This approach allows to establish a connection to a database (for example) and keep it only for a relatively short amount of time.

Caching strategy

Objects are cached by strong references, up to the amount of objects specified at construction time. If a greater amount of objects are cached, then the oldest ones will be retained through a weak reference instead of a strong one. This means that this caching factory will continue to return those objects as long as they are in use somewhere else in the Java virtual machine, but will be discarded (and recreated on the fly if needed) otherwise.

Multi-threading

The cache managed by this class is concurrent. However the Data Access Objects (DAO) are assumed non-concurrent. If two or more threads are accessing this factory in same time, then two or more Data Access Object instances may be created. The maximal amount of instances to create is specified at Concurrent­Authority­Factory construction time. If more Data Access Object instances are needed, some of the threads will block until an instance become available.

Note for subclasses

This abstract class does not implement any of the Datum­Authority­Factory, CSAuthority­Factory, CRSAuthority­Factory and Coordinate­Operation­Authority­Factory interfaces. Subclasses should select the interfaces that they choose to implement.

Since:

0.7

Defined in the sis-referencing module

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConcurrentAuthorityFactory(Class<DAO> dataAccessClass) Constructs an instance with a default number of threads and a default number of entries to keep by strong references.
protected	ConcurrentAuthorityFactory(Class<DAO> dataAccessClass, int maxStrongReferences, int maxConcurrentQueries) Constructs an instance with the specified number of entries to keep by strong references.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	canClose(DAO factory) Returns true if the given Data Access Object (DAO) can be closed.
void	close() Immediately closes all Data Access Objects that are closeable.
CartesianCS	createCartesianCS(String code) Returns a 2- or 3-dimensional Cartesian coordinate system made of straight orthogonal axes.
CompoundCRS	createCompoundCRS(String code) Returns a CRS describing the position of points through two or more independent coordinate reference systems.
CoordinateOperation	createCoordinateOperation(String code) Returns an operation for transforming coordinates in the source CRS to coordinates in the target CRS.
CoordinateReferenceSystem	createCoordinateReferenceSystem(String code) Returns an arbitrary coordinate reference system from a code.
CoordinateSystem	createCoordinateSystem(String code) Returns an arbitrary coordinate system from a code.
CoordinateSystemAxis	createCoordinateSystemAxis(String code) Returns a coordinate system axis with name, direction, unit and range of values.
CylindricalCS	createCylindricalCS(String code) Returns a 3-dimensional coordinate system made of a polar coordinate system extended by a straight perpendicular axis.
Datum	createDatum(String code) Returns an arbitrary datum from a code.
DerivedCRS	createDerivedCRS(String code) Returns a CRS that is defined by its coordinate conversion from another CRS (not by a datum).
Ellipsoid	createEllipsoid(String code) Returns a geometric figure that can be used to describe the approximate shape of the earth.
EllipsoidalCS	createEllipsoidalCS(String code) Returns a 2- or 3-dimensional coordinate system for geodetic latitude and longitude, sometime with ellipsoidal height.
EngineeringCRS	createEngineeringCRS(String code) Returns a 1-, 2- or 3-dimensional contextually local coordinate reference system.
EngineeringDatum	createEngineeringDatum(String code) Returns a datum defining the origin of an engineering coordinate reference system.
Extent	createExtent(String code) Returns information about spatial, vertical, and temporal extent (usually a domain of validity) from a code.
Set<CoordinateOperation>	createFromCoordinateReferenceSystemCodes(String sourceCRS, String targetCRS) Returns operations from source and target coordinate reference system codes.
GeocentricCRS	createGeocentricCRS(String code) Returns a 3-dimensional coordinate reference system with the origin at the approximate centre of mass of the earth.
GeodeticDatum	createGeodeticDatum(String code) Returns a datum defining the location and orientation of an ellipsoid that approximates the shape of the earth.
GeographicCRS	createGeographicCRS(String code) Returns a 2- or 3-dimensional coordinate reference system based on an ellipsoidal approximation of the geoid.
ImageCRS	createImageCRS(String code) Returns a 2-dimensional engineering coordinate reference system applied to locations in images.
ImageDatum	createImageDatum(String code) Returns a datum defining the origin of an image coordinate reference system.
IdentifiedObject	createObject(String code) Returns an arbitrary object from a code.
OperationMethod	createOperationMethod(String code) Returns a description of the algorithm and parameters used to perform a coordinate operation.
ParameterDescriptor<?>	createParameterDescriptor(String code) Returns a definition of a single parameter used by an operation method.
PolarCS	createPolarCS(String code) Returns a 2-dimensional coordinate system for coordinates represented by a distance from the origin and an angle from a fixed direction.
PrimeMeridian	createPrimeMeridian(String code) Returns a prime meridian defining the origin from which longitude values are determined.
ProjectedCRS	createProjectedCRS(String code) Returns a 2-dimensional coordinate reference system used to approximate the shape of the earth on a planar surface.
SphericalCS	createSphericalCS(String code) Returns a 3-dimensional coordinate system with one distance measured from the origin and two angular coordinates.
TemporalCRS	createTemporalCRS(String code) Returns a 1-dimensional coordinate reference system used for the recording of time.
TemporalDatum	createTemporalDatum(String code) Returns a datum defining the origin of a temporal coordinate reference system.
TimeCS	createTimeCS(String code) Returns a 1-dimensional coordinate system for heights or depths of points.
Unit<?>	createUnit(String code) Returns an unit of measurement from a code.
VerticalCRS	createVerticalCRS(String code) Returns a 1-dimensional coordinate reference system used for recording heights or depths.
VerticalCS	createVerticalCS(String code) Returns a 1-dimensional coordinate system for heights or depths of points.
VerticalDatum	createVerticalDatum(String code) Returns a datum identifying a particular reference level surface used as a zero-height surface.
Citation	getAuthority() Returns the database or specification that defines the codes recognized by this factory.
Set<String>	getAuthorityCodes(Class<? extends IdentifiedObject> type) Returns the set of authority codes for objects of the given type.
InternationalString	getDescriptionText(String code) Gets a description of the object corresponding to a code.
long	getTimeout(TimeUnit unit) Returns the amount of time that Concurrent­Authority­Factory will wait before to close a Data Access Object.
protected boolean	isCacheable(String code, Object object) Returns whether the given object can be cached.
protected abstract DAO	newDataAccess() Creates a factory which will perform the actual geodetic object creation work.
IdentifiedObjectFinder	newIdentifiedObjectFinder() Returns a finder which can be used for looking up unidentified objects.
protected String	normalizeCode(String code) Returns a code equivalent to the given code but with unnecessary elements eliminated.
void	printCacheContent(PrintWriter out) Prints the cache content to the given writer.
void	setTimeout(long delay, TimeUnit unit) Sets a timer for closing the Data Access Object after the specified amount of time of inactivity.
String	toString() Returns a string representation of this factory for debugging purpose only.

Methods inherited from class GeodeticAuthorityFactory

create­Parametric­CRS, create­Parametric­CS, create­Parametric­Datum, get­Code­Spaces, trim­Namespace

Methods inherited from class AbstractFactory

get­Vendor

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, wait, wait, wait

Methods inherited from interface Factory

get­Vendor

Constructor Detail

ConcurrentAuthorityFactory

protected ConcurrentAuthorityFactory(Class<DAO> dataAccessClass)

Constructs an instance with a default number of threads and a default number of entries to keep by strong references. Note that those default values may change in any future SIS versions based on experience gained.

Parameters:

data­Access­Class - The class of Data Access Object (DAO) created by new­Data­Access().

ConcurrentAuthorityFactory

protected ConcurrentAuthorityFactory(Class<DAO> dataAccessClass,
                          int maxStrongReferences,
                          int maxConcurrentQueries)

Constructs an instance with the specified number of entries to keep by strong references. If a number of object greater than max­Strong­References are created, then the strong references for the eldest objects will be replaced by weak references.

Parameters:

data­Access­Class - the class of Data Access Object (DAO) created by new­Data­Access().

max­Strong­References - the maximum number of objects to keep by strong reference.

max­Concurrent­Queries - the maximal amount of Data Access Objects to use concurrently. If more than this amount of threads are querying this Concurrent­Authority­Factory concurrently, additional threads will be blocked until a Data Access Object become available.

Method Detail

newDataAccess

protected abstract DAO newDataAccess()
                                                               throws UnavailableFactoryException,
                                                                      FactoryException

Creates a factory which will perform the actual geodetic object creation work. This method is invoked the first time a create­Foo(String) method is invoked. It may also be invoked again if additional factories are needed in different threads, or if all factories have been closed after the timeout.

Multi-threading

This method (but not necessarily the returned factory) needs to be thread-safe; Concurrent­Authority­Factory does not hold any lock when invoking this method. Subclasses are responsible to apply their own synchronization if needed, but are encouraged to avoid doing so if possible. In addition, implementations should not invoke other Concurrent­Authority­Factory methods during this method execution in order to avoid never-ending loop.

Returns:

Data Access Object (DAO) to use in create­Foo(String) methods.

Throws:

Unavailable­Factory­Exception - if the Data Access Object is unavailable because an optional resource is missing.

Factory­Exception - if the creation of Data Access Object failed for another reason.

canClose

protected boolean canClose(DAO factory)

Returns true if the given Data Access Object (DAO) can be closed. This method is invoked automatically after the timeout if the given DAO has been idle during all that time. Subclasses can override this method and return false if they want to prevent the DAO disposal under some circumstances.

The default implementation always returns true.

Parameters:

factory - the Data Access Object which is about to be closed.

Returns:

true if the given Data Access Object can be closed.

See Also:

close()

getTimeout

public long getTimeout(TimeUnit unit)

Returns the amount of time that Concurrent­Authority­Factory will wait before to close a Data Access Object. This delay is measured from the last time the Data Access Object has been used by a create­Foo(String) method.

Parameters:

unit - the desired unit of measurement for the timeout.

Returns:

the current timeout in the given unit of measurement.

setTimeout

public void setTimeout(long delay,
              TimeUnit unit)

Sets a timer for closing the Data Access Object after the specified amount of time of inactivity. If a new Data Access Object is needed after the disposal of the last one, then the new­Data­Access() method will be invoked again.

Parameters:

delay - the delay of inactivity before to close a Data Access Object.

unit - the unit of measurement of the given delay.

getAuthority

public Citation getAuthority()

Returns the database or specification that defines the codes recognized by this factory. The default implementation performs the following steps:

• Returns the cached value if it exists.
• Otherwise:
  1. get an instance of the Data Access Object,
  2. delegate to its Geodetic­Authority­Factory.get­Authority() method,
  3. release the Data Access Object,
  4. cache the result.

If this method can not get a Data Access Object (for example because no database connection is available), then this method returns null.

Specified by:

get­Authority in interface Authority­Factory

Specified by:

get­Authority in class Geodetic­Authority­Factory

Returns:

the organization responsible for definition of the database, or null if unavailable.

See Also:

Abstract­Factory.get­Vendor()

getAuthorityCodes

public Set<String> getAuthorityCodes(Class<? extends IdentifiedObject> type)
                              throws FactoryException

Returns the set of authority codes for objects of the given type. The default implementation performs the following steps:

1. get an instance of the Data Access Object,
2. delegate to its Authority­Factory.get­Authority­Codes(Class) method,
3. release the Data Access Object.

Specified by:

get­Authority­Codes in interface Authority­Factory

Parameters:

type - the spatial reference objects type (e.g. Projected­CRS.class).

Returns:

the set of authority codes for spatial reference objects of the given type. If this factory does not contains any object of the given type, then this method returns an empty set.

Throws:

Factory­Exception - if access to the underlying database failed.

getDescriptionText

public InternationalString getDescriptionText(String code)
                                       throws NoSuchAuthorityCodeException,
                                              FactoryException

Gets a description of the object corresponding to a code. The default implementation performs the following steps:

1. get an instance of the Data Access Object,
2. delegate to its Geodetic­Authority­Factory.get­Description­Text(String) method,
3. release the Data Access Object.

Specified by:

get­Description­Text in interface Authority­Factory

Overrides:

get­Description­Text in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

a description of the object, or null if the object corresponding to the specified code has no description.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the query failed for some other reason.

normalizeCode

protected String normalizeCode(String code)
                        throws FactoryException

Returns a code equivalent to the given code but with unnecessary elements eliminated. The normalized code is used as the key in the cache, and is also the code which will be passed to the Data Access Object (DAO).

The default implementation performs the following steps:

1. Removes the namespace if presents. For example if the codespace is EPSG and the given code starts with the "EPSG:" prefix, then that prefix is removed.
2. Removes leading and trailing spaces.

Subclasses can override this method for performing a different normalization work. It is okay to return internal codes completely different than the given codes, provided that the Data Access Objects will understand those internal codes.

Parameters:

code - the code to normalize.

Returns:

the normalized code.

Throws:

Factory­Exception - if an error occurred while normalizing the given code.

createObject

public IdentifiedObject createObject(String code)
                              throws FactoryException

Returns an arbitrary object from a code. The default implementation performs the following steps:

• Returns the cached instance for the given code if such instance already exists.
• Otherwise:
  1. get an instance of the Data Access Object,
  2. delegate to its Geodetic­Authority­Factory.create­Object(String) method,
  3. release the Data Access Object,
  4. cache the result.

Specified by:

create­Object in interface Authority­Factory

Specified by:

create­Object in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the object for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Abstract­Identified­Object

createCoordinateReferenceSystem

public CoordinateReferenceSystem createCoordinateReferenceSystem(String code)
                                                          throws FactoryException

Returns an arbitrary coordinate reference system from a code. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Coordinate­Reference­System(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Coordinate­Reference­System(String) method in the parent class. This allows to check if the more generic create­Object(String) method cached a value before to try that method.

Overrides:

create­Coordinate­Reference­System in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Abstract­CRS, CRS.for­Code(String)

createGeographicCRS

public GeographicCRS createGeographicCRS(String code)
                                  throws FactoryException

Returns a 2- or 3-dimensional coordinate reference system based on an ellipsoidal approximation of the geoid. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Geographic­CRS(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Geographic­CRS(String) method in the parent class. This allows to check if the more generic create­Coordinate­Reference­System(String) method cached a value before to try that method.

Overrides:

create­Geographic­CRS in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Geographic­CRS, Common­CRS.geographic(), Common­CRS.geographic3D()

createGeocentricCRS

public GeocentricCRS createGeocentricCRS(String code)
                                  throws FactoryException

Returns a 3-dimensional coordinate reference system with the origin at the approximate centre of mass of the earth. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Geocentric­CRS(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Geocentric­CRS(String) method in the parent class. This allows to check if the more generic create­Coordinate­Reference­System(String) method cached a value before to try that method.

Overrides:

create­Geocentric­CRS in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Geocentric­CRS, Common­CRS.geocentric()

createProjectedCRS

public ProjectedCRS createProjectedCRS(String code)
                                throws FactoryException

Returns a 2-dimensional coordinate reference system used to approximate the shape of the earth on a planar surface. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Projected­CRS(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Projected­CRS(String) method in the parent class. This allows to check if the more generic create­Coordinate­Reference­System(String) method cached a value before to try that method.

Overrides:

create­Projected­CRS in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Projected­CRS

createVerticalCRS

public VerticalCRS createVerticalCRS(String code)
                              throws FactoryException

Returns a 1-dimensional coordinate reference system used for recording heights or depths. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Vertical­CRS(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Vertical­CRS(String) method in the parent class. This allows to check if the more generic create­Coordinate­Reference­System(String) method cached a value before to try that method.

Overrides:

create­Vertical­CRS in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Vertical­CRS, Common­CRS.Vertical.crs()

createTemporalCRS

public TemporalCRS createTemporalCRS(String code)
                              throws FactoryException

Returns a 1-dimensional coordinate reference system used for the recording of time. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Temporal­CRS(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Temporal­CRS(String) method in the parent class. This allows to check if the more generic create­Coordinate­Reference­System(String) method cached a value before to try that method.

Overrides:

create­Temporal­CRS in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Temporal­CRS, Common­CRS.Temporal.crs()

createCompoundCRS

public CompoundCRS createCompoundCRS(String code)
                              throws FactoryException

Returns a CRS describing the position of points through two or more independent coordinate reference systems. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Compound­CRS(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Compound­CRS(String) method in the parent class. This allows to check if the more generic create­Coordinate­Reference­System(String) method cached a value before to try that method.

Overrides:

create­Compound­CRS in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Compound­CRS

createDerivedCRS

public DerivedCRS createDerivedCRS(String code)
                            throws FactoryException

Returns a CRS that is defined by its coordinate conversion from another CRS (not by a datum). The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Derived­CRS(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Derived­CRS(String) method in the parent class. This allows to check if the more generic create­Coordinate­Reference­System(String) method cached a value before to try that method.

Overrides:

create­Derived­CRS in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Derived­CRS

createEngineeringCRS

public EngineeringCRS createEngineeringCRS(String code)
                                    throws FactoryException

Returns a 1-, 2- or 3-dimensional contextually local coordinate reference system. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Engineering­CRS(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Engineering­CRS(String) method in the parent class. This allows to check if the more generic create­Coordinate­Reference­System(String) method cached a value before to try that method.

Overrides:

create­Engineering­CRS in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Engineering­CRS

createImageCRS

public ImageCRS createImageCRS(String code)
                        throws FactoryException

Returns a 2-dimensional engineering coordinate reference system applied to locations in images. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Image­CRS(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Image­CRS(String) method in the parent class. This allows to check if the more generic create­Coordinate­Reference­System(String) method cached a value before to try that method.

Overrides:

create­Image­CRS in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Image­CRS

createDatum

public Datum createDatum(String code)
                  throws FactoryException

Returns an arbitrary datum from a code. The returned object will typically be an The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Datum(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Datum(String) method in the parent class. This allows to check if the more generic create­Object(String) method cached a value before to try that method.

Overrides:

create­Datum in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the datum for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Abstract­Datum

createGeodeticDatum

public GeodeticDatum createGeodeticDatum(String code)
                                  throws FactoryException

Returns a datum defining the location and orientation of an ellipsoid that approximates the shape of the earth. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Geodetic­Datum(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Geodetic­Datum(String) method in the parent class. This allows to check if the more generic create­Datum(String) method cached a value before to try that method.

Overrides:

create­Geodetic­Datum in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the datum for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Geodetic­Datum, Common­CRS.datum()

createVerticalDatum

public VerticalDatum createVerticalDatum(String code)
                                  throws FactoryException

Returns a datum identifying a particular reference level surface used as a zero-height surface. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Vertical­Datum(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Vertical­Datum(String) method in the parent class. This allows to check if the more generic create­Datum(String) method cached a value before to try that method.

Overrides:

create­Vertical­Datum in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the datum for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Vertical­Datum, Common­CRS.Vertical.datum()

createTemporalDatum

public TemporalDatum createTemporalDatum(String code)
                                  throws FactoryException

Returns a datum defining the origin of a temporal coordinate reference system. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Temporal­Datum(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Temporal­Datum(String) method in the parent class. This allows to check if the more generic create­Datum(String) method cached a value before to try that method.

Overrides:

create­Temporal­Datum in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the datum for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Temporal­Datum, Common­CRS.Temporal.datum()

createEngineeringDatum

public EngineeringDatum createEngineeringDatum(String code)
                                        throws FactoryException

Returns a datum defining the origin of an engineering coordinate reference system. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Engineering­Datum(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Engineering­Datum(String) method in the parent class. This allows to check if the more generic create­Datum(String) method cached a value before to try that method.

Overrides:

create­Engineering­Datum in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the datum for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Engineering­Datum

createImageDatum

public ImageDatum createImageDatum(String code)
                            throws FactoryException

Returns a datum defining the origin of an image coordinate reference system. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Image­Datum(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Image­Datum(String) method in the parent class. This allows to check if the more generic create­Datum(String) method cached a value before to try that method.

Overrides:

create­Image­Datum in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the datum for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Image­Datum

createEllipsoid

public Ellipsoid createEllipsoid(String code)
                          throws FactoryException

Returns a geometric figure that can be used to describe the approximate shape of the earth. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Ellipsoid(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Ellipsoid(String) method in the parent class. This allows to check if the more generic create­Object(String) method cached a value before to try that method.

Overrides:

create­Ellipsoid in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the ellipsoid for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Ellipsoid, Common­CRS.ellipsoid()

createPrimeMeridian

public PrimeMeridian createPrimeMeridian(String code)
                                  throws FactoryException

Returns a prime meridian defining the origin from which longitude values are determined. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Prime­Meridian(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Prime­Meridian(String) method in the parent class. This allows to check if the more generic create­Object(String) method cached a value before to try that method.

Overrides:

create­Prime­Meridian in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the prime meridian for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Prime­Meridian, Common­CRS.prime­Meridian()

createExtent

public Extent createExtent(String code)
                    throws FactoryException

Returns information about spatial, vertical, and temporal extent (usually a domain of validity) from a code. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Extent(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Extent(String) method in the parent class.

Overrides:

create­Extent in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the extent for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Extent

createCoordinateSystem

public CoordinateSystem createCoordinateSystem(String code)
                                        throws FactoryException

Returns an arbitrary coordinate system from a code. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Coordinate­System(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Coordinate­System(String) method in the parent class. This allows to check if the more generic create­Object(String) method cached a value before to try that method.

Overrides:

create­Coordinate­System in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Abstract­CS, Coordinate­Systems.get­Epsg­Code(Unit, Axis­Direction...)

createEllipsoidalCS

public EllipsoidalCS createEllipsoidalCS(String code)
                                  throws FactoryException

Returns a 2- or 3-dimensional coordinate system for geodetic latitude and longitude, sometime with ellipsoidal height. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Ellipsoidal­CS(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Ellipsoidal­CS(String) method in the parent class. This allows to check if the more generic create­Coordinate­System(String) method cached a value before to try that method.

Overrides:

create­Ellipsoidal­CS in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Ellipsoidal­CS

createVerticalCS

public VerticalCS createVerticalCS(String code)
                            throws FactoryException

Returns a 1-dimensional coordinate system for heights or depths of points. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Vertical­CS(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Vertical­CS(String) method in the parent class. This allows to check if the more generic create­Coordinate­System(String) method cached a value before to try that method.

Overrides:

create­Vertical­CS in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Vertical­CS

createTimeCS

public TimeCS createTimeCS(String code)
                    throws FactoryException

Returns a 1-dimensional coordinate system for heights or depths of points. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Time­CS(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Time­CS(String) method in the parent class. This allows to check if the more generic create­Coordinate­System(String) method cached a value before to try that method.

Overrides:

create­Time­CS in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Time­CS

createCartesianCS

public CartesianCS createCartesianCS(String code)
                              throws FactoryException

Returns a 2- or 3-dimensional Cartesian coordinate system made of straight orthogonal axes. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Cartesian­CS(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Cartesian­CS(String) method in the parent class. This allows to check if the more generic create­Coordinate­System(String) method cached a value before to try that method.

Overrides:

create­Cartesian­CS in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Cartesian­CS

createSphericalCS

public SphericalCS createSphericalCS(String code)
                              throws FactoryException

Returns a 3-dimensional coordinate system with one distance measured from the origin and two angular coordinates. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Spherical­CS(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Spherical­CS(String) method in the parent class. This allows to check if the more generic create­Coordinate­System(String) method cached a value before to try that method.

Overrides:

create­Spherical­CS in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Spherical­CS

createCylindricalCS

public CylindricalCS createCylindricalCS(String code)
                                  throws FactoryException

Returns a 3-dimensional coordinate system made of a polar coordinate system extended by a straight perpendicular axis. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Cylindrical­CS(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Cylindrical­CS(String) method in the parent class. This allows to check if the more generic create­Coordinate­System(String) method cached a value before to try that method.

Overrides:

create­Cylindrical­CS in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Cylindrical­CS

createPolarCS

public PolarCS createPolarCS(String code)
                      throws FactoryException

Returns a 2-dimensional coordinate system for coordinates represented by a distance from the origin and an angle from a fixed direction. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Polar­CS(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Polar­CS(String) method in the parent class. This allows to check if the more generic create­Coordinate­System(String) method cached a value before to try that method.

Overrides:

create­Polar­CS in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Polar­CS

createCoordinateSystemAxis

public CoordinateSystemAxis createCoordinateSystemAxis(String code)
                                                throws FactoryException

Returns a coordinate system axis with name, direction, unit and range of values. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Coordinate­System­Axis(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Coordinate­System­Axis(String) method in the parent class. This allows to check if the more generic create­Object(String) method cached a value before to try that method.

Overrides:

create­Coordinate­System­Axis in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the axis for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Coordinate­System­Axis

createUnit

public Unit<?> createUnit(String code)
                   throws FactoryException

Returns an unit of measurement from a code. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Unit(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Unit(String) method in the parent class.

Overrides:

create­Unit in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the unit of measurement for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Units.value­Of­EPSG(int)

createParameterDescriptor

public ParameterDescriptor<?> createParameterDescriptor(String code)
                                                 throws FactoryException

Returns a definition of a single parameter used by an operation method. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Parameter­Descriptor(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Parameter­Descriptor(String) method in the parent class. This allows to check if the more generic create­Object(String) method cached a value before to try that method.

Overrides:

create­Parameter­Descriptor in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the parameter descriptor for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Parameter­Descriptor, Apache SIS™ Coordinate Operation Methods

createOperationMethod

public OperationMethod createOperationMethod(String code)
                                      throws FactoryException

Returns a description of the algorithm and parameters used to perform a coordinate operation. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Operation­Method(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Operation­Method(String) method in the parent class. This allows to check if the more generic create­Object(String) method cached a value before to try that method.

Overrides:

create­Operation­Method in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the operation method for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Default­Operation­Method, Apache SIS™ Coordinate Operation Methods

createCoordinateOperation

public CoordinateOperation createCoordinateOperation(String code)
                                              throws FactoryException

Returns an operation for transforming coordinates in the source CRS to coordinates in the target CRS. The default implementation performs the following steps:

• Return the cached instance for the given code if such instance already exists.
• Otherwise if the Data Access Object (DAO) overrides the create­Coordinate­Operation(String) method, invoke that method and cache the result for future use.
• Otherwise delegate to the Geodetic­Authority­Factory.create­Coordinate­Operation(String) method in the parent class. This allows to check if the more generic create­Object(String) method cached a value before to try that method.

Overrides:

create­Coordinate­Operation in class Geodetic­Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the operation for the given code.

Throws:

Factory­Exception - if the object creation failed.

See Also:

Abstract­Coordinate­Operation

createFromCoordinateReferenceSystemCodes

public Set<CoordinateOperation> createFromCoordinateReferenceSystemCodes(String sourceCRS,
                                                                String targetCRS)
                                                                  throws FactoryException

Returns operations from source and target coordinate reference system codes. The default implementation performs the following steps:

• Returns the cached collection for the given pair of codes if such collection already exists.
• Otherwise:
  1. get an instance of the Data Access Object,
  2. delegate to its Geodetic­Authority­Factory.create­From­Coordinate­Reference­System­Codes(String, String) method,
  3. release the Data Access Object — this step assumes that the collection obtained at step 2 is still valid after the Data Access Object has been released,
  4. cache the result — this step assumes that the collection obtained at step 2 is immutable.

Overrides:

create­From­Coordinate­Reference­System­Codes in class Geodetic­Authority­Factory

Parameters:

source­CRS - coded value of source coordinate reference system.

target­CRS - coded value of target coordinate reference system.

Returns:

the operations from source­CRS to target­CRS.

Throws:

Factory­Exception - if the object creation failed.

newIdentifiedObjectFinder

public IdentifiedObjectFinder newIdentifiedObjectFinder()
                                                 throws FactoryException

Returns a finder which can be used for looking up unidentified objects. The default implementation delegates lookup to the underlying Data Access Object and caches the result.

Overrides:

new­Identified­Object­Finder in class Geodetic­Authority­Factory

Returns:

a finder to use for looking up unidentified objects.

Throws:

Factory­Exception - if the finder can not be created.

See Also:

Identified­Objects.new­Finder(String)

isCacheable

protected boolean isCacheable(String code,
                  Object object)

Returns whether the given object can be cached. This method is invoked after the Data Access Object created a new object not previously in the cache. If this is­Cacheable(…) method returns true, then the newly created object will be cached so that next calls to the same create­Foo(String) method with the same code may return the same object. If this method returns false, then the newly created object will not be cached and next call to the create­Foo(String) method with the same code will return a new object.

The default implementation always returns true. Subclasses can override this method for filtering the objects to store in the cache.

Parameters:

code - the authority code specified by the caller for creating an object.

object - the object created for the given authority code.

Returns:

whether the given object should be cached.

Since:

0.8

See Also:

print­Cache­Content(Print­Writer)

printCacheContent

@Debug
public void printCacheContent(PrintWriter out)

Prints the cache content to the given writer. Keys are sorted by numerical order if possible, or alphabetical order otherwise. This method is used for debugging purpose only.

Parameters:

out - the output printer, or null for the standard output stream.

See Also:

is­Cacheable(String, Object)

close

public void close()
           throws FactoryException

Immediately closes all Data Access Objects that are closeable. This method does not clear the cache and does not disallow further usage of this factory: this Concurrent­Authority­Factory can still be used as usual after it has been "closed". New Data Access Objects will be created if needed for replacing the ones closed by this method.

The main purpose of this method is to force immediate release of JDBC connections or other kind of resources that Data Access Objects may hold. If this method is not invoked, Data Access Objects will be closed when this Concurrent­Authority­Factory will be garbage collected or at JVM shutdown time, depending which event happen first.

Specified by:

close in interface Auto­Closeable

Throws:

Factory­Exception - if an error occurred while closing the Data Access Objects.

See Also:

can­Close(Geodetic­Authority­Factory)

toString

@Debug
public String toString()

Returns a string representation of this factory for debugging purpose only. The string returned by this method may change in any future SIS version.

Overrides:

to­String in class Geodetic­Authority­Factory

Returns:

a string representation for debugging purpose.

See Also:

print­Cache­Content(Print­Writer)