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

Class JDBCServerExplorerBase

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

org.gvsig.fmap.dal.spi.AbstractDataServerExplorer

org.gvsig.fmap.dal.serverexplorer.db.spi.AbstractDBServerExplorer

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

All Implemented Interfaces:

DataFactoryUnit, DataServerExplorer, DataServerExplorer_v2, ResourceConsumer, DBServerExplorer, DataServerExplorerProvider, JDBCServerExplorer, SupportTransactions, Disposable, PropertiesSupport

Direct Known Subclasses:

H2SpatialExplorer, MDBExplorer, SQLiteExplorer

public class JDBCServerExplorerBase
extends AbstractDBServerExplorer
implements JDBCServerExplorer, SupportTransactions

Field Summary

Fields

Modifier and Type	Field and Description
protected JDBCHelper	helper

Fields inherited from class org.gvsig.fmap.dal.spi.AbstractDataServerExplorer

LOGGER

Fields inherited from interface org.gvsig.fmap.dal.store.jdbc2.JDBCServerExplorer

QUERY_DONT_ADD_PRIMARY_KEY_IN_THE_ORDER, SHOW_TABLES, SHOW_TABLES_AND_VIEWS, SHOW_VIEWS

Fields inherited from interface org.gvsig.fmap.dal.DataServerExplorer

FILESYSTEM_SERVER_EXPLORER_NAME, MODE_ALL, MODE_FEATURE, MODE_GEOMETRY, MODE_RASTER

Constructor Summary

Constructors

Constructor and Description
JDBCServerExplorerBase(JDBCServerExplorerParameters parameters, DataServerExplorerProviderServices services, JDBCHelper helper)

Method Summary

Modifier and Type	Method and Description
boolean	add(java.lang.String providerName, NewDataStoreParameters theParams, boolean overwrite) Creates a new DataStore in this server.
java.lang.String	buildKeyForCachedTables(int mode, JDBCServerExplorerParameters params, boolean informationTables, int tablesOrViews)
boolean	canAdd() Indicates whether this DataServerExplorer can create a new DataStore in the server.
protected void	checkIsMine(DataStoreParameters dsp)
void	close() Close connection to the server
boolean	closeResourceRequested(ResourceProvider resource)
SQLBuilder	createSQLBuilder()
protected void	doDispose() Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.
void	dropCaches()
java.lang.Object	execute(java.lang.String sql)
boolean	exists() Check if the explorer defined by this parameters reference to a database.
boolean	exists(DataStoreParameters parameters)
JDBCStoreParameters	get(java.lang.String name)
JDBCNewStoreParameters	getAddParameters() Return a instance of NewDataStoreParameters to fill
NewDataStoreParameters	getAddParameters(java.lang.String storeName) Given the store's name, returns its parameters for creation.
java.lang.String	getConnectionProviderStatus()
java.util.List	getDataStoreProviderNames() Return the list of provider names that this server allow.
FeatureType	getFeatureType(DataStoreParameters theParams) Return the FeatureType of the store of dsp store
protected JDBCHelper	getHelper()
protected ResourcesStorage	getLocalResourcesStorage(DataStoreParameters parameters, java.lang.String storeName)
protected DataManagerProviderServices	getManager()
JDBCStoreParameters	getOpenParameters()
protected OperationsFactory	getOperations()
JDBCServerExplorerParameters	getParameters() Returns this DataServerExplorer parameters
java.lang.String	getProviderName() Returns the DataServerExplorer's name
ResourcesStorage	getResourcesStorage()
ResourcesStorage	getResourcesStorage(DataStore dataStore)
ResourcesStorage	getResourcesStorage(DataStoreParameters parameters)
ResourcesStorage	getResourcesStorage(java.lang.String name)
java.lang.String	getStoreName() Return the name of DataStoreProvider returned by this ServerExplorer
DataTransaction	getTransaction()
java.util.List	list(int mode) Provides a list of available stores in the server of a type.
java.util.List	list(int mode, int tablesOrViews) Provides a list of available stores in the server of a type.
void	open() Open connection to the server
DataStore	open(DataStoreParameters params) Open a store defined by dsp
DataStore	open(java.lang.String tableName)
void	remove(DataStoreParameters theParams) Removes a store from the server given its DataStoreParameters.
void	resourceChanged(ResourceProvider resource)
void	setCustomResources(java.lang.String tableName, java.lang.String resourcesTableName)
void	setCustomResources(java.lang.String tableName, java.lang.String resourcesTableName, boolean readonly)
void	setTransaction(DataTransaction transaction)
void	updateTableStatistics(java.lang.String database, java.lang.String schema, java.lang.String table)

Methods inherited from class org.gvsig.fmap.dal.serverexplorer.db.spi.AbstractDBServerExplorer

canAdd, list

Methods inherited from class org.gvsig.fmap.dal.spi.AbstractDataServerExplorer

getProperties, getProperty, getResourcePath, getServerExplorerProviderServices, setProperty

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

canAdd, getResourcePath, list

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

dispose

Methods inherited from interface org.gvsig.tools.util.PropertiesSupport

getProperties, getProperty, setProperty

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

getServerExplorerProviderServices

Field Detail

helper

protected JDBCHelper helper

Constructor Detail

JDBCServerExplorerBase

public JDBCServerExplorerBase(JDBCServerExplorerParameters parameters,
                              DataServerExplorerProviderServices services,
                              JDBCHelper helper)
                       throws InitializeException

Throws:

InitializeException

Method Detail

getProviderName

public java.lang.String getProviderName()

Description copied from interface: DataServerExplorer

Returns the DataServerExplorer's name

Specified by:

getProviderName in interface DataServerExplorer

Specified by:

getProviderName in interface JDBCServerExplorer

Returns:

String containing this DataServerExplorer's name

getStoreName

public java.lang.String getStoreName()

Description copied from class: AbstractDBServerExplorer

Return the name of DataStoreProvider returned by this ServerExplorer

Specified by:

getStoreName in interface JDBCServerExplorer

Specified by:

getStoreName in class AbstractDBServerExplorer

getManager

protected DataManagerProviderServices getManager()

getParameters

public JDBCServerExplorerParameters getParameters()

Description copied from interface: DataServerExplorer

Returns this DataServerExplorer parameters

Specified by:

getParameters in interface DataServerExplorer

Overrides:

getParameters in class AbstractDataServerExplorer

Returns:

an instance of DataServerExplorerParameters containing this DataServerExplorer parameters.

closeResourceRequested

public boolean closeResourceRequested(ResourceProvider resource)

Specified by:

closeResourceRequested in interface ResourceConsumer

resourceChanged

public void resourceChanged(ResourceProvider resource)

Specified by:

resourceChanged in interface ResourceConsumer

getHelper

protected JDBCHelper getHelper()

getOperations

protected OperationsFactory getOperations()

open

public DataStore open(DataStoreParameters params)
               throws DataException

Description copied from interface: DataServerExplorer_v2

Open a store defined by dsp

Specified by:

open in interface DataServerExplorer_v2

Specified by:

open in interface DBServerExplorer

Specified by:

open in interface JDBCServerExplorer

Overrides:

open in class AbstractDBServerExplorer

Returns:

Throws:

DataException

open

public DataStore open(java.lang.String tableName)
               throws DataException

Throws:

DataException

list

public java.util.List list(int mode)
                    throws DataException

Description copied from interface: DataServerExplorer

Provides a list of available stores in the server of a type.

Specified by:

list in interface DataServerExplorer

Specified by:

list in interface JDBCServerExplorer

Parameters:

mode - , filter store from a type: DataServerExplorer.MODE_ALL, DataServerExplorer.MODE_FEATURE, #MODE_FEATURE_GEOMETRY, DataServerExplorer.MODE_RASTER

Returns:

list of DataStoreParameters

Throws:

DataException

list

public java.util.List list(int mode,
                           int tablesOrViews)
                    throws DataException

Description copied from interface: JDBCServerExplorer

Provides a list of available stores in the server of a type.

Parameters:

mode - , filter store from a type: DataServerExplorer.MODE_ALL, DataServerExplorer.MODE_FEATURE, #MODE_FEATURE_GEOMETRY, DataServerExplorer.MODE_RASTER

tablesOrViews - , filter store between tables and views: JDBCServerExplorer.SHOW_TABLES_AND_VIEWS, JDBCServerExplorer.SHOW_TABLES, JDBCServerExplorer.SHOW_VIEWS

Returns:

list of DataStoreParameters

Throws:

DataException

buildKeyForCachedTables

public java.lang.String buildKeyForCachedTables(int mode,
                                                JDBCServerExplorerParameters params,
                                                boolean informationTables,
                                                int tablesOrViews)

remove

public void remove(DataStoreParameters theParams)
            throws RemoveException

Description copied from interface: DataServerExplorer

Removes a store from the server given its DataStoreParameters. If the store is a file then this method deletes the file, if it is a table in a database then this method drops the table, and so on.

Specified by:

remove in interface DataServerExplorer

Specified by:

remove in interface JDBCServerExplorer

Throws:

RemoveException

getOpenParameters

public JDBCStoreParameters getOpenParameters()
                                      throws DataException

Specified by:

getOpenParameters in interface JDBCServerExplorer

Throws:

DataException

getAddParameters

public NewDataStoreParameters getAddParameters(java.lang.String storeName)
                                        throws DataException

Description copied from interface: DataServerExplorer

Given the store's name, returns its parameters for creation.

Specified by:

getAddParameters in interface DataServerExplorer

Overrides:

getAddParameters in class AbstractDBServerExplorer

Returns:

parameters to create a store

Throws:

DataException

getAddParameters

public JDBCNewStoreParameters getAddParameters()
                                        throws DataException

Description copied from interface: DBServerExplorer

Return a instance of NewDataStoreParameters to fill

Specified by:

getAddParameters in interface DBServerExplorer

Specified by:

getAddParameters in interface JDBCServerExplorer

Returns:

Throws:

DataException

checkIsMine

protected void checkIsMine(DataStoreParameters dsp)

open

public void open()
          throws OpenException

Description copied from interface: DataServerExplorer_v2

Open connection to the server

Specified by:

open in interface DataServerExplorer_v2

Specified by:

open in interface DBServerExplorer

Overrides:

open in class AbstractDataServerExplorer

Throws:

OpenException

close

public void close()
           throws CloseException

Description copied from interface: DataServerExplorer_v2

Close connection to the server

Specified by:

close in interface DataServerExplorer_v2

Specified by:

close in interface DBServerExplorer

Overrides:

close in class AbstractDataServerExplorer

Throws:

CloseException

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 AbstractDataServerExplorer

Throws:

BaseException

See Also:

AbstractDisposable.dispose()

canAdd

public boolean canAdd()

Description copied from interface: DataServerExplorer

Indicates whether this DataServerExplorer can create a new DataStore in the server.

Specified by:

canAdd in interface DataServerExplorer

Specified by:

canAdd in interface JDBCServerExplorer

Returns:

true if this DataServerExplorer can be created or false otherwise.

getFeatureType

public FeatureType getFeatureType(DataStoreParameters theParams)
                           throws DataException

Description copied from interface: DBServerExplorer

Return the FeatureType of the store of dsp store

Specified by:

getFeatureType in interface DBServerExplorer

Specified by:

getFeatureType in interface JDBCServerExplorer

Returns:

Throws:

DataException

add

public boolean add(java.lang.String providerName,
                   NewDataStoreParameters theParams,
                   boolean overwrite)
            throws DataException

Description copied from interface: DataServerExplorer

Creates a new DataStore in this server.

Specified by:

add in interface DataServerExplorer

Specified by:

add in interface JDBCServerExplorer

theParams - , an instance of DataStoreParameters from DataServerExplorer.getAddParameters(String) that describes the new DataStore.

overwrite - if the store already exists

Returns:

true if the DataStoreParameters were successfully added, false otherwise.

Throws:

DataException

dropCaches

public void dropCaches()

getDataStoreProviderNames

public java.util.List getDataStoreProviderNames()

Description copied from interface: DataServerExplorer

Return the list of provider names that this server allow.

Specified by:

getDataStoreProviderNames in interface DataServerExplorer

Specified by:

getDataStoreProviderNames in interface JDBCServerExplorer

Returns:

List of provider names

updateTableStatistics

public void updateTableStatistics(java.lang.String database,
                                  java.lang.String schema,
                                  java.lang.String table)
                           throws JDBCExecuteSQLException

Specified by:

updateTableStatistics in interface JDBCServerExplorer

Throws:

JDBCExecuteSQLException

execute

public java.lang.Object execute(java.lang.String sql)

Specified by:

execute in interface JDBCServerExplorer

get

public JDBCStoreParameters get(java.lang.String name)
                        throws DataException

Specified by:

get in interface DataServerExplorer

Specified by:

get in interface JDBCServerExplorer

Overrides:

get in class AbstractDataServerExplorer

Throws:

DataException

createSQLBuilder

public SQLBuilder createSQLBuilder()

Specified by:

createSQLBuilder in interface DataServerExplorer_v2

Overrides:

createSQLBuilder in class AbstractDataServerExplorer

getLocalResourcesStorage

protected ResourcesStorage getLocalResourcesStorage(DataStoreParameters parameters,
                                                    java.lang.String storeName)

getResourcesStorage

public ResourcesStorage getResourcesStorage(java.lang.String name)

getResourcesStorage

public ResourcesStorage getResourcesStorage()

Specified by:

getResourcesStorage in interface DataServerExplorer

Overrides:

getResourcesStorage in class AbstractDataServerExplorer

getResourcesStorage

public ResourcesStorage getResourcesStorage(DataStoreParameters parameters)

Specified by:

getResourcesStorage in interface DataServerExplorer

Overrides:

getResourcesStorage in class AbstractDataServerExplorer

getResourcesStorage

public ResourcesStorage getResourcesStorage(DataStore dataStore)

Specified by:

getResourcesStorage in interface DataServerExplorer

Overrides:

getResourcesStorage in class AbstractDataServerExplorer

exists

public boolean exists(DataStoreParameters parameters)
               throws DataException

Specified by:

exists in interface DataServerExplorer

Overrides:

exists in class AbstractDataServerExplorer

Throws:

DataException

setCustomResources

public void setCustomResources(java.lang.String tableName,
                               java.lang.String resourcesTableName)

setCustomResources

public void setCustomResources(java.lang.String tableName,
                               java.lang.String resourcesTableName,
                               boolean readonly)

exists

public boolean exists()

Description copied from interface: JDBCServerExplorer

Check if the explorer defined by this parameters reference to a database.

Returns:

true if database exists, false if not.

getConnectionProviderStatus

public java.lang.String getConnectionProviderStatus()

setTransaction

public void setTransaction(DataTransaction transaction)

Specified by:

setTransaction in interface SupportTransactions

getTransaction

public DataTransaction getTransaction()

Specified by:

getTransaction in interface SupportTransactions