Class GeoPkgDataStoreFactory
- All Implemented Interfaces:
DataAccessFactory
,DataStoreFactorySpi
,Factory
- Author:
- Justin Deoliveira, Niels Charlier
-
Nested Class Summary
Nested classes/interfaces inherited from interface DataAccessFactory
DataAccessFactory.Param
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final DataAccessFactory.Param
static final DataAccessFactory.Param
parameter for database instancestatic final DataAccessFactory.Param
parameter for database typestatic final DataAccessFactory.Param
Maximum mapped memory, defaults to nullstatic final DataAccessFactory.Param
Fields inherited from class JDBCDataStoreFactory
BATCH_INSERT_SIZE, CALLBACK_FACTORY, DATASOURCE, EVICTOR_TESTS_PER_RUN, EXPOSE_PK, FETCHSIZE, HOST, MAX_OPEN_PREPARED_STATEMENTS, MAXCONN, MAXWAIT, MIN_EVICTABLE_TIME, MINCONN, NAMESPACE, PASSWD, PK_METADATA_TABLE, PORT, SCHEMA, SQL_ON_BORROW, SQL_ON_RELEASE, TEST_WHILE_IDLE, TIME_BETWEEN_EVICTOR_RUNS, USER, VALIDATECONN
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionBasicDataSource
createDataSource
(Map<String, ?> params) This is left for public API compatibility but it's not as efficient as using the GeoPackage internal poolprotected DataSource
createDataSource
(Map<String, ?> params, SQLDialect dialect) Creates the datasource for the data store.protected JDBCDataStore
createDataStoreInternal
(JDBCDataStore dataStore, Map<String, ?> params) Subclass hook to do additional initialization of a newly created datastore.protected SQLDialect
createSQLDialect
(JDBCDataStore dataStore) Creates the dialect that the datastore uses for communication with the underlying database.protected SQLDialect
createSQLDialect
(JDBCDataStore dataStore, Map<String, ?> params) Creates the dialect that the datastore uses for communication with the underlying database.protected String
Returns a string to identify the type of the database.Describe the nature of the datasource constructed by this factory.protected String
Returns the fully qualified class name of the jdbc driver.protected String
getJDBCUrl
(Map<String, ?> params) Builds up the JDBC url in a jdbc::// : / Override if you need a different setup protected String
Override this to return a good validation query (a very quick one, such as one that asks the database what time is it) or return null if the factory does not support validation.void
setBaseDirectory
(File baseDirectory) Sets the base location to store database files.static void
setSqlLiteConnectTimeout
(int sqlLiteConnectTimeout) Sets the timeout for SQLite connections in miliseconds (for testing).protected void
setupParameters
(Map<String, Object> parameters) Sets up the database connection parameters.Methods inherited from class JDBCDataStoreFactory
canProcess, checkDBType, checkDBType, createDataStore, createNewDataStore, getDisplayName, getImplementationHints, getParametersInfo, isAvailable
-
Field Details
-
DBTYPE
parameter for database type -
DATABASE
parameter for database instance -
READ_ONLY
-
CONTENTS_ONLY
-
MEMORY_MAP_SIZE
Maximum mapped memory, defaults to null
-
-
Constructor Details
-
GeoPkgDataStoreFactory
public GeoPkgDataStoreFactory() -
GeoPkgDataStoreFactory
-
-
Method Details
-
setBaseDirectory
Sets the base location to store database files.- Parameters:
baseDirectory
- A directory.
-
getDatabaseID
Description copied from class:JDBCDataStoreFactory
Returns a string to identify the type of the database.Example: 'postgis'.
- Specified by:
getDatabaseID
in classJDBCDataStoreFactory
-
getDescription
Description copied from interface:DataAccessFactory
Describe the nature of the datasource constructed by this factory.A non localized description of this data store type.
- Returns:
- A human readable description that is suitable for inclusion in a list of available datasources.
-
getDriverClassName
Description copied from class:JDBCDataStoreFactory
Returns the fully qualified class name of the jdbc driver.For example: org.postgresql.Driver
- Specified by:
getDriverClassName
in classJDBCDataStoreFactory
-
createSQLDialect
Description copied from class:JDBCDataStoreFactory
Creates the dialect that the datastore uses for communication with the underlying database.- Overrides:
createSQLDialect
in classJDBCDataStoreFactory
- Parameters:
dataStore
- The datastore.params
- The connection parameters
-
createSQLDialect
Description copied from class:JDBCDataStoreFactory
Creates the dialect that the datastore uses for communication with the underlying database.- Specified by:
createSQLDialect
in classJDBCDataStoreFactory
- Parameters:
dataStore
- The datastore.
-
getValidationQuery
Description copied from class:JDBCDataStoreFactory
Override this to return a good validation query (a very quick one, such as one that asks the database what time is it) or return null if the factory does not support validation.- Specified by:
getValidationQuery
in classJDBCDataStoreFactory
-
getJDBCUrl
Description copied from class:JDBCDataStoreFactory
Builds up the JDBC url in a jdbc::// : / Override if you need a different setup - Overrides:
getJDBCUrl
in classJDBCDataStoreFactory
- Throws:
IOException
-
setupParameters
Description copied from class:JDBCDataStoreFactory
Sets up the database connection parameters.Subclasses may extend, but should not override. This implementation registers the following parameters.
Subclass implementation may remove any parameters from the map, or may overrwrite any parameters in the map.- Overrides:
setupParameters
in classJDBCDataStoreFactory
- Parameters:
parameters
- Map ofDataAccessFactory.Param
objects.
-
createDataSource
This is left for public API compatibility but it's not as efficient as using the GeoPackage internal pool- Overrides:
createDataSource
in classJDBCDataStoreFactory
- Parameters:
params
- Map of connection parameter.- Returns:
- DataSource for SQL use
- Throws:
IOException
-
createDataSource
Description copied from class:JDBCDataStoreFactory
Creates the datasource for the data store.This method creates a
BasicDataSource
instance and populates it as follows:- poolPreparedStatements -> false
- driverClassName ->
JDBCDataStoreFactory.getDriverClassName()
- url -> 'jdbc:<
JDBCDataStoreFactory.getDatabaseID()
>://<JDBCDataStoreFactory.HOST
>/<JDBCDataStoreFactory.DATABASE
>' - username -> <
JDBCDataStoreFactory.USER
> - password -> <
JDBCDataStoreFactory.PASSWD
>
- Overrides:
createDataSource
in classJDBCDataStoreFactory
- Throws:
IOException
-
createDataStoreInternal
protected JDBCDataStore createDataStoreInternal(JDBCDataStore dataStore, Map<String, ?> params) throws IOExceptionDescription copied from class:JDBCDataStoreFactory
Subclass hook to do additional initialization of a newly created datastore.Typically subclasses will want to override this method in the case where they provide additional datastore parameters, those should be processed here.
This method is provided with an instance of the datastore. In some cases subclasses may wish to create a new instance of the datastore, for instance in order to wrap the original instance. This is supported but the new datastore must be returned from this method. If not is such the case this method should still return the original passed in.
- Overrides:
createDataStoreInternal
in classJDBCDataStoreFactory
- Parameters:
dataStore
- The newly created datastore.params
- THe datastore parameters.- Throws:
IOException
-
setSqlLiteConnectTimeout
public static void setSqlLiteConnectTimeout(int sqlLiteConnectTimeout) Sets the timeout for SQLite connections in miliseconds (for testing). Default is 60 seconds.- Parameters:
sqlLiteConnectTimeout
- timeout in miliseconds
-