org.geotools.data.ogr

Class OGRDataStoreFactory

Object

OGRDataStoreFactory

All Implemented Interfaces:

DataAccessFactory, DataStoreFactorySpi, Factory

Direct Known Subclasses:

JniOGRDataStoreFactory

public abstract class OGRDataStoreFactory
extends Object
implements DataStoreFactorySpi

Implementation of the DataStore service provider interface for OGR.

Author:

Andrea Aime, GeoSolution

Nested Class Summary

Nested classes/interfaces inherited from interface DataAccessFactory

DataAccessFactory.Param

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_EVICTABLE_TIME
static int	DEFAULT_EVICTOR_TESTS_PER_RUN
protected static Integer	DEFAULT_MAXCONN
protected static int	DEFAULT_MAXWAIT
protected static Integer	DEFAULT_MINCONN
static boolean	DEFAULT_PRIME_DATASOURCE
static DataAccessFactory.Param	EVICTOR_TESTS_PER_RUN Number of connections checked during a single evictor run *
protected static Logger	LOGGER
static DataAccessFactory.Param	MAXCONN Maximum number of connections in the connection pool
static DataAccessFactory.Param	MAXWAIT Maximum amount of time the pool will wait when trying to grab a new connection *
static DataAccessFactory.Param	MIN_EVICTABLE_TIME Min time for a connection to be idle in order to be evicted *
static DataAccessFactory.Param	MINCONN Minimum number of connections in the connection pool
static DataAccessFactory.Param	NAMESPACEP
static DataAccessFactory.Param	OGR_DRIVER_NAME
static DataAccessFactory.Param	OGR_NAME
static DataAccessFactory.Param	PRIME_DATASOURCE Whether to try to initialize a datasource with a full data read before using it*

Constructor Summary

Constructors

Constructor and Description
OGRDataStoreFactory()

Method Summary

Modifier and Type	Method and Description
boolean	canProcess(Map<String,?> params) Test to see if this factory is suitable for processing the data pointed to by the params map.
boolean	canProcess(String ogrName, String driverName) Assume we can process an ogrName if the ogrName exists and can be opened, or if the specified driver does exist.
DataStore	createDataStore(Map<String,?> params) Construct a live data source using the params specifed.
DataStore	createNewDataStore(Map<String,?> params) Not implemented yet.
protected abstract OGR	createOGR()
protected abstract boolean	doIsAvailable() Performs the actual test to see if the OGR library and this datastore is available.
Set<String>	getAvailableDrivers()
String	getDescription() Describes the type of data the datastore returned by this factory works with.
String	getDisplayName() Name suitable for display to end user.
Map<RenderingHints.Key,?>	getImplementationHints() Map of hints (maybe unmodifiable) used by this factory to customize its use.
DataAccessFactory.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.
boolean	isAvailable(boolean handleError) Performs the available test specifying how to handle errors.

Methods inherited from class Object

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

Field Detail

LOGGER

protected static Logger LOGGER

OGR_NAME

public static final DataAccessFactory.Param OGR_NAME

OGR_DRIVER_NAME

public static final DataAccessFactory.Param OGR_DRIVER_NAME

NAMESPACEP

public static final DataAccessFactory.Param NAMESPACEP

DEFAULT_MAXCONN

protected static final Integer DEFAULT_MAXCONN

MAXCONN

public static final DataAccessFactory.Param MAXCONN

Maximum number of connections in the connection pool

DEFAULT_MINCONN

protected static final Integer DEFAULT_MINCONN

MINCONN

public static final DataAccessFactory.Param MINCONN

Minimum number of connections in the connection pool

DEFAULT_MAXWAIT

protected static final int DEFAULT_MAXWAIT

See Also:

Constant Field Values

MAXWAIT

public static final DataAccessFactory.Param MAXWAIT

Maximum amount of time the pool will wait when trying to grab a new connection *

DEFAULT_EVICTABLE_TIME

protected static final int DEFAULT_EVICTABLE_TIME

See Also:

Constant Field Values

MIN_EVICTABLE_TIME

public static final DataAccessFactory.Param MIN_EVICTABLE_TIME

Min time for a connection to be idle in order to be evicted *

DEFAULT_EVICTOR_TESTS_PER_RUN

public static final int DEFAULT_EVICTOR_TESTS_PER_RUN

See Also:

Constant Field Values

EVICTOR_TESTS_PER_RUN

public static final DataAccessFactory.Param EVICTOR_TESTS_PER_RUN

Number of connections checked during a single evictor run *

DEFAULT_PRIME_DATASOURCE

public static final boolean DEFAULT_PRIME_DATASOURCE

See Also:

Constant Field Values

PRIME_DATASOURCE

public static final DataAccessFactory.Param PRIME_DATASOURCE

Whether to try to initialize a datasource with a full data read before using it*

Constructor Detail

OGRDataStoreFactory

public OGRDataStoreFactory()

Method Detail

createOGR

protected abstract OGR createOGR()

canProcess

public boolean canProcess(Map<String,?> params)

Description copied from interface: DataAccessFactory

Test to see if this factory is suitable for processing the data pointed to by the params map.

If this datasource requires a number of parameters then this mehtod should check that they are all present and that they are all valid. If the datasource is a file reading data source then the extentions or mime types of any files specified should be checked. For example, a Shapefile datasource should check that the url param ends with shp, such tests should be case insensative.

Specified by:

canProcess in interface DataAccessFactory

Parameters:

params - The full set of information needed to construct a live data source.

Returns:

booean true if and only if this factory can process the resource indicated by the param set and all the required params are pressent.

createDataStore

public DataStore createDataStore(Map<String,?> params)
                          throws IOException

Description copied from interface: DataStoreFactorySpi

Construct a live data source using the params specifed.

You can think of this as setting up a connection to the back end data source.

Magic Params: the following params are magic and are honoured by convention by the GeoServer and uDig application.

• "user": is taken to be the user name
• "passwd": is taken to be the password
• "namespace": is taken to be the namespace prefix (and will be kept in sync with GeoServer namespace management.

When we eventually move over to the use of OpperationalParam we will have to find someway to codify this convention.

Specified by:

createDataStore in interface DataAccessFactory

Specified by:

createDataStore in interface DataStoreFactorySpi

Parameters:

params - The full set of information needed to construct a live data store. Typical key values for the map include: url - location of a resource, used by file reading datasources. dbtype - the type of the database to connect to, e.g. postgis, mysql

Returns:

The created DataStore, 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:

IOException - if there were any problems setting up (creating or connecting) the datasource.

createNewDataStore

public DataStore createNewDataStore(Map<String,?> params)
                             throws IOException

Not implemented yet.

Specified by:

createNewDataStore in interface DataStoreFactorySpi

Throws:

IOException

getDisplayName

public String getDisplayName()

Description copied from interface: DataAccessFactory

Name suitable for display to end user.

A non localized display name for this data store type.

Specified by:

getDisplayName in interface DataAccessFactory

Returns:

A short name suitable for display in a user interface.

getDescription

public String getDescription()

Describes the type of data the datastore returned by this factory works with.

Specified by:

getDescription in interface DataAccessFactory

Returns:

String a human readable description of the type of restore supported by this datastore.

isAvailable

public final boolean isAvailable()

Test to see if this datastore is available, if it has all the appropriate libraries to construct a datastore.

Specified by:

isAvailable in interface DataAccessFactory

Returns:

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

TODO:

REVISIT: I'm just adding this method to compile, maintainer should revisit to check for any libraries that may be necessary for datastore creations.

isAvailable

public final boolean isAvailable(boolean handleError)

Performs the available test specifying how to handle errors.

Specifying true for handleError will cause any exceptions to be caught and logged, and return false

doIsAvailable

protected abstract boolean doIsAvailable()
                                  throws Throwable

Performs the actual test to see if the OGR library and this datastore is available.

Implementations of this method should not attempt to handle any fatal exceptions.

Throws:

Throwable

getParametersInfo

public DataAccessFactory.Param[] getParametersInfo()

Describe parameters.

Specified by:

getParametersInfo in interface DataAccessFactory

Returns:

Param array describing the Map for createDataStore

See Also:

DataAccessFactory.getParametersInfo()

canProcess

public boolean canProcess(String ogrName,
                          String driverName)

Assume we can process an ogrName if the ogrName exists and can be opened, or if the specified driver does exist.

getAvailableDrivers

public Set<String> getAvailableDrivers()

getImplementationHints

public Map<RenderingHints.Key,?> getImplementationHints()

Description copied from interface: Factory

Map of hints (maybe unmodifiable) used by this factory to customize its use. This map is not guaranteed to contains all the hints supplied by the user; it may be only a subset. Consequently, hints provided here are usually not suitable for creating new factories, unless the implementation make some additional garantees.

The primary purpose of this method is to determine if an existing factory instance can be reused for a set of user-supplied hints. This method is invoked by FactoryRegistry in order to compare this factory's hints against user's hints. This is dependency introspection only; FactoryRegistry never invokes this method for creating new factories.

Keys are usually static constants from the Hints class, while values are instances of some key-dependent class. The key set must contains at least all hints impacting functionality. While the key set may contains all hints supplied by the user, it is recommended to limit the set to only the hints used by this particular factory instance. A minimal set will helps FactoryRegistry to compare only hints that matter and avoid the creation of unnecessary instances of this factory.

The hint values may be different than the one supplied by the user. If a user supplied a hint as a Class object, this method shall replace it by the actual instance used, if possible.

Implementations of this method are usually quite simple. For example if a datum authority factory uses an ordinary datum factory, its method could be implemented as below (note that we should not check if the datum factory is null, since key with null value is the expected behaviour in this case). Example:

 Map hints = new HashMap();
 hints.put(Hints.DATUM_FACTORY, datumFactory);
 return hints;
 

Specified by:

getImplementationHints in interface Factory

Returns:

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