|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.geotools.data.vpf.file.VPFFileFactory
public class VPFFileFactory
A factory for VPFFileStore. The file store is a singleton and the factory acts as the container. This class does not do anything special at all and could easily be circumvented, but is here for completeness.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.geotools.data.DataAccessFactory |
---|
DataAccessFactory.Param |
Method Summary | |
---|---|
boolean |
canProcess(java.util.Map params)
Test to see if this factory is suitable for processing the data pointed to by the params map. |
DataStore |
createDataStore(java.util.Map params)
Construct a live data source using the params specifed. |
DataStore |
createNewDataStore(java.util.Map params)
|
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. |
VPFFile |
getFile(java.lang.String pathName)
|
java.util.Map |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public DataStore createDataStore(java.util.Map params) throws java.io.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, mysql
java.io.IOException
- if there were any problems setting up (creating or
connecting) the datasource.public DataStore createNewDataStore(java.util.Map params) throws java.io.IOException
createNewDataStore
in interface DataStoreFactorySpi
java.io.IOException
public java.lang.String getDisplayName()
DataAccessFactory
A non localized display name for this data store type.
getDisplayName
in interface DataAccessFactory
public java.lang.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(java.util.Map 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(java.lang.String pathName) throws java.io.IOException
java.io.IOException
public java.util.Map getImplementationHints()
getImplementationHints
in interface Factory
public void reset()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |