org.opengis.feature

Interface FeatureStoreFactory

public interface FeatureStoreFactory

A provider of spatial information.

A provider, or service, implementing this API may range from a single shapefile, to a complete Web Feature Server or OracleSpatial instance.

This API does need to consider the:

• Identity: currently captured as a URI, completly defines a server or provider. Usually via a URI or JDBC URI as required.
• Configuration: currently captured as a Map.

Since:

GeoAPI 2.0

Method Summary

Modifier and Type	Method and Description
boolean	canProcess(java.net.URI provider) Indicates this factory communicate with the indicated provider or service.
boolean	canProcess(java.net.URI provider, java.util.Map<java.lang.String,java.lang.Object> params) Indicates this factory communicate with the indicated provider or service.
FeatureStore	createFeatureStore(java.net.URI provider, java.util.Map<java.lang.String,java.lang.Object> params) Ask for a FeatureStore connecting to the indicated provider or service.
FeatureStore	createNewFeatureStore(java.net.URI provider, java.util.Map<java.lang.String,java.lang.Object> params) Ask for a new feature store connecting to the indicated provider or service.
InternationalString	getDescription() Description of this type of factory.
InternationalString	getDisplayName() Display name used to communicate this type of factory to end users.
java.net.URI	getIcon() Icon representing this category of FeatureStores.
java.util.Map<java.lang.String,java.lang.Class>	getParametersInfo() Gets parameters needed (beyond the URI) to instantiate a FeatureStore.
boolean	isAvailable() Allows a factory to ensure all its preconditions are met, such as the presense of required libraries.

Method Detail

createFeatureStore

FeatureStore createFeatureStore(java.net.URI provider,
                                java.util.Map<java.lang.String,java.lang.Object> params)
                         throws java.io.IOException,
                                FeatureStoreException

Ask for a FeatureStore connecting to the indicated provider or service. The returned feature store may have been previously cached.

Additional hints or configuration information may be provided according to the metadata indicated by getParametersInfo(). This information often includes security information such as username and password.

Parameters:

provider - Often a URI or JDBC URI locating the service to connect to.

params - Map of hints or configuration information.

Returns:

Feature store connected to the indicated provider or service.

Throws:

java.io.IOException - if the FeatureStore cannot connect to its source.

FeatureStoreException - if there are any other problems creating the FeatureStore.

createNewFeatureStore

FeatureStore createNewFeatureStore(java.net.URI provider,
                                   java.util.Map<java.lang.String,java.lang.Object> params)
                            throws java.io.IOException,
                                   FeatureStoreException

Ask for a new feature store connecting to the indicated provider or service.

Additional hints or configuration information may be provided according to the metadata indicated by getParametersInfo(). This information often includes security information such as username and password.

Parameters:

provider - Often a URI or JDBC URI locating the service to connect to.

params - Map of hints or configuration information.

Returns:

Feature store connected to the newly created provider or service.

Throws:

java.io.IOException - if the FeatureStore cannot connect to its source.

FeatureStoreException - if there are any other problems creating the FeatureStore.

getIcon

java.net.URI getIcon()

Icon representing this category of FeatureStores.

Returns:

URI to a icon (GIF or PNG) representing this factory.

getDisplayName

InternationalString getDisplayName()

Display name used to communicate this type of factory to end users.

getDescription

InternationalString getDescription()

Description of this type of factory.

getParametersInfo

java.util.Map<java.lang.String,java.lang.Class> getParametersInfo()

Gets parameters needed (beyond the URI) to instantiate a FeatureStore.

canProcess

boolean canProcess(java.net.URI provider)

Indicates this factory communicate with the indicated provider or service.

This method should not fail, if a connection needs to be made to parse a GetCapabilities file or negotiate WMS versions any IO problems simply indicate the inabiity to process.

This method may be considered the same as: canProcess(provider, hints) where hints was generated by using all the default values specified by the getParametersInfo() method.

Parameters:

provider - Provider or Server of spatial information.

Returns:

true if this factory can communicate with the provider.

canProcess

boolean canProcess(java.net.URI provider,
                   java.util.Map<java.lang.String,java.lang.Object> params)

Indicates this factory communicate with the indicated provider or service.

This method differs from canProcess(URI) in that additional configuration information may be supplied.

Parameters:

provider - Provider or Server of spatial information.

params - additional configuration information.

Returns:

true if this factory can communicate with the provider.

isAvailable

boolean isAvailable()

Allows a factory to ensure all its preconditions are met, such as the presense of required libraries.

Returns:

true if available