org.geotools.data.vpf.file
Class VPFFileFactory

java.lang.Object
  org.geotools.data.vpf.file.VPFFileFactory

All Implemented Interfaces:

DataStoreFactorySpi, Factory

public class VPFFileFactory

extends java.lang.Object

implements DataStoreFactorySpi

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.

Author:

jeff yutzler

Nested Class Summary

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

DataStoreFactorySpi.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
DataStoreFactorySpi.Param[]	getParametersInfo() MetaData about the required Parameters (for createDataStore).
boolean	isAvailable() Test to see if this datastore is available, if it has all the appropriate libraries to construct a datastore.
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

createDataStore

public DataStore createDataStore(java.util.Map params)
                          throws java.io.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 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:

java.io.IOException

createNewDataStore

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

Specified by:

createNewDataStore in interface DataStoreFactorySpi

Throws:

java.io.IOException

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:

A short name suitable for display in a user interface.

getDescription

public java.lang.String getDescription()

Description copied from interface: DataStoreFactorySpi

Describe the nature of the datasource constructed by this factory.

A non localized description of this data store type.

Specified by:

getDescription in interface DataStoreFactorySpi

Returns:

A human readable description that is suitable for inclusion in a list of available datasources.

getParametersInfo

public DataStoreFactorySpi.Param[] getParametersInfo()

Description copied from interface: DataStoreFactorySpi

MetaData about the required Parameters (for createDataStore).

Interpretation of FeatureDescriptor values:

• getDisplayName(): Gets the localized display name of this feature.
• getName(): Gets the programmatic name of this feature (used as the key in params)
• getShortDescription(): Gets the short description of this feature.

This should be the same as:

 Object params = factory.getParameters();
 BeanInfo info = getBeanInfo( params );
 
 return info.getPropertyDescriptors();
 

Specified by:

getParametersInfo in interface DataStoreFactorySpi

Returns:

Param array describing the Map for createDataStore

canProcess

public boolean canProcess(java.util.Map params)

Description copied from interface: DataStoreFactorySpi

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 DataStoreFactorySpi

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.

isAvailable

public boolean isAvailable()

Description copied from interface: DataStoreFactorySpi

Test to see if this datastore is available, if it has all the appropriate libraries to construct a datastore. Most datastores should return true, because 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.

Specified by:

isAvailable in interface DataStoreFactorySpi

Returns:

true if and only if this factory has all the appropriate jars on the classpath to create DataStores.

getInstance

public static VPFFileFactory getInstance()

Returns the singleton instance

Returns:

Returns the instance.

getFile

public VPFFile getFile(java.lang.String pathName)
                throws java.io.IOException

Throws:

java.io.IOException

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.

reset

public void reset()

Close all currently open files.