org.geotools.data.mysql
Class MySQLDataStoreFactory

Object
  extended by AbstractDataStoreFactory
      extended by JDBCDataStoreFactory
          extended by MySQLDataStoreFactory
All Implemented Interfaces:
DataAccessFactory, DataStoreFactorySpi, Factory

public class MySQLDataStoreFactory
extends JDBCDataStoreFactory

DataStoreFactory for MySQL database.

Author:
David Winslow, The Open Planning Project

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 PORT
          Default port number for MYSQL
static DataAccessFactory.Param STORAGE_ENGINE
          Storage engine to use when creating tables
 
Fields inherited from class JDBCDataStoreFactory
DATABASE, DATASOURCE, EXPOSE_PK, FETCHSIZE, HOST, MAX_OPEN_PREPARED_STATEMENTS, MAXCONN, MAXWAIT, MINCONN, NAMESPACE, PASSWD, PK_METADATA_TABLE, SCHEMA, SQL_ON_BORROW, SQL_ON_RELEASE, USER, VALIDATECONN
 
Constructor Summary
MySQLDataStoreFactory()
           
 
Method Summary
protected  JDBCDataStore createDataStoreInternal(JDBCDataStore dataStore, Map 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  String getDatabaseID()
          Returns a string to identify the type of the database.
 String getDescription()
          Describe the nature of the datasource constructed by this factory.
 String getDisplayName()
          Default Implementation abuses the naming convention.
protected  String getDriverClassName()
          Returns the fully qualified class name of the jdbc driver.
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.
protected  void setupParameters(Map parameters)
          Sets up the database connection parameters.
 
Methods inherited from class JDBCDataStoreFactory
canProcess, checkDBType, checkDBType, createDataSource, createDataSource, createDataStore, createNewDataStore, getImplementationHints, getJDBCUrl, getParametersInfo, isAvailable
 
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


PORT

public static final DataAccessFactory.Param PORT
Default port number for MYSQL


STORAGE_ENGINE

public static final DataAccessFactory.Param STORAGE_ENGINE
Storage engine to use when creating tables

Constructor Detail

MySQLDataStoreFactory

public MySQLDataStoreFactory()
Method Detail

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.

getDisplayName

public String getDisplayName()
Description copied from class: AbstractDataStoreFactory
Default Implementation abuses the naming convention.

Will return Foo for org.geotools.data.foo.FooFactory.

Specified by:
getDisplayName in interface DataAccessFactory
Overrides:
getDisplayName in class JDBCDataStoreFactory
Returns:
return display name based on class name

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

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

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.

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.

createDataStoreInternal

protected JDBCDataStore createDataStoreInternal(JDBCDataStore dataStore,
                                                Map params)
                                         throws IOException
Description 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 class JDBCDataStoreFactory
Parameters:
dataStore - The newly created datastore.
params - THe datastore parameters.
Throws:
IOException


Copyright © 1996-2014 Geotools. All Rights Reserved.