| org.geotools.data.DataStoreFactorySpi
All known Subclasses: org.geotools.data.geometryless.LocationsXYDataStoreFactory, org.geotools.data.geometryless.BBOXDataStoreFactory, org.geotools.data.sql.SqlDataStoreFactory, org.geotools.data.oracle.OracleOCIDataStoreFactory, org.geotools.data.vpf.VPFDataStoreFactory, org.geotools.arcsde.ArcSDEDataStoreFactory, org.geotools.data.dir.DirectoryDataStoreFactory, org.geotools.data.geomedia.GeoMediaDataStoreFactory, org.geotools.data.complex.ComplexDataStoreFactory, org.geotools.data.hsql.HsqlDataStoreFactory, org.geotools.data.db2.DB2DataStoreFactory, org.geotools.data.tiger.TigerDataStoreFactory, org.geotools.data.AbstractDataStoreFactory, org.geotools.data.vpf.file.VPFFileFactory, org.geotools.data.oracle.OracleDataStoreFactory, org.geotools.data.postgis.PostgisDataStoreFactory, org.geotools.data.property.PropertyDataStoreFactory, org.geotools.data.mif.MIFDataStoreFactory, org.geotools.data.ogr.OGRDataStoreFactory, org.geotools.data.gml.GMLDataStoreFactory, org.geotools.data.geometryless.JDBCDataStoreFactory,
| DataStoreFactorySpi | | public interface DataStoreFactorySpi extends Factory(Code) | | Constructs a live DataStore from a set of parameters.
An instance of this interface should exist for all data stores which want to
take advantage of the dynamic plugin system. In addition to implementing
this interface datastores should have a services file:
META-INF/services/org.geotools.data.DataStoreFactorySpi
The file should contain a single line which gives the full name of the
implementing class.
example:
e.g.
org.geotools.data.mytype.MyTypeDataSourceFacotry
The factories are never called directly by client code, instead the
DataStoreFinder class is used.
The following example shows how a user might connect to a PostGIS database,
and maintain the resulting datastore in a registry:
HashMap params = new HashMap();
params.put("namespace", "leeds");
params.put("dbtype", "postgis");
params.put("host","feathers.leeds.ac.uk");
params.put("port", "5432");
params.put("database","postgis_test");
params.put("user","postgis_ro");
params.put("passwd","postgis_ro");
DefaultRegistry registry = new DefaultRegistry();
registry.addDataStore("leeds", params);
DataStore postgis = registry.getDataStore( "leeds" );
FeatureSource = postgis.getFeatureSource( "table" );
-
Jody - can we please get something better then Param to describe what is
allowed?
Jody - ISO19119 has something that looks okay, WSDL/SOAP could be used?
-
Jody - can we seperate out Identification of a Service from configration of
the service?
Jody - this is mostly a problem when managing user supplied configurations
in GeoServer and uDig.
Jody - the "Catalog API" has now been ported and contains a URI as
indentification, while still allowing configuration using a Map of
parameters
author:
Jody Garnett, Refractions Research |
| 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.
If this datasource requires a number of parameters then this mehtod
should check that they are all present and that they are all valid. | | DataStore | createDataStore(Map params)
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.
Parameters:
params - The full set of information needed to construct a livedata store. | | 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. | | 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. |
| canProcess | | boolean canProcess(java.util.Map params)(Code) | | 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.
Parameters:
params - The full set of information needed to construct a livedata source. booean true if and only if this factory can process the resourceindicated by the param set and all the required params arepressent. |
| createDataStore | | DataStore createDataStore(Map params) throws IOException(Code) | | 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.
Parameters:
params - The full set of information needed to construct a livedata 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 The created DataStore, this may be null if the required resourcewas not found or if insufficent parameters were given. Notethat canProcess() should have returned false if the problem isto do with insuficent parameters.
throws:
IOException - if there were any problems setting up (creating orconnecting) the datasource. |
| getDescription | | String getDescription()(Code) | | Describe the nature of the datasource constructed by this factory.
A non localized description of this data store type.
A human readable description that is suitable for inclusion in alist of available datasources. |
| getDisplayName | | String getDisplayName()(Code) | | Name suitable for display to end user.
A non localized display name for this data store type.
A short name suitable for display in a user interface. |
| getParametersInfo | | Param[] getParametersInfo()(Code) | | 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();
Param array describing the Map for createDataStore |
| isAvailable | | boolean isAvailable()(Code) | | 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.
true if and only if this factory has all theappropriate jars on the classpath to create DataStores. |
|
|