|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectAppSchemaDataAccessFactory
public class AppSchemaDataAccessFactory
DataStoreFactory for ComplexDataStore. NOTE: currently this one is not registered through the geotools datastore plugin mechanism. Instead, we're directly using DataAccessFactory
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface DataAccessFactory |
---|
DataAccessFactory.Param |
Field Summary | |
---|---|
static DataAccessFactory.Param |
DBTYPE
|
static String |
DBTYPE_STRING
|
static DataAccessFactory.Param |
URL
|
Constructor Summary | |
---|---|
AppSchemaDataAccessFactory()
|
Method Summary | |
---|---|
boolean |
canProcess(Map params)
Test to see if this factory is suitable for processing the data pointed to by the params map. |
DataAccess<FeatureType,Feature> |
createDataStore(Map params)
Construct a live DataAccess using the connection parameters provided. |
DataStore |
createNewDataStore(Map params)
|
String |
getDescription()
Describe the nature of the datasource constructed by this factory. |
String |
getDisplayName()
Name suitable for display to end user. |
Map |
getImplementationHints()
Map of hints (maybe unmodifiable) used by this factory to customize its use. |
DataAccessFactory.Param[] |
getParametersInfo()
MetaData about the required Parameters (for createDataStore). |
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 |
---|
public static final String DBTYPE_STRING
public static final DataAccessFactory.Param DBTYPE
public static final DataAccessFactory.Param URL
Constructor Detail |
---|
public AppSchemaDataAccessFactory()
Method Detail |
---|
public DataAccess<FeatureType,Feature> createDataStore(Map params) throws IOException
DataAccessFactory
You can think of this class as setting up a connection to the back end data source. The required parameters are described by the getParameterInfo() method.
Magic Params: the following params are magic and are honoured by convention by the GeoServer and uDig application.
createDataStore
in interface DataAccessFactory
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
IOException
- if there were any problems setting up (creating or
connecting) the datasource.public DataStore createNewDataStore(Map params) throws IOException
IOException
public String getDisplayName()
DataAccessFactory
A non localized display name for this data store type.
getDisplayName
in interface DataAccessFactory
public 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(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 Map getImplementationHints()
Factory
FactoryUsingVolatileDependencies
).
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;
getImplementationHints
in interface Factory
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |