org.gvsig.fmap.dal.feature.spi

Class AbstractFeatureStoreProvider

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

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

All Implemented Interfaces:

DataStoreProvider, FeatureStoreProvider, Disposable, DynObject

Direct Known Subclasses:

AbstractMemoryStoreProvider, DBFStoreProvider, GPEStoreProvider, JDBCStoreProvider, OGRDataStoreProvider, WFSStoreProvider

public abstract class AbstractFeatureStoreProvider
extends AbstractDisposable
implements FeatureStoreProvider

Abstract implementation of FeatureStoreProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractFeatureStoreProvider.FeatureProviderNotFoundException

Nested classes/interfaces inherited from interface org.gvsig.fmap.dal.feature.spi.FeatureStoreProvider

FeatureStoreProvider.FeatureTypeChanged

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

Methods

Modifier and Type	Method and Description
void	abortAppend()
boolean	allowAutomaticValues() unsupported by default, override this otherwise
boolean	allowWrite() unsupported by default, override this otherwise
void	append(FeatureProvider featureProvider) unsupported by default, override this otherwise
void	beginAppend() unsupported by default, override this otherwise
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
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(String type, Object[] params) Create or get a resource of type for params in ResourceManager
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
Iterator	getChilds() unsupported by default (return null), override this otherwise
DynClass	getDynClass()
Object	getDynValue(String name)
Envelope	getEnvelope() unsupported geometry by default (return null), override this otherwise
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()
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
Collection	getTimes() Gets all the possible values of time for which the store has data.
Collection	getTimes(Interval interval) Gets all the possible values of time for which the store has data and intersects with an interval.
boolean	hasDynValue(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.
Object	invokeDynMethod(int code, Object[] args)
Object	invokeDynMethod(String name, Object[] args)
boolean	isKnownEnvelope() Return if the provider knows the real envelope of a layer.
boolean	isLocksSupported() unsupported by default, override this otherwise
void	performChanges(Iterator deleteds, Iterator inserteds, Iterator updateds, Iterator featureTypesChanged) unsupported by default, override this otherwise
void	refresh() do nothing by default, override this otherwise
protected void	savePrjFile(File dataFile, IProjection proj)
void	setDynValue(String name, Object value)
protected void	setMetadata(DynObject metadata) Set metada container if this not set at construction time and only in one time.
boolean	supportsAppendMode() unsupported by default, override this otherwise

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, toString, 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

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

dispose

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()

Returns:

the parameters

createResource

protected ResourceProvider createResource(String type,
                              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()

allowWrite

public boolean allowWrite()

unsupported by default, override this otherwise

Specified by:

allowWrite in interface FeatureStoreProvider

Returns:

if write is supported

See Also:

FeatureStoreProvider.allowWrite()

performChanges

public void performChanges(Iterator deleteds,
                  Iterator inserteds,
                  Iterator updateds,
                  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 FeatureStoreProvider.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()

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 Object getDynValue(String name)
                   throws DynFieldNotFoundException

Specified by:

getDynValue in interface DynObject

Throws:

DynFieldNotFoundException

hasDynValue

public boolean hasDynValue(String name)

Specified by:

hasDynValue in interface DynObject

implement

public void implement(DynClass dynClass)

Specified by:

implement in interface DynObject

invokeDynMethod

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

Specified by:

invokeDynMethod in interface DynObject

Throws:

DynMethodException

invokeDynMethod

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

Specified by:

invokeDynMethod in interface DynObject

Throws:

DynMethodException

setDynValue

public void setDynValue(String name,
               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

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()

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()

unsupported by default, override this otherwise

Specified by:

supportsAppendMode in interface FeatureStoreProvider

See Also:

FeatureStoreProvider.supportsAppendMode()

getChilds

public Iterator getChilds()

unsupported by default (return null), override this otherwise

Returns:

SubStores iterator

See Also:

DataStoreProvider.getChilds()

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:

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:

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 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 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.

savePrjFile

protected void savePrjFile(File dataFile,
               IProjection proj)