org.gvsig.fmap.dal.store.jdbc

Class JDBCStoreProvider

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

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

org.gvsig.fmap.dal.store.jdbc.JDBCStoreProvider

All Implemented Interfaces:

DataStoreProvider, FeatureStoreProvider, ResourceConsumer, JDBCHelperUser, Disposable, DynObject

Direct Known Subclasses:

JDBCStoreProviderWriter

public class JDBCStoreProvider
extends AbstractFeatureStoreProvider
implements JDBCHelperUser

Nested Class Summary

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.feature.spi.FeatureStoreProvider

FeatureStoreProvider.FeatureTypeChanged

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DESCRIPTION
protected boolean	directSQLMode
protected JDBCHelper	helper
static java.lang.String	METADATA_DEFINITION_NAME
static java.lang.String	NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
	JDBCStoreProvider(JDBCStoreParameters params, DataStoreProviderServices storeServices)
protected	JDBCStoreProvider(JDBCStoreParameters params, DataStoreProviderServices storeServices, DynObject metadata)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowAutomaticValues() unsupported by default, override this otherwise
protected void	appendWhere(java.lang.StringBuilder sql, java.lang.String filter)
void	checksResulsets()
void	close() do nothing by default, override this otherwise
void	closeDone() Called when the resource was close
protected boolean	closeResource(ResourceProvider resource)
boolean	closeResourceRequested(ResourceProvider resource)
void	closeResulset(int resultsetID)
protected void	closeResulset(java.sql.ResultSet rs)
protected java.lang.String	compoundCountSelect(java.lang.String filter)
java.lang.String	compoundSelect(FeatureType type, java.lang.String filter, java.lang.String order, long limit, long offset)
protected JDBCHelper	createHelper()
java.lang.Object	createNewOID() Return a new OID valid for a new feature.
protected java.sql.ResultSet	createNewResultSet(java.lang.String sql, java.lang.Object[] values, int fetchSize)
int	createResultSet(java.lang.String sql, int fetchSize)
int	createResultSet(java.lang.String sql, java.lang.Object[] values, int fetchSize)
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.
protected java.lang.String	fixFilter(java.lang.String filter)
protected void	forceCloseAllResultSet()
protected void	forceCloseResultSet(int rsID)
protected long	getCount(java.lang.String filter) Get feature count for a filter.
java.lang.Object	getDynValue(java.lang.String name)
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()
protected JDBCHelper	getHelper()
protected java.lang.String	getIsNullExpression() Return "is null" expression for current provider
protected JDBCStoreParameters	getJDBCParameters()
java.lang.String	getName()
int	getOIDType() Return OID data type (from DataTypes) of this store.
java.lang.String	getProviderName() Get the user name
ResourceProvider	getResource()
protected java.sql.ResultSet	getResultSet(int resultsetID)
java.lang.Object	getSourceId()
long	getTimeToResulSetZombie()
boolean	hasGeometrySupport()
protected void	initFeatureType()
protected FeatureProvider	internalGetFeatureProviderByReference(FeatureReferenceProviderServices reference) Returns a FeatureProvider by reference, using the default FeatureType.
protected FeatureProvider	internalGetFeatureProviderByReference(FeatureReferenceProviderServices reference, FeatureType featureType) Returns a FeatureProvider by reference, using the provided FeatureType.
protected boolean	isDirectSQLMode()
void	loadFeatureProvider(FeatureProvider data, int resultsetID) Load data form a resulset.
protected void	loadFeatureProviderValue(FeatureProvider data, java.sql.ResultSet rs, FeatureAttributeDescriptor attr)
void	open()
void	opendDone() Called when the resource was open
protected int	openResulsetCount()
protected void	resetCount()
void	resourceChanged(ResourceProvider resource)
boolean	resulsetNext(int resultsetID)
void	setTimeToResulSetZombie(long mlSeconds)

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

abortAppend, allowWrite, append, beginAppend, canWriteGeometry, clear, createFeatureLocks, createFeatureProvider, createFeatureSelection, createResource, delegate, endAppend, getChilds, getDynClass, getFeatureProviderByReference, getFeatureProviderByReference, getFeatureStore, getInterval, getParameters, getRetrievedFeaturesLimit, getStoreServices, getTimes, getTimes, hasDynValue, hasRetrievedFeaturesLimit, implement, invokeDynMethod, invokeDynMethod, isKnownEnvelope, isLocksSupported, performChanges, refresh, savePrjFile, setDynValue, setMetadata, supportsAppendMode

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.tools.dispose.Disposable

dispose

Field Detail

NAME

public static java.lang.String NAME

DESCRIPTION

public static java.lang.String DESCRIPTION

METADATA_DEFINITION_NAME

public static final java.lang.String METADATA_DEFINITION_NAME

helper

protected JDBCHelper helper

directSQLMode

protected boolean directSQLMode

Constructor Detail

JDBCStoreProvider

public JDBCStoreProvider(JDBCStoreParameters params,
                 DataStoreProviderServices storeServices)
                  throws InitializeException

Throws:

InitializeException

JDBCStoreProvider

protected JDBCStoreProvider(JDBCStoreParameters params,
                 DataStoreProviderServices storeServices,
                 DynObject metadata)
                     throws InitializeException

Throws:

InitializeException

Method Detail

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

getJDBCParameters

protected JDBCStoreParameters getJDBCParameters()

loadFeatureProvider

public void loadFeatureProvider(FeatureProvider data,
                       int resultsetID)
                         throws DataException

Load data form a resulset.
Note:
this method have to perform resouceBegin at the begining and resourceEnd at the end of execution.

Parameters:

data -

resulsetID -

Throws:

DataException

loadFeatureProviderValue

protected void loadFeatureProviderValue(FeatureProvider data,
                            java.sql.ResultSet rs,
                            FeatureAttributeDescriptor attr)
                                 throws DataException

Throws:

DataException

getTimeToResulSetZombie

public long getTimeToResulSetZombie()

setTimeToResulSetZombie

public void setTimeToResulSetZombie(long mlSeconds)

createResultSet

public final int createResultSet(java.lang.String sql,
                  int fetchSize)
                          throws DataException

Throws:

DataException

createResultSet

public final int createResultSet(java.lang.String sql,
                  java.lang.Object[] values,
                  int fetchSize)
                          throws DataException

Throws:

DataException

forceCloseAllResultSet

protected final void forceCloseAllResultSet()
                                     throws ResourceExecuteException,
                                            JDBCException

Throws:

ResourceExecuteException

JDBCException

forceCloseResultSet

protected final void forceCloseResultSet(int rsID)
                                  throws ResourceExecuteException,
                                         JDBCException,
                                         InvalidResultSetIdException

Throws:

ResourceExecuteException

JDBCException

InvalidResultSetIdException

getResultSet

protected final java.sql.ResultSet getResultSet(int resultsetID)
                                         throws InvalidResultSetIdException

Throws:

InvalidResultSetIdException

resulsetNext

public final boolean resulsetNext(int resultsetID)
                           throws JDBCException,
                                  InvalidResultSetIdException,
                                  ResourceExecuteException

Throws:

JDBCException

InvalidResultSetIdException

ResourceExecuteException

closeResulset

public final void closeResulset(int resultsetID)
                         throws JDBCException,
                                InvalidResultSetIdException,
                                ResourceExecuteException

Throws:

JDBCException

InvalidResultSetIdException

ResourceExecuteException

checksResulsets

public final void checksResulsets()
                           throws JDBCException,
                                  InvalidResultSetIdException,
                                  ResourceExecuteException

Throws:

JDBCException

InvalidResultSetIdException

ResourceExecuteException

closeResulset

protected void closeResulset(java.sql.ResultSet rs)
                      throws JDBCException,
                             ResourceExecuteException

Throws:

JDBCException

ResourceExecuteException

openResulsetCount

protected final int openResulsetCount()

closeResourceRequested

public boolean closeResourceRequested(ResourceProvider resource)

Specified by:

closeResourceRequested in interface ResourceConsumer

fixFilter

protected java.lang.String fixFilter(java.lang.String filter)

createHelper

protected JDBCHelper createHelper()
                           throws InitializeException

Throws:

InitializeException

getHelper

protected JDBCHelper getHelper()

resetCount

protected void resetCount()

getCount

protected long getCount(java.lang.String filter)
                 throws DataException

Get feature count for a filter.
filter can be null.
Note:
this method have to perform resouceBegin at the begining and resourceEnd at the end of execution.

Parameters:

filter -

Returns:

Throws:

DataException

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

open

public void open()
          throws OpenException

Throws:

OpenException

internalGetFeatureProviderByReference

protected FeatureProvider internalGetFeatureProviderByReference(FeatureReferenceProviderServices reference)
                                                         throws DataException

Description copied from class: AbstractFeatureStoreProvider

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

Overrides:

internalGetFeatureProviderByReference in class AbstractFeatureStoreProvider

Parameters:

reference - the reference to the FeatureProvider

Returns:

the FeatureProvider being referenced

Throws:

DataException - if there is an error loading the FeatureProvider

getIsNullExpression

protected java.lang.String getIsNullExpression()

Return "is null" expression for current provider

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

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}

initFeatureType

protected void initFeatureType()
                        throws InitializeException

Throws:

InitializeException

createNewResultSet

protected java.sql.ResultSet createNewResultSet(java.lang.String sql,
                                    java.lang.Object[] values,
                                    int fetchSize)
                                         throws DataException

Throws:

DataException

closeResource

protected boolean closeResource(ResourceProvider resource)

compoundCountSelect

protected java.lang.String compoundCountSelect(java.lang.String filter)

appendWhere

protected void appendWhere(java.lang.StringBuilder sql,
               java.lang.String filter)

closeDone

public void closeDone()
               throws DataException

Description copied from interface: JDBCHelperUser

Called when the resource was close

Specified by:

closeDone in interface JDBCHelperUser

Throws:

DataException

opendDone

public void opendDone()
               throws DataException

Description copied from interface: JDBCHelperUser

Called when the resource was open

Specified by:

opendDone in interface JDBCHelperUser

Throws:

DataException

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

resourceChanged

public void resourceChanged(ResourceProvider resource)

Specified by:

resourceChanged in interface ResourceConsumer

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

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

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

compoundSelect

public java.lang.String compoundSelect(FeatureType type,
                              java.lang.String filter,
                              java.lang.String order,
                              long limit,
                              long offset)
                                throws DataException

Throws:

DataException

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

getProviderName

public java.lang.String getProviderName()

Description copied from interface: JDBCHelperUser

Get the user name

Specified by:

getProviderName in interface JDBCHelperUser

Returns:

hasGeometrySupport

public boolean hasGeometrySupport()

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

getSourceId

public java.lang.Object getSourceId()

getName

public java.lang.String getName()

getFullName

public java.lang.String getFullName()

getResource

public ResourceProvider getResource()

isDirectSQLMode

protected boolean isDirectSQLMode()