org.geotools.data.shapefile

Class ShapefileDataStoreFactory

Object

ShapefileDataStoreFactory

All Implemented Interfaces:

DataAccessFactory, DataStoreFactorySpi, FileDataStoreFactorySpi, Factory

Direct Known Subclasses:

ShapefileDirectoryFactory

public class ShapefileDataStoreFactory
extends Object
implements FileDataStoreFactorySpi

Builds instances of the shapefile data store

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShapefileDataStoreFactory.ShpFileStoreFactory A delegates that allow to build a directory of shapfiles store

Nested classes/interfaces inherited from interface DataAccessFactory

DataAccessFactory.Param

Field Summary

Fields

Modifier and Type	Field and Description
static DataAccessFactory.Param	CACHE_MEMORY_MAPS Optional - enable/disable the use of memory-mapped io
static DataAccessFactory.Param	CREATE_SPATIAL_INDEX Optional - Enable/disable the automatic creation of spatial index
static DataAccessFactory.Param	DBFCHARSET Optional - character used to decode strings from the DBF file.
static DataAccessFactory.Param	DBFTIMEZONE Optional - timezone to decode dates from the DBF file
static String	ENABLE_CPG_SWITCH This system property will enable "DBF charset autodetection from CPG sidecar file" feature.
static DataAccessFactory.Param	ENABLE_SPATIAL_INDEX Optional - enable spatial index for local files
static DataAccessFactory.Param	FILE_TYPE Optional - discriminator for directory stores
static DataAccessFactory.Param	FSTYPE Optional parameter used to indicate 'shape-ng' (as a marker to select the implementation of DataStore to use).
static DataAccessFactory.Param	MEMORY_MAPPED Optional - enable/disable the use of memory-mapped io
static DataAccessFactory.Param	NAMESPACEP Optional - uri of the FeatureType's namespace
static DataAccessFactory.Param	SKIP_SCAN Optional - skip the scan for alternative shapefile extensions (i.e. .SHP, .shp.XML, ...)
static DataAccessFactory.Param	URLP url to the .shp file.

Constructor Summary

Constructors

Constructor and Description
ShapefileDataStoreFactory()

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(URL f) Tests if the provided url can be handled by this factory.
DataStore	createDataStore(Map<String,?> params) Construct a live data source using the params specifed.
FileDataStore	createDataStore(URL url) A DataStore attached to the provided url, may be created if needed.
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.
String[]	getFileExtensions() The list of filename extentions handled by this factory.
Map<RenderingHints.Key,?>	getImplementationHints() Map of hints (maybe unmodifiable) used by this factory to customize its use.
DataAccessFactory.Param[]	getParametersInfo() MetaData about the required Parameters (for createDataStore).
String	getTypeName(URL url) The typeName represented by the provided url.
boolean	isAvailable() Test to see if the implementation is available for use.

Methods inherited from class Object

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

Field Detail

URLP

public static final DataAccessFactory.Param URLP

url to the .shp file.

ENABLE_CPG_SWITCH

public static final String ENABLE_CPG_SWITCH

This system property will enable "DBF charset autodetection from CPG sidecar file" feature.

See Also:

Constant Field Values

NAMESPACEP

public static final DataAccessFactory.Param NAMESPACEP

Optional - uri of the FeatureType's namespace

MEMORY_MAPPED

public static final DataAccessFactory.Param MEMORY_MAPPED

Optional - enable/disable the use of memory-mapped io

CACHE_MEMORY_MAPS

public static final DataAccessFactory.Param CACHE_MEMORY_MAPS

Optional - enable/disable the use of memory-mapped io

FILE_TYPE

public static final DataAccessFactory.Param FILE_TYPE

Optional - discriminator for directory stores

CREATE_SPATIAL_INDEX

public static final DataAccessFactory.Param CREATE_SPATIAL_INDEX

Optional - Enable/disable the automatic creation of spatial index

DBFCHARSET

public static final DataAccessFactory.Param DBFCHARSET

Optional - character used to decode strings from the DBF file. If none is provided, the factory will instruct ShapefileDataStore to try to guess a charset from CPG file, before using a default value.

See Also:

ShapefileDataStore.setTryCPGFile(boolean)

FSTYPE

public static final DataAccessFactory.Param FSTYPE

Optional parameter used to indicate 'shape-ng' (as a marker to select the implementation of DataStore to use).

DBFTIMEZONE

public static final DataAccessFactory.Param DBFTIMEZONE

Optional - timezone to decode dates from the DBF file

ENABLE_SPATIAL_INDEX

public static final DataAccessFactory.Param ENABLE_SPATIAL_INDEX

Optional - enable spatial index for local files

SKIP_SCAN

public static final DataAccessFactory.Param SKIP_SCAN

Optional - skip the scan for alternative shapefile extensions (i.e. .SHP, .shp.XML, ...)

Constructor Detail

ShapefileDataStoreFactory

public ShapefileDataStoreFactory()

Method Detail

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()

Description copied from interface: DataAccessFactory

Describe the nature of the datasource constructed by this factory.

A non localized description of this data store type.

Specified by:

getDescription in interface DataAccessFactory

Returns:

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

getParametersInfo

public DataAccessFactory.Param[] getParametersInfo()

Description copied from interface: DataAccessFactory

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 DataAccessFactory

Returns:

Param array describing the Map for createDataStore

isAvailable

public boolean isAvailable()

Description copied from interface: DataAccessFactory

Test to see if the implementation is available for use. This method ensures all the appropriate libraries to construct the DataAccess are available.

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.

Specified by:

isAvailable in interface DataAccessFactory

Returns:

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

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.

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

Specified by:

createNewDataStore in interface DataStoreFactorySpi

Throws:

IOException

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.

canProcess

public boolean canProcess(URL f)

Description copied from interface: FileDataStoreFactorySpi

Tests if the provided url can be handled by this factory.

Specified by:

canProcess in interface FileDataStoreFactorySpi

Parameters:

f - URL to a real file (may not be local)

Returns:

true if this url can when this dataStore can resolve and read the data specified

getFileExtensions

public String[] getFileExtensions()

Description copied from interface: FileDataStoreFactorySpi

The list of filename extentions handled by this factory.

Specified by:

getFileExtensions in interface FileDataStoreFactorySpi

Returns:

List of file extensions which can be read by this dataStore.

createDataStore

public FileDataStore createDataStore(URL url)
                              throws IOException

Description copied from interface: FileDataStoreFactorySpi

A DataStore attached to the provided url, may be created if needed.

Please note that additional configuration options may be available via the traditional createDataStore( Map ) method provided by the superclass.

Specified by:

createDataStore in interface FileDataStoreFactorySpi

Parameters:

url - The data location for the

Returns:

Returns an AbstractFileDataStore created from the data source provided.

Throws:

IOException

See Also:

AbstractFileDataStore

getTypeName

public String getTypeName(URL url)
                   throws IOException

Description copied from interface: FileDataStoreFactorySpi

The typeName represented by the provided url.

Specified by:

getTypeName in interface FileDataStoreFactorySpi

Parameters:

url - The location of the datum to parse into features

Returns:

Returns the typename of the datum specified (on occasion this may involve starting the parse as well to get the FeatureType -- may not be instantanious).

Throws:

IOException