org.gvsig.fmap.dal.feature.spi

Class AbstractFeatureStoreProvider

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

org.gvsig.fmap.dal.spi.AbstractDataStoreProvider

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractMemoryStoreProvider, DBFStoreProvider, GPEStoreProvider, JDBCStoreProviderBase, OGRDataStoreProvider, WFSStoreProvider

public abstract class AbstractFeatureStoreProvider
extends AbstractDataStoreProvider
implements FeatureStoreProvider_v2

Abstract implementation of FeatureStoreProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractFeatureStoreProvider.FeatureProviderNotFoundException

Field Summary

Fields

Modifier and Type	Field and Description
protected FeatureStoreProviderServices	store

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFeatureStoreProvider(DataStoreParameters params, DataStoreProviderServices storeServices) Constructor when cannot create metada in constrution time.
protected	AbstractFeatureStoreProvider(DataStoreParameters params, DataStoreProviderServices storeServices, DynObject metadata) Default Constructor.

Method Summary

Modifier and Type	Method and Description
void	abortAppend()
boolean	allowAutomaticValues() unsupported by default, override this otherwise
int	allowGeometry(java.lang.String name, Geometry geometry)
boolean	allowWrite() Informs that store supports write.
void	append(FeatureProvider featureProvider) unsupported by default, override this otherwise
void	beginAppend() unsupported by default, override this otherwise
void	beginAppend(int submode)
boolean	canWriteGeometry(int geometryType, int geometrySubType) unsupported geometry write by default (return false), override this otherwise
void	clear()
void	close() do nothing by default, override this otherwise
ExpressionBuilder	createExpression()
FeatureLocks	createFeatureLocks() unsupported by default (return null), override this otherwise
FeatureProvider	createFeatureProvider(FeatureType type) Default Factory of FeatureProvider.
FeatureSelection	createFeatureSelection() Default Factory of FeatureSelection.
protected ResourceProvider	createResource(java.lang.String type, java.lang.Object[] params) Create or get a resource of type for params in ResourceManager
FeatureSetProvider	createSet(FeatureQuery query, FeatureType providerFeatureType, FeatureType storeFeatureType)
void	delegate(DynObject dynObject)
protected void	doDispose() Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.
void	endAppend() unsupported by default, override this otherwise
void	fixFeatureTypeFromParameters()
UnmodifiableBasicMap<java.lang.String,DataStore>	getChildren() Returns an UnmodifiableBasicMap with subStores from this store.
DynClass	getDynClass()
java.lang.Object	getDynValue(java.lang.String name)
Envelope	getEnvelope() unsupported geometry by default (return null), override this otherwise
Envelope	getEnvelope(java.lang.String geomname) Override on providers that allow more than one geometry
DataServerExplorer	getExplorer() unsupported by default (return null), override this otherwise
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()
Interval	getInterval() Gets the Interval of the store, that means the temporal interval where the store has valid data.
DataStoreParameters	getParameters()
ResourcesStorage	getResourcesStorage() Returns the resource store associated with this provider.
int	getRetrievedFeaturesLimit() If the FeatureStoreProvider.hasRetrievedFeaturesLimit() returns true, it returns the limit of features retrieved from the provider.
FeatureStoreProviderServices	getStoreServices() Return FeatureStoreProviderServices for this store
StoresRepository	getStoresRepository()
java.util.Collection	getTimes() Gets all the possible values of time for which the store has data.
java.util.Collection	getTimes(Interval interval) Gets all the possible values of time for which the store has data and intersects with an interval.
boolean	hasDynMethod(java.lang.String name)
boolean	hasDynValue(java.lang.String name)
boolean	hasRetrievedFeaturesLimit() Return if the maximum number of features provided by the provider are limited.
void	implement(DynClass dynClass)
protected FeatureProvider	internalGetFeatureProviderByReference(FeatureReferenceProviderServices reference) Returns a FeatureProvider by reference, using the default FeatureType.
protected abstract FeatureProvider	internalGetFeatureProviderByReference(FeatureReferenceProviderServices reference, FeatureType featureType) Returns a FeatureProvider by reference, using the provided FeatureType.
java.lang.Object	invokeDynMethod(int code, java.lang.Object[] args)
java.lang.Object	invokeDynMethod(java.lang.String name, java.lang.Object[] args)
boolean	isKnownEnvelope() Return if the provider knows the real envelope of a layer.
boolean	isLocksSupported() unsupported by default, override this otherwise
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) unsupported by default, override this otherwise
void	refresh() do nothing by default, override this otherwise
protected void	savePrjFile(java.io.File dataFile, IProjection proj)
void	setDynValue(java.lang.String name, java.lang.Object value)
protected void	setMetadata(DynObject metadata) Set metada container if this not set at construction time and only in one time.
boolean	supportsAppendMode()
boolean	supportsPassThroughMode()
java.lang.String	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.feature.spi.FeatureStoreProvider

createNewOID, createSet, getFeatureCount, getOIDType

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

getFullName, getName, getProviderName, getResource, getSourceId, open, setTransaction

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

clone

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

dispose

Field Detail

store

protected FeatureStoreProviderServices store

Constructor Detail

AbstractFeatureStoreProvider

protected AbstractFeatureStoreProvider(DataStoreParameters params,
                                       DataStoreProviderServices storeServices,
                                       DynObject metadata)

Default Constructor.

Parameters:

params -

storeServices -

metadata -

AbstractFeatureStoreProvider

protected AbstractFeatureStoreProvider(DataStoreParameters params,
                                       DataStoreProviderServices storeServices)

Constructor when cannot create metada in constrution time.

Note: Don't use it if not is necesary. Set metada as soon as posible by setMetadata(DynObject)

Parameters:

params -

storeServices -

Method Detail

getFeatureProviderByReference

public final FeatureProvider getFeatureProviderByReference(FeatureReferenceProviderServices reference)
                                                    throws DataException

Description copied from interface: FeatureStoreProvider

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

Specified by:

getFeatureProviderByReference in interface FeatureStoreProvider

Returns:

Throws:

DataException

getFeatureProviderByReference

public final FeatureProvider getFeatureProviderByReference(FeatureReferenceProviderServices reference,
                                                           FeatureType featureType)
                                                    throws DataException

Description copied from interface: FeatureStoreProvider

Return FeatureProvider from a FeatureReferenceProviderServices using featureType as FeatureType

Specified by:

getFeatureProviderByReference in interface FeatureStoreProvider

Returns:

Throws:

DataException

internalGetFeatureProviderByReference

protected FeatureProvider internalGetFeatureProviderByReference(FeatureReferenceProviderServices reference)
                                                         throws DataException

Returns a FeatureProvider by reference, using the default FeatureType. This method may be rewritten by the child classes as an implementation of the getFeatureProviderByReference(FeatureReferenceProviderServices) method.

Parameters:

reference - the reference to the FeatureProvider

Returns:

the FeatureProvider being referenced

Throws:

DataException - if there is an error loading the FeatureProvider

setMetadata

protected void setMetadata(DynObject metadata)

Set metada container if this not set at construction time and only in one time. In other case an Exception will be throw

Parameters:

metadata -

getParameters

public DataStoreParameters getParameters()

Specified by:

getParameters in interface FeatureStoreProvider

Returns:

the parameters

createResource

protected ResourceProvider createResource(java.lang.String type,
                                          java.lang.Object[] params)
                                   throws InitializeException

Create or get a resource of type for params in ResourceManager

Parameters:

type -

params -

Returns:

Throws:

InitializeException

getStoreServices

public FeatureStoreProviderServices getStoreServices()

Description copied from interface: FeatureStoreProvider

Return FeatureStoreProviderServices for this store

Specified by:

getStoreServices in interface FeatureStoreProvider

Returns:

getFeatureStore

public FeatureStore getFeatureStore()

Specified by:

getFeatureStore in interface FeatureStoreProvider

allowWrite

public boolean allowWrite()

Description copied from interface: FeatureStoreProvider

Informs that store supports write.

Specified by:

allowWrite in interface FeatureStoreProvider

Returns:

true if write is supported

performChanges

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

unsupported by default, override this otherwise

Specified by:

performChanges in interface FeatureStoreProvider

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)

isLocksSupported

public boolean isLocksSupported()

unsupported by default, override this otherwise

Specified by:

isLocksSupported in interface FeatureStoreProvider

Returns:

See Also:

FeatureStoreProvider.isLocksSupported()

createFeatureProvider

public FeatureProvider createFeatureProvider(FeatureType type)
                                      throws DataException

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

Returns:

Throws:

DataException

See Also:

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

createFeatureLocks

public FeatureLocks createFeatureLocks()
                                throws DataException

unsupported by default (return null), override this otherwise

Specified by:

createFeatureLocks in interface FeatureStoreProvider

Returns:

FeatureLocks or null if not FeatureStoreProvider.isLocksSupported()

Throws:

DataException

See Also:

FeatureStoreProvider.createFeatureLocks()

createFeatureSelection

public FeatureSelection createFeatureSelection()
                                        throws DataException

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

Specified by:

createFeatureSelection in interface FeatureStoreProvider

Returns:

Throws:

DataException

See Also:

FeatureStoreProvider.createFeatureSelection()

refresh

public void refresh()
             throws OpenException

do nothing by default, override this otherwise

Throws:

OpenException

See Also:

DataStoreProvider.refresh()

close

public void close()
           throws CloseException

do nothing by default, override this otherwise

Throws:

CloseException

See Also:

DataStoreProvider.close()

doDispose

protected void doDispose()
                  throws BaseException

Description copied from class: AbstractDisposable

Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.

Specified by:

doDispose in class AbstractDisposable

Throws:

BaseException

See Also:

AbstractDisposable.dispose()

getEnvelope

public Envelope getEnvelope()
                     throws DataException

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

Specified by:

getEnvelope in interface FeatureStoreProvider

Returns:

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

Throws:

DataException

See Also:

FeatureStoreProvider.getEnvelope()

getEnvelope

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

Override on providers that allow more than one geometry

Specified by:

getEnvelope in interface FeatureStoreProvider

Parameters:

geomname -

Returns:

Throws:

DataException

canWriteGeometry

public boolean canWriteGeometry(int geometryType,
                                int geometrySubType)
                         throws DataException

unsupported geometry write by default (return false), override this otherwise

Specified by:

canWriteGeometry in interface FeatureStoreProvider

Returns:

Throws:

DataException

See Also:

FeatureStoreProvider.canWriteGeometry(int, int)

delegate

public void delegate(DynObject dynObject)

Specified by:

delegate in interface DynObject

getDynClass

public DynClass getDynClass()

Specified by:

getDynClass in interface DynObject

getDynValue

public java.lang.Object getDynValue(java.lang.String name)
                             throws DynFieldNotFoundException

Specified by:

getDynValue in interface DynObject

Throws:

DynFieldNotFoundException

hasDynValue

public boolean hasDynValue(java.lang.String name)

Specified by:

hasDynValue in interface DynObject

hasDynMethod

public boolean hasDynMethod(java.lang.String name)

Specified by:

hasDynMethod in interface DynObject_v2

implement

public void implement(DynClass dynClass)

Specified by:

implement in interface DynObject

invokeDynMethod

public java.lang.Object invokeDynMethod(int code,
                                        java.lang.Object[] args)
                                 throws DynMethodException

Specified by:

invokeDynMethod in interface DynObject

Throws:

DynMethodException

invokeDynMethod

public java.lang.Object invokeDynMethod(java.lang.String name,
                                        java.lang.Object[] args)
                                 throws DynMethodException

Specified by:

invokeDynMethod in interface DynObject

Throws:

DynMethodException

setDynValue

public void setDynValue(java.lang.String name,
                        java.lang.Object value)
                 throws DynFieldNotFoundException

Specified by:

setDynValue in interface DynObject

Throws:

DynFieldNotFoundException

allowAutomaticValues

public boolean allowAutomaticValues()

unsupported by default, override this otherwise

Specified by:

allowAutomaticValues in interface FeatureStoreProvider

Returns:

true if supported

See Also:

FeatureStoreProvider.allowAutomaticValues()

append

public void append(FeatureProvider featureProvider)
            throws DataException

unsupported by default, override this otherwise

Specified by:

append in interface FeatureStoreProvider

Parameters:

featureProvider -

Throws:

DataException

See Also:

org.gvsig.fmap.dal.feature.spi.FeatureStoreProvider#append(org.gvsig. fmap.dal.feature.spi.FeatureProvider)

beginAppend

public void beginAppend()
                 throws DataException

unsupported by default, override this otherwise

Specified by:

beginAppend in interface FeatureStoreProvider

Throws:

DataException

See Also:

FeatureStoreProvider.beginAppend()

beginAppend

public void beginAppend(int submode)
                 throws DataException

Specified by:

beginAppend in interface FeatureStoreProvider

Throws:

DataException

endAppend

public void endAppend()
               throws DataException

unsupported by default, override this otherwise

Specified by:

endAppend in interface FeatureStoreProvider

Throws:

DataException

See Also:

FeatureStoreProvider.endAppend()

abortAppend

public void abortAppend()
                 throws DataException

Specified by:

abortAppend in interface FeatureStoreProvider

Throws:

DataException

supportsAppendMode

public boolean supportsAppendMode()

Specified by:

supportsAppendMode in interface FeatureStoreProvider

getChildren

public UnmodifiableBasicMap<java.lang.String,DataStore> getChildren()

Description copied from interface: DataStoreProvider

Returns an UnmodifiableBasicMap with subStores from this store. If do not have children, return an empty UnmodifiableBasicMap. Never returns null.

Overrides:

getChildren in class AbstractDataStoreProvider

Returns:

SubStores UnmodifiableBasicMap

getStoresRepository

public StoresRepository getStoresRepository()

Overrides:

getStoresRepository in class AbstractDataStoreProvider

getResourcesStorage

public ResourcesStorage getResourcesStorage()

Description copied from interface: DataStoreProvider

Returns the resource store associated with this provider. If one does not exist, it will return null.

Overrides:

getResourcesStorage in class AbstractDataStoreProvider

Returns:

the ResourcesStorage or null.

getExplorer

public DataServerExplorer getExplorer()
                               throws ReadException,
                                      ValidateDataParametersException

unsupported by default (return null), override this otherwise

Returns:

ServerExplorer

Throws:

ReadException

ValidateDataParametersException

See Also:

DataStoreProvider.getExplorer()

clear

public void clear()

Specified by:

clear in interface DynObject

internalGetFeatureProviderByReference

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

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

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

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

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

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

Returns:

The limit of the retrieved features.

getInterval

public Interval getInterval()

Description copied from interface: DataStoreProvider

Gets the Interval of the store, that means the temporal interval where the store has valid data.

Returns:

a time interval or null if there is not time support

getTimes

public java.util.Collection getTimes()

Description copied from interface: DataStoreProvider

Gets all the possible values of time for which the store has data.

Returns:

a collection of Time objects.

getTimes

public java.util.Collection getTimes(Interval interval)

Description copied from interface: DataStoreProvider

Gets all the possible values of time for which the store has data and intersects with an interval.

Parameters:

interval - the interval of time

Returns:

a collection of Time objects.

createExpression

public ExpressionBuilder createExpression()

Specified by:

createExpression in interface FeatureStoreProvider_v2

savePrjFile

protected void savePrjFile(java.io.File dataFile,
                           IProjection proj)

isTemporary

public boolean isTemporary()

Description copied from interface: FeatureStoreProvider

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.

Specified by:

isTemporary in interface FeatureStoreProvider

Returns:

true if the store is temporary, otherwise false.

fixFeatureTypeFromParameters

public void fixFeatureTypeFromParameters()

Specified by:

fixFeatureTypeFromParameters in interface FeatureStoreProvider

supportsPassThroughMode

public boolean supportsPassThroughMode()

Specified by:

supportsPassThroughMode in interface FeatureStoreProvider

passThroughInsert

public void passThroughInsert(FeatureProvider featureProvider)
                       throws DataException

Specified by:

passThroughInsert in interface FeatureStoreProvider

Throws:

DataException

passThroughInsertOrUpdate

public void passThroughInsertOrUpdate(FeatureProvider featureProvider)
                               throws DataException

Specified by:

passThroughInsertOrUpdate in interface FeatureStoreProvider

Throws:

DataException

passThroughUpdate

public void passThroughUpdate(FeatureProvider featureProvider)
                       throws DataException

Specified by:

passThroughUpdate in interface FeatureStoreProvider

Throws:

DataException

passThroughDelete

public void passThroughDelete(FeatureReferenceProviderServices featureReference)
                       throws DataException

Specified by:

passThroughDelete in interface FeatureStoreProvider

Throws:

DataException

passThroughDelete

public void passThroughDelete(Expression filter)
                       throws DataException

Specified by:

passThroughDelete in interface FeatureStoreProvider

Throws:

DataException

passThroughUpdate

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

Specified by:

passThroughUpdate in interface FeatureStoreProvider

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createSet

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

Specified by:

createSet in interface FeatureStoreProvider

Throws:

DataException

allowGeometry

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

Specified by:

allowGeometry in interface FeatureStoreProvider