public class WFSDataAccessFactory extends Object implements DataAccessFactory
Modifier and Type | Class and Description |
---|---|
static class |
WFSDataAccessFactory.WFSFactoryParam<T>
A
DataAccessFactory.Param subclass that allows us to provide a default value to the lookUp method. |
DataAccessFactory.Param
Modifier and Type | Field and Description |
---|---|
static WFSDataAccessFactory.WFSFactoryParam<String> |
AXIS_ORDER
Optional
String DataStore parameter indicating axis order used by the
remote WFS server in result coordinates. |
static String |
AXIS_ORDER_COMPLIANT |
static String |
AXIS_ORDER_EAST_NORTH
Values for the AXIS_ORDER and AXIS_ORDER_FILTER connection parameters.
|
static WFSDataAccessFactory.WFSFactoryParam<String> |
AXIS_ORDER_FILTER |
static String |
AXIS_ORDER_NORTH_EAST |
static WFSDataAccessFactory.WFSFactoryParam<Integer> |
BUFFER_SIZE
Optional
Integer parameter stating how many Feature instances to buffer at once. |
static WFSDataAccessFactory.WFSFactoryParam<String> |
ENCODING
Optional
String DataStore parameter supplying a JVM supported charset
name to use as the character encoding for XML requests sent to the server. |
static WFSDataAccessFactory.WFSFactoryParam<EntityResolver> |
ENTITY_RESOLVER
Optional
EntityResolver used to expand XML entities during parses |
static WFSDataAccessFactory.WFSFactoryParam<Integer> |
FILTER_COMPLIANCE
Optional
Integer DataStore parameter indicating level of compliance to WFS
specification
XMLHandlerHints.VALUE_FILTER_COMPLIANCE_LOW
XMLHandlerHints.VALUE_FILTER_COMPLIANCE_MEDIUM
XMLHandlerHints.VALUE_FILTER_COMPLIANCE_HIGH
|
static WFSDataAccessFactory.WFSFactoryParam<Boolean> |
GML_COMPATIBLE_TYPENAMES
Optional
Integer OCG GML compliance level. i.e. |
static WFSDataAccessFactory.WFSFactoryParam<Integer> |
GML_COMPLIANCE_LEVEL
Optional
Integer OCG GML compliance level. i.e. |
static WFSDataAccessFactory.WFSFactoryParam<Boolean> |
LENIENT
Optional
Boolean DataStore parameter indicating whether to be lenient about parsing
bad data |
static WFSDataAccessFactory.WFSFactoryParam<Integer> |
MAXFEATURES
Optional positive
Integer used as a hard limit for the amount of Features to retrieve
for each FeatureType. |
static WFSDataAccessFactory.WFSFactoryParam<String> |
NAMESPACE
Optional
String namespace URI to override the originial namespaces |
static WFSDataAccessFactory.WFSFactoryParam<String> |
OUTPUTFORMAT |
static WFSDataAccessFactory.WFSFactoryParam<String> |
PASSWORD
Optional
String DataStore parameter supplying the password to use when the server
requires HTTP authentication
Shall be used together with USERNAME or not used at all. |
static WFSDataAccessFactory.WFSFactoryParam<Boolean> |
PROTOCOL
Optional
Boolean DataStore parameter acting as a hint for the HTTP protocol to use
preferably against the WFS instance, with the following semantics:
null (not supplied): use "AUTO", let the DataStore decide. |
static WFSDataAccessFactory.WFSFactoryParam<Integer> |
TIMEOUT
Optional
Integer DataStore parameter indicating a timeout in milliseconds for the
HTTP connections. |
static WFSDataAccessFactory.WFSFactoryParam<Boolean> |
TRY_GZIP
Optional
Boolean data store parameter indicating whether to set the accept GZip
encoding on the HTTP request headers sent to the server |
static WFSDataAccessFactory.WFSFactoryParam<URL> |
URL
Mandatory DataStore parameter indicating the URL for the WFS GetCapabilities document.
|
static WFSDataAccessFactory.WFSFactoryParam<Boolean> |
USEDEFAULTSRS
Optional
String Flag to disable usage of OtherSRS in requests and
always use DefaultSRS (eventually reprojecting locally the results) |
static WFSDataAccessFactory.WFSFactoryParam<String> |
USERNAME
Optional
String DataStore parameter supplying the user name to use when the server
requires HTTP authentication
Shall be used together with PASSWORD or not used at all. |
static WFSDataAccessFactory.WFSFactoryParam<String> |
WFS_STRATEGY
Optional
String DataStore parameter indicating either "mapserver", "geoserver",
"strict", "nonstrict", "ionic", "cubwerx" or "arcgis" strategy |
Constructor and Description |
---|
WFSDataAccessFactory() |
Modifier and Type | Method and Description |
---|---|
boolean |
canProcess(Map params)
Checks whether
params contains a valid set of parameters to
connect to a WFS. |
protected boolean |
canProcess(Map params,
int maximumGmlComplianceLevel) |
DataAccess<? extends FeatureType,? extends Feature> |
createDataStore(Map<String,Serializable> params)
Construct a live DataAccess using the connection parameters provided.
|
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()
Map of hints (maybe unmodifiable)
used by this factory to customize its use.
|
DataAccessFactory.Param[] |
getParametersInfo()
Returns the set of parameter descriptors needed to connect to a WFS.
|
protected WFSClient |
getWFSClient(Map<String,Serializable> params) |
boolean |
isAvailable()
Test to see if the implementation is available for use.
|
public static final String AXIS_ORDER_EAST_NORTH
public static final String AXIS_ORDER_NORTH_EAST
public static final String AXIS_ORDER_COMPLIANT
public static final WFSDataAccessFactory.WFSFactoryParam<URL> URL
public static final WFSDataAccessFactory.WFSFactoryParam<Boolean> PROTOCOL
Boolean
DataStore parameter acting as a hint for the HTTP protocol to use
preferably against the WFS instance, with the following semantics:
null
(not supplied): use "AUTO", let the DataStore decide.
Boolean.TRUE
use HTTP POST preferably.
public static final WFSDataAccessFactory.WFSFactoryParam<String> USERNAME
String
DataStore parameter supplying the user name to use when the server
requires HTTP authentication
Shall be used together with PASSWORD
or not used at all.
Authenticator
public static final WFSDataAccessFactory.WFSFactoryParam<String> PASSWORD
String
DataStore parameter supplying the password to use when the server
requires HTTP authentication
Shall be used together with USERNAME
or not used at all.
Authenticator
public static final WFSDataAccessFactory.WFSFactoryParam<String> ENCODING
String
DataStore parameter supplying a JVM supported charset
name to use as the character encoding for XML requests sent to the server.public static final WFSDataAccessFactory.WFSFactoryParam<Integer> TIMEOUT
Integer
DataStore parameter indicating a timeout in milliseconds for the
HTTP connections. <>p>public static final WFSDataAccessFactory.WFSFactoryParam<Integer> BUFFER_SIZE
Integer
parameter stating how many Feature instances to buffer at once. Only
implemented for WFS 1.0.0 support.public static final WFSDataAccessFactory.WFSFactoryParam<Boolean> TRY_GZIP
Boolean
data store parameter indicating whether to set the accept GZip
encoding on the HTTP request headers sent to the serverpublic static final WFSDataAccessFactory.WFSFactoryParam<Boolean> LENIENT
Boolean
DataStore parameter indicating whether to be lenient about parsing
bad datapublic static final WFSDataAccessFactory.WFSFactoryParam<Integer> MAXFEATURES
Integer
used as a hard limit for the amount of Features to retrieve
for each FeatureType. A value of zero or not providing this parameter means no limit.public static final WFSDataAccessFactory.WFSFactoryParam<Integer> FILTER_COMPLIANCE
Integer
DataStore parameter indicating level of compliance to WFS
specification
public static final WFSDataAccessFactory.WFSFactoryParam<String> WFS_STRATEGY
String
DataStore parameter indicating either "mapserver", "geoserver",
"strict", "nonstrict", "ionic", "cubwerx" or "arcgis" strategypublic static final WFSDataAccessFactory.WFSFactoryParam<String> NAMESPACE
String
namespace URI to override the originial namespacespublic static final WFSDataAccessFactory.WFSFactoryParam<Boolean> USEDEFAULTSRS
String
Flag to disable usage of OtherSRS in requests and
always use DefaultSRS (eventually reprojecting locally the results)public static final WFSDataAccessFactory.WFSFactoryParam<String> AXIS_ORDER
String
DataStore parameter indicating axis order used by the
remote WFS server in result coordinates.public static final WFSDataAccessFactory.WFSFactoryParam<String> AXIS_ORDER_FILTER
public static final WFSDataAccessFactory.WFSFactoryParam<String> OUTPUTFORMAT
public static final WFSDataAccessFactory.WFSFactoryParam<Integer> GML_COMPLIANCE_LEVEL
Integer
OCG GML compliance level. i.e. (simple feature) 0, 1 or 2public static final WFSDataAccessFactory.WFSFactoryParam<Boolean> GML_COMPATIBLE_TYPENAMES
Integer
OCG GML compliance level. i.e. (simple feature) 0, 1 or 2public static final WFSDataAccessFactory.WFSFactoryParam<EntityResolver> ENTITY_RESOLVER
EntityResolver
used to expand XML entities during parsespublic boolean canProcess(Map params)
params
contains a valid set of parameters to
connect to a WFS.
Rules are:
canProcess
in interface DataAccessFactory
params
- The full set of information needed to construct a live
data source.protected boolean canProcess(Map params, int maximumGmlComplianceLevel)
public DataAccess<? extends FeatureType,? extends Feature> createDataStore(Map<String,Serializable> 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, mysqlIOException
- if there were any problems setting up (creating or
connecting) the datasource.public String getDescription()
DataAccessFactory
A non localized description of this data store type.
getDescription
in interface DataAccessFactory
public DataAccessFactory.Param[] getParametersInfo()
getParametersInfo
in interface DataAccessFactory
DataAccessFactory.getParametersInfo()
,
URL
,
NAMESPACE
,
PROTOCOL
,
USERNAME
,
PASSWORD
,
TIMEOUT
,
BUFFER_SIZE
,
TRY_GZIP
,
LENIENT
,
ENCODING
,
FILTER_COMPLIANCE
,
MAXFEATURES
,
WFS_STRATEGY
protected WFSClient getWFSClient(Map<String,Serializable> params) throws IOException
IOException
public Map<RenderingHints.Key,?> 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
public String getDisplayName()
DataAccessFactory
A non localized display name for this data store type.
getDisplayName
in interface DataAccessFactory
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
Copyright © 1996–2018 Geotools. All rights reserved.