public class VPFFileFactory extends Object implements DataStoreFactorySpi
DataAccessFactory.Param
Modifier and Type | Field and Description |
---|---|
static DataAccessFactory.Param |
FILE_PARAM
Parameter description of information required to connect
|
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.
|
DataStore |
createDataStore(Map<String,?> params)
Construct a live data source using the params specifed.
|
DataStore |
createNewDataStore(Map<String,?> params) |
String |
getDescription()
Describe the nature of the datasource constructed by this factory.
|
String |
getDisplayName()
Name suitable for display to end user.
|
VPFFile |
getFile(String pathName) |
Map<RenderingHints.Key,?> |
getImplementationHints()
Returns the implementation hints.
|
static VPFFileFactory |
getInstance()
Returns the singleton instance
|
DataAccessFactory.Param[] |
getParametersInfo()
MetaData about the required Parameters (for createDataStore).
|
boolean |
isAvailable()
Test to see if the implementation is available for use.
|
void |
reset()
Close all currently open files.
|
public static final DataAccessFactory.Param FILE_PARAM
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()
DataAccessFactory
A non localized description of this data store type.
getDescription
in interface DataAccessFactory
public DataAccessFactory.Param[] getParametersInfo()
DataAccessFactory
Interpretation of FeatureDescriptor values:
This should be the same as:
Object params = factory.getParameters();
BeanInfo info = getBeanInfo( params );
return info.getPropertyDescriptors();
getParametersInfo
in interface DataAccessFactory
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 boolean isAvailable()
DataAccessFactory
Most factories will simply return true
as GeoTools will distribute the
appropriate libraries. Though it's not a bad idea for DataStoreFactories to check to make
sure that the libraries are there.
OracleDataStoreFactory is an example of one that may generally return false
,
since GeoTools can not distribute the oracle jars. (they must be added by the client.)
One may ask how this is different than canProcess, and basically available is used by the DataStoreFinder getAvailableDataStore method, so that DataStores that can not even be used do not show up as options in gui applications.
isAvailable
in interface DataAccessFactory
public static VPFFileFactory getInstance()
public VPFFile getFile(String pathName) throws IOException
IOException
public Map<RenderingHints.Key,?> getImplementationHints()
getImplementationHints
in interface Factory
public void reset()
Copyright © 1996–2021 Geotools. All rights reserved.