Class CSVDataStoreFactory
- Object
-
- CSVDataStoreFactory
-
- All Implemented Interfaces:
DataAccessFactory
,DataStoreFactorySpi
,FileDataStoreFactorySpi
,Factory
public class CSVDataStoreFactory extends Object implements FileDataStoreFactorySpi
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface DataAccessFactory
DataAccessFactory.Param
-
-
Field Summary
Fields Modifier and Type Field Description static String
ATTRIBUTES_ONLY_STRATEGY
ATTRIBUTES_ONLY_STRATEGYstatic DataAccessFactory.Param
ESCAPECHAR
static String[]
EXTENSIONS
static DataAccessFactory.Param
FILE_PARAM
static String
GUESS_STRATEGY
GUESS_STRATEGYstatic DataAccessFactory.Param
LATFIELDP
static DataAccessFactory.Param
LINESEPSTRING
static DataAccessFactory.Param
LnGFIELDP
static DataAccessFactory.Param
NAMESPACEP
static DataAccessFactory.Param[]
parametersInfo
static DataAccessFactory.Param
QUOTEALL
static DataAccessFactory.Param
QUOTECHAR
static DataAccessFactory.Param
SEPERATORCHAR
static String
SPECIFC_STRATEGY
SPECIFC_STRATEGYstatic DataAccessFactory.Param
STRATEGYP
static DataAccessFactory.Param
URL_PARAM
static String
WKT_STRATEGY
WKT_STRATEGYstatic DataAccessFactory.Param
WKTP
static DataAccessFactory.Param
WRITEPRJ
-
Constructor Summary
Constructors Constructor Description CSVDataStoreFactory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canProcess(URL url)
Tests if the provided url can be handled by this factory.boolean
canProcess(Map<String,?> params)
Test to see if this factory is suitable for processing the data pointed to by the params map.FileDataStore
createDataStore(URL url)
A DataStore attached to the provided url, may be created if needed.FileDataStore
createDataStore(Map<String,?> params)
Construct a live data source using the params specifed.FileDataStore
createDataStoreFromFile(File file)
FileDataStore
createDataStoreFromFile(File file, URI namespace)
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.
-
-
-
Field Detail
-
GUESS_STRATEGY
public static final String GUESS_STRATEGY
GUESS_STRATEGY- See Also:
- Constant Field Values
-
ATTRIBUTES_ONLY_STRATEGY
public static final String ATTRIBUTES_ONLY_STRATEGY
ATTRIBUTES_ONLY_STRATEGY- See Also:
- Constant Field Values
-
SPECIFC_STRATEGY
public static final String SPECIFC_STRATEGY
SPECIFC_STRATEGY- See Also:
- Constant Field Values
-
WKT_STRATEGY
public static final String WKT_STRATEGY
WKT_STRATEGY- See Also:
- Constant Field Values
-
EXTENSIONS
public static final String[] EXTENSIONS
-
FILE_PARAM
public static final DataAccessFactory.Param FILE_PARAM
-
URL_PARAM
public static final DataAccessFactory.Param URL_PARAM
-
NAMESPACEP
public static final DataAccessFactory.Param NAMESPACEP
-
STRATEGYP
public static final DataAccessFactory.Param STRATEGYP
-
LATFIELDP
public static final DataAccessFactory.Param LATFIELDP
-
LnGFIELDP
public static final DataAccessFactory.Param LnGFIELDP
-
WKTP
public static final DataAccessFactory.Param WKTP
-
QUOTEALL
public static final DataAccessFactory.Param QUOTEALL
-
QUOTECHAR
public static final DataAccessFactory.Param QUOTECHAR
-
SEPERATORCHAR
public static final DataAccessFactory.Param SEPERATORCHAR
-
LINESEPSTRING
public static final DataAccessFactory.Param LINESEPSTRING
-
ESCAPECHAR
public static final DataAccessFactory.Param ESCAPECHAR
-
WRITEPRJ
public static final DataAccessFactory.Param WRITEPRJ
-
parametersInfo
public static final DataAccessFactory.Param[] parametersInfo
-
-
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 interfaceDataAccessFactory
- 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 interfaceDataAccessFactory
- 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 interfaceDataAccessFactory
- Returns:
- Param array describing the Map for createDataStore
-
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 interfaceDataAccessFactory
- 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: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 interfaceDataAccessFactory
- 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 helpsFactoryRegistry
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 interfaceFactory
- Returns:
- The map of hints, or an {@linkplain java.util.Collections.emptyMap() empty map} if none.
-
createDataStoreFromFile
public FileDataStore createDataStoreFromFile(File file) throws IOException
- Throws:
IOException
-
createDataStoreFromFile
public FileDataStore createDataStoreFromFile(File file, URI namespace) throws IOException
- Throws:
IOException
-
createDataStore
public FileDataStore 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.
- Specified by:
createDataStore
in interfaceDataAccessFactory
- Specified by:
createDataStore
in interfaceDataStoreFactorySpi
- 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 interfaceDataStoreFactorySpi
- Throws:
IOException
-
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 interfaceFileDataStoreFactorySpi
- Parameters:
url
- The data location for the- Returns:
- Returns an AbstractFileDataStore created from the data source provided.
- Throws:
IOException
- See Also:
AbstractFileDataStore
-
getFileExtensions
public String[] getFileExtensions()
Description copied from interface:FileDataStoreFactorySpi
The list of filename extentions handled by this factory.- Specified by:
getFileExtensions
in interfaceFileDataStoreFactorySpi
- Returns:
- List of file extensions which can be read by this dataStore.
-
canProcess
public boolean canProcess(URL url)
Description copied from interface:FileDataStoreFactorySpi
Tests if the provided url can be handled by this factory.- Specified by:
canProcess
in interfaceFileDataStoreFactorySpi
- Parameters:
url
- 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
-
getTypeName
public String getTypeName(URL url) throws IOException
Description copied from interface:FileDataStoreFactorySpi
The typeName represented by the provided url.- Specified by:
getTypeName
in interfaceFileDataStoreFactorySpi
- 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
-
-