org.gvsig.fmap.dal.feature.spi

Interface FeatureStoreProvider

All Superinterfaces:

DataFactoryUnit, DataStoreProvider, Disposable, DynObject, DynObject_v2

All Known Subinterfaces:

FeatureCacheProvider, FeatureStoreProvider_v2, JDBCStoreProvider

All Known Implementing Classes:

AbstractFeatureStoreProvider, AbstractMemoryStoreProvider, CSVStoreProvider, DBFStoreProvider, DGNStoreProvider, DWGStoreProvider, DXFStoreProvider, FeatureTypeToStoreProviderAdapter, GMLDataStoreProvider, GMLStoreProvider, GPEStoreProvider, JDBCStoreProviderBase, JExcelStoreProvider, JsonStoreProvider, KMLStoreProvider, MemoryStoreProvider, OGRDataStoreProvider, OGRStoreProvider, SeismicStoreProvider, SHPStoreProvider, SimpleReaderStoreProvider, SimpleSequentialReaderStoreProvider, WFSStoreProvider

public interface FeatureStoreProvider
extends DataStoreProvider

Interface for all feature based data providers.

A FeatureStoreProvier must have a contructor like this:

FeatureStoreProvider(DataStoreParameters, FeatureStoreProviderServices)

Method Summary

Modifier and Type	Method and Description
void	abortAppend()
boolean	allowAutomaticValues() Inform if the store provider supports automatic values for attributues (autonumeric)
int	allowGeometry(java.lang.String name, Geometry geometry)
boolean	allowWrite() Informs that store supports write.
void	append(FeatureProvider featureProvider)
void	beginAppend()
void	beginAppend(int submode)
boolean	canWriteGeometry(int geometryType, int geometrySubType) Informs that store supports write a geometry.
FeatureLocks	createFeatureLocks() Factory of FeatureLocks.
FeatureProvider	createFeatureProvider(FeatureType type) Factory of FeatureProvider.
FeatureSelection	createFeatureSelection() Factory of FeatureSelection.
java.lang.Object	createNewOID() Return a new OID valid for a new feature.
FeatureSetProvider	createSet(FeatureQuery query, FeatureType featureType) Factory of FeatureSetProvider.
FeatureSetProvider	createSet(FeatureQuery query, FeatureType providerFeatureType, FeatureType storeFeatureType)
void	endAppend()
void	fixFeatureTypeFromParameters()
Envelope	getEnvelope() Returns this store's total envelope (extent).
Envelope	getEnvelope(java.lang.String geomname)
long	getFeatureCount() Returns total feature count of this store.
FeatureProvider	getFeatureProviderByReference(FeatureReferenceProviderServices reference) Return FeatureProvider from a FeatureReferenceProviderServices using FeatureStore.getDefaultFeatureType() as FeatureType
FeatureProvider	getFeatureProviderByReference(FeatureReferenceProviderServices reference, FeatureType featureType) Return FeatureProvider from a FeatureReferenceProviderServices using featureType as FeatureType
FeatureStore	getFeatureStore()
int	getOIDType() Return OID data type (from DataTypes) of this store.
DataStoreParameters	getParameters()
int	getRetrievedFeaturesLimit() If the hasRetrievedFeaturesLimit() returns true, it returns the limit of features retrieved from the provider.
FeatureStoreProviderServices	getStoreServices() Return FeatureStoreProviderServices for this store
boolean	hasRetrievedFeaturesLimit() Return if the maximum number of features provided by the provider are limited.
boolean	isKnownEnvelope() Return if the provider knows the real envelope of a layer.
boolean	isLocksSupported() Informs if store supports locks
boolean	isTemporary() Indicates if the storage is temporary.
void	passThroughDelete(Expression filter)
void	passThroughDelete(FeatureReferenceProviderServices featureReference)
void	passThroughInsert(FeatureProvider featureProvider)
void	passThroughInsertOrUpdate(FeatureProvider featureProvider)
void	passThroughUpdate(FeatureProvider featureProvider)
void	passThroughUpdate(java.lang.Object[] parameters, Expression filter)
void	performChanges(java.util.Iterator deleteds, java.util.Iterator inserteds, java.util.Iterator updateds, java.util.Iterator featureTypesChanged) Perform changes on store.
boolean	supportsAppendMode()
boolean	supportsPassThroughMode()

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

close, getChildren, getExplorer, getFullName, getInterval, getName, getProviderName, getResource, getResourcesStorage, getSourceId, getStoresRepository, getTimes, getTimes, open, refresh, setTransaction

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

hasDynMethod

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

clear, clone, delegate, getDynClass, getDynValue, hasDynValue, implement, invokeDynMethod, invokeDynMethod, setDynValue

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

dispose

Method Detail

createNewOID

java.lang.Object createNewOID()

Return a new OID valid for a new feature.

Returns:

a new OID

See Also:

FeatureStoreProvider#getOIDType()}

getOIDType

int getOIDType()

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

Returns:

OID data type

See Also:

FeatureStoreProvider#createNewOID()} {@link DataTypes}

createFeatureProvider

FeatureProvider createFeatureProvider(FeatureType type)
                               throws DataException

Factory of FeatureProvider. Create a new FeatureProvider instance valid for this Store.

Parameters:

type, - FeatureType of the FeatureProvider

Returns:

Throws:

DataException

createFeatureSelection

FeatureSelection createFeatureSelection()
                                 throws DataException

Factory of FeatureSelection. Create a new FeatureSelection instance valid for this Store.

Returns:

Throws:

DataException

createFeatureLocks

FeatureLocks createFeatureLocks()
                         throws DataException

Factory of FeatureLocks. Create a new FeatureLocks instance valid for this Store.

Returns:

FeatureLocks or null if not isLocksSupported()

Throws:

DataException

createSet

FeatureSetProvider createSet(FeatureQuery query,
                             FeatureType featureType)
                      throws DataException

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

createSet

FeatureSetProvider createSet(FeatureQuery query,
                             FeatureType providerFeatureType,
                             FeatureType storeFeatureType)
                      throws DataException

Throws:

DataException

getFeatureProviderByReference

FeatureProvider getFeatureProviderByReference(FeatureReferenceProviderServices reference)
                                       throws DataException

Return FeatureProvider from a FeatureReferenceProviderServices using FeatureStore.getDefaultFeatureType() as FeatureType

Parameters:

reference -

Returns:

Throws:

DataException

getFeatureProviderByReference

FeatureProvider getFeatureProviderByReference(FeatureReferenceProviderServices reference,
                                              FeatureType featureType)
                                       throws DataException

Return FeatureProvider from a FeatureReferenceProviderServices using featureType as FeatureType

Parameters:

reference -

featureType -

Returns:

Throws:

DataException

allowWrite

boolean allowWrite()

Informs that store supports write.

Returns:

true if write is supported

canWriteGeometry

boolean canWriteGeometry(int geometryType,
                         int geometrySubType)
                  throws DataException

Informs that store supports write a geometry.

Parameters:

geometryType -

geometrySubType -

Returns:

Throws:

DataException

performChanges

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

Perform changes on store.

Parameters:

deleteds - iterator of FeatureReferenceProviderServices

inserteds - iterator of FeatureProvider

updateds - iterator of FeatureProvider

featureTypesChanged - iterator of FeatureType.FeatureTypeChanged

Throws:

DataException

getEnvelope

Envelope getEnvelope()
              throws DataException

Returns this store's total envelope (extent).

Returns:

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

Throws:

DataException

getEnvelope

Envelope getEnvelope(java.lang.String geomname)
              throws DataException

Throws:

DataException

isLocksSupported

boolean isLocksSupported()

Informs if store supports locks

Returns:

getStoreServices

FeatureStoreProviderServices getStoreServices()

Return FeatureStoreProviderServices for this store

Returns:

allowAutomaticValues

boolean allowAutomaticValues()

Inform if the store provider supports automatic values for attributues (autonumeric)

Returns:

true if supported

getFeatureCount

long getFeatureCount()
              throws DataException

Returns total feature count of this store.

Returns:

Throws:

DataException

supportsAppendMode

boolean supportsAppendMode()

beginAppend

void beginAppend()
          throws DataException

Throws:

DataException

beginAppend

void beginAppend(int submode)
          throws DataException

Throws:

DataException

endAppend

void endAppend()
        throws DataException

Throws:

DataException

append

void append(FeatureProvider featureProvider)
     throws DataException

Throws:

DataException

abortAppend

void abortAppend()
          throws DataException

Throws:

DataException

isKnownEnvelope

boolean isKnownEnvelope()

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

Returns:

true if it knows the real envelope.

hasRetrievedFeaturesLimit

boolean hasRetrievedFeaturesLimit()

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

Returns:

true if there is a limit of features.

getRetrievedFeaturesLimit

int getRetrievedFeaturesLimit()

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

Returns:

The limit of the retrieved features.

getFeatureStore

FeatureStore getFeatureStore()

getParameters

DataStoreParameters getParameters()

isTemporary

boolean isTemporary()

Indicates if the storage is temporary. There is no guarantee that a temporary store can be recovered from its parameters. In general these will not be persistent.

Returns:

true if the store is temporary, otherwise false.

fixFeatureTypeFromParameters

void fixFeatureTypeFromParameters()

supportsPassThroughMode

boolean supportsPassThroughMode()

passThroughInsert

void passThroughInsert(FeatureProvider featureProvider)
                throws DataException

Throws:

DataException

passThroughInsertOrUpdate

void passThroughInsertOrUpdate(FeatureProvider featureProvider)
                        throws DataException

Throws:

DataException

passThroughUpdate

void passThroughUpdate(FeatureProvider featureProvider)
                throws DataException

Throws:

DataException

passThroughDelete

void passThroughDelete(FeatureReferenceProviderServices featureReference)
                throws DataException

Throws:

DataException

passThroughDelete

void passThroughDelete(Expression filter)
                throws DataException

Throws:

DataException

passThroughUpdate

void passThroughUpdate(java.lang.Object[] parameters,
                       Expression filter)

allowGeometry

int allowGeometry(java.lang.String name,
                  Geometry geometry)