org.gvsig.fmap.dal.store.wfs

Class WFSStoreProvider

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

org.gvsig.fmap.dal.spi.AbstractDataStoreProvider

org.gvsig.fmap.dal.feature.spi.AbstractFeatureStoreProvider

org.gvsig.fmap.dal.store.wfs.WFSStoreProvider

All Implemented Interfaces:

DataFactoryUnit, DataStoreProvider, FeatureStoreProvider, FeatureStoreProvider_v2, Disposable, DynObject, DynObject_v2

public class WFSStoreProvider
extends AbstractFeatureStoreProvider

Nested Class Summary

Nested classes/interfaces inherited from class org.gvsig.fmap.dal.feature.spi.AbstractFeatureStoreProvider

AbstractFeatureStoreProvider.FeatureProviderNotFoundException

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DESCRIPTION
static java.lang.String	NAME

Fields inherited from class org.gvsig.fmap.dal.feature.spi.AbstractFeatureStoreProvider

store

Constructor Summary

Constructors

Constructor and Description
WFSStoreProvider(DataStoreParameters params, DataStoreProviderServices storeServices)

Method Summary

Modifier and Type	Method and Description
boolean	allowWrite() Informs that store supports write.
FeatureProvider	createFeatureProvider(FeatureType type) Default Factory of FeatureProvider.
java.lang.Object	createNewOID() Return a new OID valid for a new feature.
FeatureSetProvider	createSet(FeatureQuery query)
FeatureSetProvider	createSet(FeatureQuery query, FeatureType featureType) Factory of FeatureSetProvider.
Envelope	getEnvelope() unsupported geometry by default (return null), override this otherwise
DataServerExplorer	getExplorer() unsupported by default (return null), override this otherwise
long	getFeatureCount() Returns total feature count of this store.
java.lang.String	getFullName() Returns a more descriptive name for the provider that getName.
java.lang.String	getName() Returns the name associated to the provider.
int	getOIDType() Return OID data type (from DataTypes) of this store.
java.lang.String	getProviderName() Return the name of the provider.
ResourceProvider	getResource() Returns the Resource from where the data is being loaded.
int	getRetrievedFeaturesLimit() If the FeatureStoreProvider.hasRetrievedFeaturesLimit() returns true, it returns the limit of features retrieved from the provider.
java.lang.Object	getSourceId() Returns the unique identifier of the Store FIXME add examples
boolean	hasRetrievedFeaturesLimit() Return if the maximum number of features provided by the provider are limited.
protected FeatureProvider	internalGetFeatureProviderByReference(FeatureReferenceProviderServices reference, FeatureType featureType) Returns a FeatureProvider by reference, using the provided FeatureType.
boolean	isKnownEnvelope() Return if the provider knows the real envelope of a layer.
void	open() Open store.
void	performChanges(java.util.Iterator deleteds, java.util.Iterator inserteds, java.util.Iterator updateds, java.util.Iterator featureTypesChanged) unsupported by default, override this otherwise
protected static void	registerMetadataDefinition()

Methods inherited from class org.gvsig.fmap.dal.feature.spi.AbstractFeatureStoreProvider

abortAppend, allowAutomaticValues, allowGeometry, append, beginAppend, beginAppend, canWriteGeometry, clear, close, createExpression, createFeatureLocks, createFeatureSelection, createResource, createSet, delegate, doDispose, endAppend, fixFeatureTypeFromParameters, getChildren, getDynClass, getDynValue, getEnvelope, getFeatureProviderByReference, getFeatureProviderByReference, getFeatureStore, getInterval, getParameters, getResourcesStorage, getStoreServices, getStoresRepository, getTimes, getTimes, hasDynMethod, hasDynValue, implement, internalGetFeatureProviderByReference, invokeDynMethod, invokeDynMethod, isLocksSupported, isTemporary, passThroughDelete, passThroughDelete, passThroughInsert, passThroughInsertOrUpdate, passThroughUpdate, passThroughUpdate, refresh, savePrjFile, setDynValue, setMetadata, supportsAppendMode, supportsPassThroughMode, toString

Methods inherited from class org.gvsig.fmap.dal.spi.AbstractDataStoreProvider

setTransaction

Methods inherited from class org.gvsig.tools.dispose.impl.AbstractDisposable

dispose, dispose

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gvsig.fmap.dal.spi.DataStoreProvider

setTransaction

Methods inherited from interface org.gvsig.tools.dynobject.DynObject

clone

Methods inherited from interface org.gvsig.tools.dispose.Disposable

dispose

Field Detail

NAME

public static java.lang.String NAME

DESCRIPTION

public static java.lang.String DESCRIPTION

Constructor Detail

WFSStoreProvider

public WFSStoreProvider(DataStoreParameters params,
                        DataStoreProviderServices storeServices)
                 throws InitializeException

Throws:

InitializeException

Method Detail

open

public void open()
          throws OpenException

Description copied from interface: DataStoreProvider

Open store. You must call it before do anything whith store.
This method can be called repeatly.

Throws:

OpenException

registerMetadataDefinition

protected static void registerMetadataDefinition()
                                          throws MetadataException

Throws:

MetadataException

getExplorer

public DataServerExplorer getExplorer()
                               throws ReadException

Description copied from class: AbstractFeatureStoreProvider

unsupported by default (return null), override this otherwise

Overrides:

getExplorer in class AbstractFeatureStoreProvider

Returns:

ServerExplorer

Throws:

ReadException

See Also:

DataStoreProvider.getExplorer()

getProviderName

public java.lang.String getProviderName()

Description copied from interface: DataStoreProvider

Return the name of the provider. Examples: dbf, shp, jdbc, postgresql, wfs, gml

Returns:

createSet

public FeatureSetProvider createSet(FeatureQuery query)
                             throws DataException

Throws:

DataException

createSet

public FeatureSetProvider createSet(FeatureQuery query,
                                    FeatureType featureType)
                             throws DataException

Description copied from interface: FeatureStoreProvider

Factory of FeatureSetProvider. Create a new FeatureSetProvider that represents result of FeatureQuery .

Parameters:

query - (never will be null)

featureType - (never will be null)

Returns:

Throws:

DataException

getSourceId

public java.lang.Object getSourceId()

Description copied from interface: DataStoreProvider

Returns the unique identifier of the Store FIXME add examples

Returns:

createNewOID

public java.lang.Object createNewOID()

Description copied from interface: FeatureStoreProvider

Return a new OID valid for a new feature.

Returns:

a new OID

See Also:

FeatureStoreProvider#getOIDType()}

getFeatureCount

public long getFeatureCount()
                     throws DataException

Description copied from interface: FeatureStoreProvider

Returns total feature count of this store.

Returns:

Throws:

DataException

getOIDType

public int getOIDType()

Description copied from interface: FeatureStoreProvider

Return OID data type (from DataTypes) of this store.

Returns:

OID data type

See Also:

FeatureStoreProvider#createNewOID()} {@link DataTypes}

getResource

public ResourceProvider getResource()

Description copied from interface: DataStoreProvider

Returns the Resource from where the data is being loaded.

Returns:

the data Resource

internalGetFeatureProviderByReference

protected FeatureProvider internalGetFeatureProviderByReference(FeatureReferenceProviderServices reference,
                                                                FeatureType featureType)
                                                         throws DataException

Description copied from class: AbstractFeatureStoreProvider

Returns a FeatureProvider by reference, using the provided FeatureType. This is the child classes implementation of the AbstractFeatureStoreProvider.getFeatureProviderByReference(FeatureReferenceProviderServices) method.

Specified by:

internalGetFeatureProviderByReference in class AbstractFeatureStoreProvider

Parameters:

reference - the reference to the FeatureProvider

featureType - the type of feature to load

Returns:

the FeatureProvider being referenced

Throws:

DataException - if there is an error loading the FeatureProvider

getFullName

public java.lang.String getFullName()

Description copied from interface: DataStoreProvider

Returns a more descriptive name for the provider that getName. This name is provided for informational purposes only. Explamples: In a file based store may return the full name of the filename, path and filename. In a data base based store may return "server:dbname:tablename" In a WFS layer based store may return "server:layername"

Returns:

String Containing the full name of the store

getName

public java.lang.String getName()

Description copied from interface: DataStoreProvider

Returns the name associated to the provider. This name is provided for informational purposes only. Explamples: In a dbf the filename without the path In a DDBB table the name of the table In a WFS layer the name of the layer.

Returns:

String containing this store's name.

isKnownEnvelope

public boolean isKnownEnvelope()

Description copied from interface: FeatureStoreProvider

Return if the provider knows the real envelope of a layer. If not, the FeatureStoreProvider.getEnvelope() method doesn't return the full envelope.

Specified by:

isKnownEnvelope in interface FeatureStoreProvider

Overrides:

isKnownEnvelope in class AbstractFeatureStoreProvider

Returns:

true if it knows the real envelope.

hasRetrievedFeaturesLimit

public boolean hasRetrievedFeaturesLimit()

Description copied from interface: FeatureStoreProvider

Return if the maximum number of features provided by the provider are limited.

Specified by:

hasRetrievedFeaturesLimit in interface FeatureStoreProvider

Overrides:

hasRetrievedFeaturesLimit in class AbstractFeatureStoreProvider

Returns:

true if there is a limit of features.

getRetrievedFeaturesLimit

public int getRetrievedFeaturesLimit()

Description copied from interface: FeatureStoreProvider

If the FeatureStoreProvider.hasRetrievedFeaturesLimit() returns true, it returns the limit of features retrieved from the provider.

Specified by:

getRetrievedFeaturesLimit in interface FeatureStoreProvider

Overrides:

getRetrievedFeaturesLimit in class AbstractFeatureStoreProvider

Returns:

The limit of the retrieved features.

performChanges

public void performChanges(java.util.Iterator deleteds,
                           java.util.Iterator inserteds,
                           java.util.Iterator updateds,
                           java.util.Iterator featureTypesChanged)
                    throws DataException

Description copied from class: AbstractFeatureStoreProvider

unsupported by default, override this otherwise

Specified by:

performChanges in interface FeatureStoreProvider

Overrides:

performChanges in class AbstractFeatureStoreProvider

Parameters:

deleteds - iterator of FeatureReferenceProviderServices

inserteds - iterator of FeatureProvider

updateds - iterator of FeatureProvider

featureTypesChanged - iterator of FeatureType.FeatureTypeChanged

Throws:

DataException

See Also:

FeatureStoreProvider.performChanges(Iterator, Iterator, Iterator, Iterator)

allowWrite

public boolean allowWrite()

Description copied from interface: FeatureStoreProvider

Informs that store supports write.

Specified by:

allowWrite in interface FeatureStoreProvider

Overrides:

allowWrite in class AbstractFeatureStoreProvider

Returns:

true if write is supported

getEnvelope

public Envelope getEnvelope()
                     throws DataException

Description copied from class: AbstractFeatureStoreProvider

unsupported geometry by default (return null), override this otherwise

Specified by:

getEnvelope in interface FeatureStoreProvider

Overrides:

getEnvelope in class AbstractFeatureStoreProvider

Returns:

this store's total envelope (extent) or null if store not have geometry information

Throws:

DataException

See Also:

FeatureStoreProvider.getEnvelope()

createFeatureProvider

public FeatureProvider createFeatureProvider(FeatureType type)
                                      throws DataException

Description copied from class: AbstractFeatureStoreProvider

Default Factory of FeatureProvider. Create a new default FeatureProvider instance.
Override this if you need an special implemtation of FeatureProvider.

Specified by:

createFeatureProvider in interface FeatureStoreProvider

Overrides:

createFeatureProvider in class AbstractFeatureStoreProvider

Returns:

Throws:

DataException

See Also:

org.gvsig.fmap.dal.feature.spi.FeatureStoreProvider#createFeatureProvider(FeatureType)}