Package org.geotools.data.property
Class PropertyDataStoreFactory
- Object
-
- PropertyDataStoreFactory
-
- All Implemented Interfaces:
DataAccessFactory
,DataStoreFactorySpi
,Factory
public class PropertyDataStoreFactory extends Object implements DataStoreFactorySpi
DataStore factory that creates PropertyDataStores- Author:
- Jody Garnett, Torben Barsballe (Boundless)
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface DataAccessFactory
DataAccessFactory.Param
-
-
Field Summary
Fields Modifier and Type Field Description static DataAccessFactory.Param
DIRECTORY
static DataAccessFactory.Param
NAMESPACE
-
Constructor Summary
Constructors Constructor Description PropertyDataStoreFactory()
Public "no argument" constructor called by Factory Service Provider (SPI) entry listed in META-INF/services/org.geotools.data.DataStoreFactorySPI
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canProcess(Map<String,?> params)
Works for a file directory or property fileDataStore
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.Map<RenderingHints.Key,?>
getImplementationHints()
No implementation hints are provided at this time.DataAccessFactory.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.
-
-
-
Field Detail
-
DIRECTORY
public static final DataAccessFactory.Param DIRECTORY
-
NAMESPACE
public static final DataAccessFactory.Param NAMESPACE
-
-
Method Detail
-
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.
- 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
-
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
- See Also:
DIRECTORY
,NAMESPACE
-
isAvailable
public boolean isAvailable()
Test to see if this datastore is available, if it has all the appropriate libraries to construct a datastore. This datastore just returns true for now. This method is used for gui apps, so as to not advertise data store capabilities they don't actually have.- Specified by:
isAvailable
in interfaceDataAccessFactory
- Returns:
- true if and only if this factory is available to create DataStores.
- TODO:
true
property datastore is always available
-
canProcess
public boolean canProcess(Map<String,?> params)
Works for a file directory or property file- Specified by:
canProcess
in interfaceDataAccessFactory
- Parameters:
params
- Connection parameters- Returns:
- true for connection parameters indicating a directory or property file
-
getImplementationHints
public Map<RenderingHints.Key,?> getImplementationHints()
No implementation hints are provided at this time.- Specified by:
getImplementationHints
in interfaceFactory
- Returns:
- The map of hints, or an {@linkplain java.util.Collections.emptyMap() empty map} if none.
-
-