org.geotools.data.mysql
Class MySQLDataStoreFactory

java.lang.Object
  org.geotools.data.mysql.MySQLDataStoreFactory

All Implemented Interfaces:

DataStoreFactorySpi, Factory

public class MySQLDataStoreFactory

extends java.lang.Object

implements DataStoreFactorySpi

Creates a MySQLDataStoreFactory based on the correct params.

This factory should be registered in the META-INF/ folder, under services/ in the DataStoreFactorySpi file.

Author:

Andrea Aime, University of Modena and Reggio Emilia

Nested Class Summary

Nested classes inherited from class org.geotools.data.DataStoreFactorySpi

DataStoreFactorySpi.Param

Constructor Summary

MySQLDataStoreFactory()
Creates a new instance of PostgisDataStoreFactory

Method Summary

boolean	canProcess(java.util.Map params) Checks to see if all the postgis params are there.
DataStore	createDataStore(java.util.Map params) Construct a postgis data store using the params.
DataStore	createNewDataStore(java.util.Map params) Postgis cannot create a new database.
java.lang.String	getDescription() Describe the nature of the datasource constructed by this factory.
java.lang.String	getDisplayName() Name suitable for display to end user.
java.util.Map	getImplementationHints() Returns the implementation hints.
DataStoreFactorySpi.Param[]	getParametersInfo() Describe parameters.
boolean	isAvailable() Test to see if this datastore is available, if it has all the appropriate libraries to construct a datastore.

Methods inherited from class java.lang.Object

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

Constructor Detail

MySQLDataStoreFactory

public MySQLDataStoreFactory()

Creates a new instance of PostgisDataStoreFactory

Method Detail

canProcess

public boolean canProcess(java.util.Map params)

Checks to see if all the postgis params are there.

Should have:

• dbtype: equal to postgis
• host
• user
• passwd
• database

Specified by:

canProcess in interface DataStoreFactorySpi

Parameters:

params - Set of parameters needed for a postgis data store.

Returns:

true if dbtype equals postgis, and contains keys for host, user, passwd, and database.

createDataStore

public DataStore createDataStore(java.util.Map params)
                          throws java.io.IOException

Construct a postgis data store using the params.

Specified by:

createDataStore in interface DataStoreFactorySpi

Parameters:

params - The full set of information needed to construct a live data source. Should have dbtype equal to postgis, as well as host, user, passwd, database, and table.

Returns:

The created DataSource, this may be null if the required resource was not found or if insufficent parameters were given. Note that canProcess() should have returned false if the problem is to do with insuficent parameters.

Throws:

java.io.IOException - See DataSourceException

DataSourceException - Thrown if there were any problems creating or connecting the datasource.

createNewDataStore

public DataStore createNewDataStore(java.util.Map params)
                             throws java.io.IOException

Postgis cannot create a new database.

Specified by:

createNewDataStore in interface DataStoreFactorySpi

Parameters:

params -

Returns:

Throws:

java.io.IOException - See UnsupportedOperationException

java.lang.UnsupportedOperationException - Cannot create new database

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: DataStoreFactorySpi

Name suitable for display to end user.

A non localized display name for this data store type.

Specified by:

getDisplayName in interface DataStoreFactorySpi

Returns:

"MySQL"

getDescription

public java.lang.String getDescription()

Describe the nature of the datasource constructed by this factory.

Specified by:

getDescription in interface DataStoreFactorySpi

Returns:

A human readable description that is suitable for inclusion in a list of available datasources. Currently uses the string "MySQL Database"

isAvailable

public boolean isAvailable()

Test to see if this datastore is available, if it has all the appropriate libraries to construct a datastore. This datastore just returns true for now. This method is used for gui apps, so as to not advertise data store capabilities they don't actually have.

Specified by:

isAvailable in interface DataStoreFactorySpi

Returns:

true if and only if this factory is available to create DataStores.

getParametersInfo

public DataStoreFactorySpi.Param[] getParametersInfo()

Describe parameters.

Specified by:

getParametersInfo in interface DataStoreFactorySpi

Returns:

See Also:

DataStoreFactorySpi.getParametersInfo()

getImplementationHints

public java.util.Map getImplementationHints()

Returns the implementation hints. The default implementation returns en empty map.

Specified by:

getImplementationHints in interface Factory

Returns:

The map of hints, or an empty map if none.