Class ThreadedHsqlEpsgFactory

All Implemented Interfaces:
AuthorityFactory, CRSAuthorityFactory, CSAuthorityFactory, DatumAuthorityFactory, Factory, CoordinateOperationAuthorityFactory, BufferedFactory, Factory, OptionalFactory, RegistrableFactory

public class ThreadedHsqlEpsgFactory extends ThreadedEpsgFactory
Connection to the EPSG database in HSQL database engine format using JDBC. The EPSG database can be downloaded from http://www.epsg.org. The SQL scripts (modified for the HSQL syntax as explained here) are bundled into this plugin. The database version is given in the edition attribute of the authority. The HSQL database is read only.

Implementation note

The SQL scripts are executed the first time a connection is required. The database is then created as cached tables (HSQL.properties and HSQL.data files) in a temporary directory. Future connections to the EPSG database while reuse the cached tables, if available. Otherwise, the scripts will be executed again in order to recreate them.

If the EPSG database should be created in a different directory (or already exists in that directory), it may be specified as a system property nammed "EPSG-HSQL.directory".

Since:
2.4
Author:
Martin Desruisseaux, Didier Richard
  • Field Details

    • LOGGER

      public static final Logger LOGGER
    • VERSION

      public static final Version VERSION
      Current version of EPSG-HSQL plugin. This is usually the same version number than the one in the EPSG database bundled in this plugin. However this field may contains additional minor version number if there is some changes related to the EPSG-HSQL plugin rather than the EPSG database itself (for example additional database index).
    • DIRECTORY_KEY

      public static final String DIRECTORY_KEY
      The key for fetching the database directory from system properties.
      See Also:
    • DATABASE_NAME

      public static final String DATABASE_NAME
      The database name.
      See Also:
  • Constructor Details

    • ThreadedHsqlEpsgFactory

      public ThreadedHsqlEpsgFactory()
      Creates a new instance of this factory. If the "EPSG-HSQL.directory" system property is defined and contains the name of a directory with a valid parent, then the "EPSG" database will be saved in that directory. Otherwise, a temporary directory will be used.
    • ThreadedHsqlEpsgFactory

      public ThreadedHsqlEpsgFactory(Hints hints)
      Creates a new instance of this data source using the specified hints. The priority is set to a lower value than the FactoryOnAccess's one in order to give precedence to the Access-backed database, if presents. Priorities are set that way because:
      • The MS-Access format is the primary EPSG database format.
      • If a user downloads the MS-Access database himself, he probably wants to use it.
  • Method Details

    • createDataSource

      protected DataSource createDataSource() throws SQLException
      Returns a data source for the HSQL database.
      Overrides:
      createDataSource in class ThreadedEpsgFactory
      Returns:
      The EPSG data source, or null if none where found.
      Throws:
      SQLException - if an error occured while creating the data source.
    • createBackingStore

      protected AbstractAuthorityFactory createBackingStore(Hints hints) throws SQLException
      Returns the backing-store factory for HSQL syntax. If the cached tables are not available, they will be created now from the SQL scripts bundled in this plugin.
      Overrides:
      createBackingStore in class ThreadedEpsgFactory
      Parameters:
      hints - A map of hints, including the low-level factories to use for CRS creation.
      Returns:
      The EPSG factory using HSQL syntax.
      Throws:
      SQLException - if connection to the database failed.