public abstract class OGRDataStoreFactory extends Object implements DataStoreFactorySpi
DataAccessFactory.Param
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 and Description |
---|
OGRDataStoreFactory() |
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.
|
protected static Logger LOGGER
public static final DataAccessFactory.Param OGR_NAME
public static final DataAccessFactory.Param OGR_DRIVER_NAME
public static final DataAccessFactory.Param NAMESPACEP
protected static final Integer DEFAULT_MAXCONN
public static final DataAccessFactory.Param MAXCONN
protected static final Integer DEFAULT_MINCONN
public static final DataAccessFactory.Param MINCONN
protected static final int DEFAULT_MAXWAIT
public static final DataAccessFactory.Param MAXWAIT
protected static final int DEFAULT_EVICTABLE_TIME
public static final DataAccessFactory.Param MIN_EVICTABLE_TIME
public static final int DEFAULT_EVICTOR_TESTS_PER_RUN
public static final DataAccessFactory.Param EVICTOR_TESTS_PER_RUN
public static final boolean DEFAULT_PRIME_DATASOURCE
public static final DataAccessFactory.Param PRIME_DATASOURCE
protected abstract OGR createOGR()
public boolean canProcess(Map<String,?> params)
DataAccessFactory
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.
canProcess
in interface DataAccessFactory
params
- The full set of information needed to construct a live data source.public DataStore createDataStore(Map<String,?> params) throws IOException
DataStoreFactorySpi
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.
createDataStore
in interface DataAccessFactory
createDataStore
in interface DataStoreFactorySpi
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, mysqlIOException
- if there were any problems setting up (creating or connecting) the
datasource.public DataStore createNewDataStore(Map<String,?> params) throws IOException
createNewDataStore
in interface DataStoreFactorySpi
IOException
public String getDisplayName()
DataAccessFactory
A non localized display name for this data store type.
getDisplayName
in interface DataAccessFactory
public String getDescription()
getDescription
in interface DataAccessFactory
public final boolean isAvailable()
isAvailable
in interface DataAccessFactory
public final boolean isAvailable(boolean handleError)
Specifying true for handleError will cause any exceptions to be caught and logged, and return false
protected abstract boolean doIsAvailable() throws Throwable
Implementations of this method should not attempt to handle any fatal exceptions.
Throwable
public DataAccessFactory.Param[] getParametersInfo()
getParametersInfo
in interface DataAccessFactory
DataAccessFactory.getParametersInfo()
public boolean canProcess(String ogrName, String driverName)
public Map<RenderingHints.Key,?> getImplementationHints()
Factory
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;
getImplementationHints
in interface Factory
Copyright © 1996–2022 Geotools. All rights reserved.