| org.geotools.data.DataAccessFactory
All known Subclasses: org.geotools.data.feature.adapter.FeatureAccessFactoryAdapter, org.geotools.data.complex.ComplexDataAccessFactory,
| DataAccessFactory | | public interface DataAccessFactory extends Factory(Code) | | Constructs a live DataAccess connection from a set of parameters.
Parameters are specified using a Java Bean; the DataAccesFinder utility class will take care of
allowing you to work with Map as a transfer object of bean properties.
author:
Jody Garnett
author:
Thomas Marti
author:
Stefan Schmid
version:
$Id: DataAccessFactory.java 26609 2007-08-20 15:29:33Z groldan $ |
| Method Summary | |
| boolean | canAccess(Object connectionPrametersBean)
Test to see if this factory is suitable for processing this connectionParamsBean.
This method is often an instanceof check followed by ensuring required
bean properties (i.e. | | boolean | canCreateContent(Object bean)
| | DataAccess | createAccess(Object bean)
| | Object | createAccessBean()
A java bean (with default properties values) describing connection parameters. | | DataAccess | createContent(Object bean)
Set up a new physical storage location, and supply a DataAccess class
for interaction. | | Object | createContentBean()
Please note that creating a new physical storage location
may require additional parameters beyond that needed for
simple connection. | | public InternationalString | getName()
Display name for this DataAccess in the current locale. | | public boolean | isAvailable()
Test to ensure the correct environment is available for this Factory to function. |
| canAccess | | boolean canAccess(Object connectionPrametersBean)(Code) | | Test to see if this factory is suitable for processing this connectionParamsBean.
This method is often an instanceof check followed by ensuring required
bean properties (i.e. connection parameters) are not null.
Parameters:
connectionPrametersBean - true, if bean has valid parameters to attempt a connection |
| canCreateContent | | boolean canCreateContent(Object bean)(Code) | | Confirm that this factory is suitable for creating the physical storage
location described by the provided bean.
Implementations may also chose to check security concerns (such as the ability
to write to disk) as part of this method.
Parameters:
bean - Bean capturing connection/creation parameters, should be of the sametype as provided by DataAccessFactory.createContentBean() true, if bean has valid parameters to attempt a connection |
| createAccess | | DataAccess createAccess(Object bean) throws IOException(Code) | | Connect to a physical data storage location and provide DataAccess class for
interaction.
A new DataAccess class is created on each call; end-users should either store
this instance as a Singleton (gasp!) or make use of the GeoTools catalog facilities to manage
connections.
Parameters:
bean - Bean capturing connection parameters, should be of the same type as provided bycreateConnectionBean The created DataAccess instance
throws:
IOException - If there were any problems setting up the connection |
| createAccessBean | | Object createAccessBean()(Code) | | A java bean (with default properties values) describing connection parameters.
Java Bean describing parameters required for data access |
| createContent | | DataAccess createContent(Object bean)(Code) | | Set up a new physical storage location, and supply a DataAccess class
for interaction.
Parameters:
bean - Bean capturing connection/creation parameters, should be of the sametype as provided by DataAccessFactory.createContentBean() The created DataAccess instance |
| createContentBean | | Object createContentBean()(Code) | | Please note that creating a new physical storage location
may require additional parameters beyond that needed for
simple connection.
Java Bean describing parameters required for creation |
| getName | | public InternationalString getName()(Code) | | Display name for this DataAccess in the current locale.
human readable display name |
| isAvailable | | public boolean isAvailable()(Code) | | Test to ensure the correct environment is available for this Factory to function.
Implementations usually check such things as availablity of required JDBC drivers,
or Java Advanced Imaging formats that they intend to use.
true, if needed environment is found |
|
|