org.gvsig.fmap.dal.store.jdbc2.spi

Class JDBCStoreProviderBase

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.jdbc2.spi.JDBCStoreProviderBase

All Implemented Interfaces:

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

public class JDBCStoreProviderBase
extends AbstractFeatureStoreProvider
implements ResourceConsumer, JDBCStoreProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JDBCStoreProviderBase.AllowWriteValue
class	JDBCStoreProviderBase.CountValue
class	JDBCStoreProviderBase.EnvelopeValue

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

AbstractFeatureStoreProvider.FeatureProviderNotFoundException

Nested classes/interfaces inherited from interface org.gvsig.fmap.dal.store.jdbc2.JDBCStoreProvider

JDBCStoreProvider.CalculatedValue<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected JDBCStoreProvider.CalculatedValue<java.lang.Boolean>	allowWrite
protected AppendOperation	appendOperation
protected JDBCStoreProvider.CalculatedValue<java.lang.Long>	count
protected JDBCStoreProvider.CalculatedValue<Envelope>	envelope
protected JDBCHelper	helper
protected static Logger	LOGGER
protected Observer	transactionObserver

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

store

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JDBCStoreProviderBase(JDBCStoreParameters params, DataStoreProviderServices storeServices, DynObject metadata, JDBCHelper helper)

Method Summary

Modifier and Type	Method and Description
void	abortAppend()
boolean	allowAutomaticValues() unsupported by default, override this otherwise
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	close() do nothing by default, override this otherwise
boolean	closeResourceRequested(ResourceProvider resource)
protected AppendOperation	createAppendOperation()
java.lang.Object	createNewOID() Return a new OID valid for a new feature.
FeatureSetProvider	createSet(FeatureQuery query, FeatureType featureType) Factory of FeatureSetProvider.
protected void	doDispose() Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.
void	endAppend() unsupported by default, override this otherwise
JDBCStoreProvider.CalculatedValue<java.lang.Boolean>	getAllowWriteValue()
JDBCStoreProvider.CalculatedValue<java.lang.Long>	getCountValue()
java.lang.Object	getDynValue(java.lang.String name)
Envelope	getEnvelope() unsupported geometry by default (return null), override this otherwise
JDBCStoreProvider.CalculatedValue<Envelope>	getEnvelopeValue()
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.
JDBCHelper	getHelper()
java.lang.String	getName() Returns the name associated to the provider.
int	getOIDType() Return OID data type (from DataTypes) of this store.
OperationsFactory	getOperations()
JDBCStoreParameters	getParameters()
java.lang.String	getProviderName() Return the name of the provider.
ResourceProvider	getResource() Returns the Resource from where the data is being loaded.
java.lang.String	getSourceId() Returns the unique identifier of the Store FIXME add examples
protected void	initializeFeatureType()
protected FeatureProvider	internalGetFeatureProviderByReference(FeatureReferenceProviderServices reference, FeatureType featureType) Returns a FeatureProvider by reference, using the provided FeatureType.
void	open() Open store.
void	passThroughDelete(Expression expression)
void	passThroughDelete(FeatureReferenceProviderServices featureReference)
void	passThroughInsert(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
void	resourceChanged(ResourceProvider resource)
void	setTransaction(DataTransactionServices transaction)
boolean	supportsAppendMode()
boolean	supportsPassThroughMode()
java.lang.String	toString()

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

allowGeometry, clear, createExpression, createFeatureLocks, createFeatureProvider, createFeatureSelection, createResource, createSet, delegate, fixFeatureTypeFromParameters, getChildren, getDynClass, getEnvelope, getFeatureProviderByReference, getFeatureProviderByReference, getFeatureStore, getInterval, getResourcesStorage, getRetrievedFeaturesLimit, getStoreServices, getStoresRepository, getTimes, getTimes, hasDynMethod, hasDynValue, hasRetrievedFeaturesLimit, implement, internalGetFeatureProviderByReference, invokeDynMethod, invokeDynMethod, isKnownEnvelope, isLocksSupported, isTemporary, passThroughInsertOrUpdate, savePrjFile, setDynValue, setMetadata

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_v2

createExpression

Methods inherited from interface org.gvsig.fmap.dal.feature.spi.FeatureStoreProvider

allowGeometry, createFeatureLocks, createFeatureProvider, createFeatureSelection, createSet, fixFeatureTypeFromParameters, getEnvelope, getFeatureProviderByReference, getFeatureProviderByReference, getFeatureStore, getRetrievedFeaturesLimit, getStoreServices, hasRetrievedFeaturesLimit, isKnownEnvelope, isLocksSupported, isTemporary, passThroughInsertOrUpdate

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

getChildren, getInterval, getResourcesStorage, getStoresRepository, getTimes, getTimes

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

hasDynMethod

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

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

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

dispose

Field Detail

LOGGER

protected static final Logger LOGGER

helper

protected final JDBCHelper helper

count

protected JDBCStoreProvider.CalculatedValue<java.lang.Long> count

envelope

protected JDBCStoreProvider.CalculatedValue<Envelope> envelope

allowWrite

protected JDBCStoreProvider.CalculatedValue<java.lang.Boolean> allowWrite

appendOperation

protected AppendOperation appendOperation

transactionObserver

protected Observer transactionObserver

Constructor Detail

JDBCStoreProviderBase

protected JDBCStoreProviderBase(JDBCStoreParameters params,
                                DataStoreProviderServices storeServices,
                                DynObject metadata,
                                JDBCHelper helper)
                         throws InitializeException

Throws:

InitializeException

Method Detail

getParameters

public JDBCStoreParameters getParameters()

Specified by:

getParameters in interface FeatureStoreProvider

Specified by:

getParameters in interface JDBCStoreProvider

Overrides:

getParameters in class AbstractFeatureStoreProvider

Returns:

the parameters

getHelper

public JDBCHelper getHelper()

Specified by:

getHelper in interface JDBCStoreProvider

getOperations

public OperationsFactory getOperations()

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:

getOIDType

public int getOIDType()

Description copied from interface: FeatureStoreProvider

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

Specified by:

getOIDType in interface FeatureStoreProvider

Returns:

OID data type

See Also:

FeatureStoreProvider#createNewOID()} {@link DataTypes}

createNewOID

public java.lang.Object createNewOID()

Description copied from interface: FeatureStoreProvider

Return a new OID valid for a new feature.

Specified by:

createNewOID in interface FeatureStoreProvider

Returns:

a new OID

See Also:

FeatureStoreProvider#getOIDType()}

allowAutomaticValues

public boolean allowAutomaticValues()

Description copied from class: AbstractFeatureStoreProvider

unsupported by default, override this otherwise

Specified by:

allowAutomaticValues in interface FeatureStoreProvider

Overrides:

allowAutomaticValues in class AbstractFeatureStoreProvider

Returns:

true if supported

See Also:

FeatureStoreProvider.allowAutomaticValues()

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

getDynValue

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

Specified by:

getDynValue in interface DynObject

Overrides:

getDynValue in class AbstractFeatureStoreProvider

Throws:

DynFieldNotFoundException

getCountValue

public JDBCStoreProvider.CalculatedValue<java.lang.Long> getCountValue()

Specified by:

getCountValue in interface JDBCStoreProvider

getEnvelopeValue

public JDBCStoreProvider.CalculatedValue<Envelope> getEnvelopeValue()

Specified by:

getEnvelopeValue in interface JDBCStoreProvider

getAllowWriteValue

public JDBCStoreProvider.CalculatedValue<java.lang.Boolean> getAllowWriteValue()

Specified by:

getAllowWriteValue in interface JDBCStoreProvider

getFeatureCount

public long getFeatureCount()
                     throws DataException

Description copied from interface: FeatureStoreProvider

Returns total feature count of this store.

Specified by:

getFeatureCount in interface FeatureStoreProvider

Returns:

Throws:

DataException

closeResourceRequested

public boolean closeResourceRequested(ResourceProvider resource)

Specified by:

closeResourceRequested in interface ResourceConsumer

close

public void close()
           throws CloseException

Description copied from class: AbstractFeatureStoreProvider

do nothing by default, override this otherwise

Overrides:

close in class AbstractFeatureStoreProvider

Throws:

CloseException

See Also:

DataStoreProvider.close()

resourceChanged

public void resourceChanged(ResourceProvider resource)

Specified by:

resourceChanged in interface ResourceConsumer

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

doDispose

protected void doDispose()
                  throws BaseException

Description copied from class: AbstractDisposable

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

Overrides:

doDispose in class AbstractFeatureStoreProvider

Throws:

BaseException

See Also:

AbstractDisposable.dispose()

getSourceId

public java.lang.String getSourceId()

Description copied from interface: DataStoreProvider

Returns the unique identifier of the Store FIXME add examples

Specified by:

getSourceId in interface JDBCStoreProvider

Returns:

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.

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

getResource

public ResourceProvider getResource()

Description copied from interface: DataStoreProvider

Returns the Resource from where the data is being loaded.

Returns:

the data Resource

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

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 .

Specified by:

createSet in interface FeatureStoreProvider

Parameters:

query - (never will be null)

featureType - (never will be null)

Returns:

Throws:

DataException

initializeFeatureType

protected void initializeFeatureType()

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

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

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)

supportsAppendMode

public boolean supportsAppendMode()

Specified by:

supportsAppendMode in interface FeatureStoreProvider

Overrides:

supportsAppendMode in class AbstractFeatureStoreProvider

createAppendOperation

protected AppendOperation createAppendOperation()
                                         throws DataException

Throws:

DataException

endAppend

public void endAppend()
               throws DataException

Description copied from class: AbstractFeatureStoreProvider

unsupported by default, override this otherwise

Specified by:

endAppend in interface FeatureStoreProvider

Overrides:

endAppend in class AbstractFeatureStoreProvider

Throws:

DataException

See Also:

FeatureStoreProvider.endAppend()

abortAppend

public void abortAppend()
                 throws DataException

Specified by:

abortAppend in interface FeatureStoreProvider

Overrides:

abortAppend in class AbstractFeatureStoreProvider

Throws:

DataException

beginAppend

public void beginAppend()
                 throws DataException

Description copied from class: AbstractFeatureStoreProvider

unsupported by default, override this otherwise

Specified by:

beginAppend in interface FeatureStoreProvider

Overrides:

beginAppend in class AbstractFeatureStoreProvider

Throws:

DataException

See Also:

FeatureStoreProvider.beginAppend()

beginAppend

public void beginAppend(int submode)
                 throws DataException

Specified by:

beginAppend in interface FeatureStoreProvider

Overrides:

beginAppend in class AbstractFeatureStoreProvider

Throws:

DataException

append

public void append(FeatureProvider featureProvider)
            throws DataException

Description copied from class: AbstractFeatureStoreProvider

unsupported by default, override this otherwise

Specified by:

append in interface FeatureStoreProvider

Overrides:

append in class AbstractFeatureStoreProvider

Throws:

DataException

See Also:

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

canWriteGeometry

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

Description copied from class: AbstractFeatureStoreProvider

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

Specified by:

canWriteGeometry in interface FeatureStoreProvider

Overrides:

canWriteGeometry in class AbstractFeatureStoreProvider

Returns:

Throws:

DataException

See Also:

FeatureStoreProvider.canWriteGeometry(int, int)

supportsPassThroughMode

public boolean supportsPassThroughMode()

Specified by:

supportsPassThroughMode in interface FeatureStoreProvider

Overrides:

supportsPassThroughMode in class AbstractFeatureStoreProvider

passThroughInsert

public void passThroughInsert(FeatureProvider featureProvider)
                       throws DataException

Specified by:

passThroughInsert in interface FeatureStoreProvider

Overrides:

passThroughInsert in class AbstractFeatureStoreProvider

Throws:

DataException

passThroughUpdate

public void passThroughUpdate(FeatureProvider featureProvider)
                       throws DataException

Specified by:

passThroughUpdate in interface FeatureStoreProvider

Overrides:

passThroughUpdate in class AbstractFeatureStoreProvider

Throws:

DataException

passThroughUpdate

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

Specified by:

passThroughUpdate in interface FeatureStoreProvider

Overrides:

passThroughUpdate in class AbstractFeatureStoreProvider

passThroughDelete

public void passThroughDelete(FeatureReferenceProviderServices featureReference)
                       throws DataException

Specified by:

passThroughDelete in interface FeatureStoreProvider

Overrides:

passThroughDelete in class AbstractFeatureStoreProvider

Throws:

DataException

passThroughDelete

public void passThroughDelete(Expression expression)
                       throws DataException

Specified by:

passThroughDelete in interface FeatureStoreProvider

Overrides:

passThroughDelete in class AbstractFeatureStoreProvider

Throws:

DataException

setTransaction

public void setTransaction(DataTransactionServices transaction)

Overrides:

setTransaction in class AbstractDataStoreProvider

toString

public java.lang.String toString()

Overrides:

toString in class AbstractFeatureStoreProvider

refresh

public void refresh()
             throws OpenException

Description copied from class: AbstractFeatureStoreProvider

do nothing by default, override this otherwise

Overrides:

refresh in class AbstractFeatureStoreProvider

Throws:

OpenException

See Also:

DataStoreProvider.refresh()