org.geotools.data.spatialite
Class SpatiaLiteDataStoreFactory

Object
  AbstractDataStoreFactory
      JDBCDataStoreFactory
          SpatiaLiteDataStoreFactory

All Implemented Interfaces:

DataAccessFactory, DataStoreFactorySpi, Factory

public class SpatiaLiteDataStoreFactory
extends JDBCDataStoreFactory

DataStoreFactory for SpatiaLite database.

Author:

Justin Deoliveira, OpenGeo

Nested Class Summary

Nested classes/interfaces inherited from interface DataAccessFactory

DataAccessFactory.Param

Field Summary

static DataAccessFactory.Param	DBTYPE parameter for database type
static DataAccessFactory.Param	USER optional user parameter

Fields inherited from class JDBCDataStoreFactory

DATABASE, DATASOURCE, EXPOSE_PK, FETCHSIZE, HOST, MAX_OPEN_PREPARED_STATEMENTS, MAXCONN, MAXWAIT, MINCONN, NAMESPACE, PASSWD, PK_METADATA_TABLE, PORT, SCHEMA, SQL_ON_BORROW, SQL_ON_RELEASE, VALIDATECONN

Constructor Summary

SpatiaLiteDataStoreFactory()

Method Summary

BasicDataSource	createDataSource(Map params) DataSource access allowing SQL use: intended to allow client code to query available schemas.
protected SQLDialect	createSQLDialect(JDBCDataStore dataStore) Creates the dialect that the datastore uses for communication with the underlying database.
File	getBaseDirectory() The base location to store sqlite database files.
protected String	getDatabaseID() Returns a string to identify the type of the database.
String	getDescription() Describe the nature of the datasource constructed by this factory.
protected String	getDriverClassName() Returns the fully qualified class name of the jdbc driver.
protected String	getJDBCUrl(Map params) Builds up the JDBC url in a jdbc:://:/ Override if you need a different setup
protected String	getValidationQuery() 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.
boolean	isAvailable() Determines if the datastore is available.
void	setBaseDirectory(File baseDirectory) Sets the base location to store sqlite database files.
protected void	setupParameters(Map parameters) Sets up the database connection parameters.

Methods inherited from class JDBCDataStoreFactory

canProcess, checkDBType, checkDBType, createDataSource, createDataStore, createDataStoreInternal, createNewDataStore, getDisplayName, getImplementationHints, getParametersInfo

Methods inherited from class AbstractDataStoreFactory

getParameters

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DBTYPE

public static final DataAccessFactory.Param DBTYPE

parameter for database type

USER

public static final DataAccessFactory.Param USER

optional user parameter

Constructor Detail

SpatiaLiteDataStoreFactory

public SpatiaLiteDataStoreFactory()

Method Detail

setBaseDirectory

public void setBaseDirectory(File baseDirectory)

Sets the base location to store sqlite database files.

Parameters:

baseDirectory - A directory.

getBaseDirectory

public File getBaseDirectory()

The base location to store sqlite database files.

isAvailable

public boolean isAvailable()

Description copied from class: JDBCDataStoreFactory

Determines if the datastore is available.

Subclasses may with to override or extend this method. This implementation checks whether the jdbc driver class (provided by JDBCDataStoreFactory.getDriverClassName() can be loaded.

Specified by:

isAvailable in interface DataAccessFactory

Overrides:

isAvailable in class JDBCDataStoreFactory

Returns:

true, override to check for drivers etc...

createSQLDialect

protected SQLDialect createSQLDialect(JDBCDataStore dataStore)

Description copied from class: JDBCDataStoreFactory

Creates the dialect that the datastore uses for communication with the underlying database.

Specified by:

createSQLDialect in class JDBCDataStoreFactory

Parameters:

dataStore - The datastore.

getDatabaseID

protected String getDatabaseID()

Description copied from class: JDBCDataStoreFactory

Returns a string to identify the type of the database.

Example: 'postgis'.

Specified by:

getDatabaseID in class JDBCDataStoreFactory

getDriverClassName

protected String 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 class JDBCDataStoreFactory

getDescription

public String 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.

getValidationQuery

protected String 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 class JDBCDataStoreFactory

Returns:

setupParameters

protected void setupParameters(Map parameters)

Description copied from class: JDBCDataStoreFactory

Sets up the database connection parameters.

Subclasses may extend, but should not override. This implementation registers the following parameters.

• JDBCDataStoreFactory.HOST
• JDBCDataStoreFactory.PORT
• JDBCDataStoreFactory.DATABASE
• JDBCDataStoreFactory.SCHEMA
• JDBCDataStoreFactory.USER
• JDBCDataStoreFactory.PASSWD

Subclass implementation may remove any parameters from the map, or may overrwrite any parameters in the map.

Overrides:

setupParameters in class JDBCDataStoreFactory

Parameters:

parameters - Map of Param objects.

getJDBCUrl

protected String getJDBCUrl(Map params)
                     throws IOException

Description copied from class: JDBCDataStoreFactory

Builds up the JDBC url in a jdbc:://:/ Override if you need a different setup

Overrides:

getJDBCUrl in class JDBCDataStoreFactory

Returns:

Throws:

IOException

createDataSource

public BasicDataSource createDataSource(Map params)
                                 throws IOException

Description copied from class: JDBCDataStoreFactory

DataSource access allowing SQL use: intended to allow client code to query available schemas.

This DataSource is the clients responsibility to close() when they are finished using it.

Overrides:

createDataSource in class JDBCDataStoreFactory

Parameters:

params - Map of connection parameter.

Returns:

DataSource for SQL use

Throws:

IOException