org.gvsig.fmap.dal.store.jdbc

Class JDBCServerExplorer

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

All Implemented Interfaces:

DataServerExplorer, ResourceConsumer, DBServerExplorer, DataServerExplorerProvider, JDBCHelperUser, Disposable

Direct Known Subclasses:

H2ServerExplorer, PostgreSQLServerExplorer

public class JDBCServerExplorer
extends AbstractDBServerExplorer
implements JDBCHelperUser

Field Summary

Fields

Modifier and Type	Field and Description
protected JDBCHelper	helper
static java.lang.String	NAME

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

MODE_ALL, MODE_FEATURE, MODE_GEOMETRY, MODE_RASTER

Constructor Summary

Constructors

Constructor and Description
JDBCServerExplorer(JDBCServerExplorerParameters parameters, DataServerExplorerProviderServices services)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(java.lang.String providerName, NewDataStoreParameters ndsp, boolean overwrite) Creates a new DataStore in this server.
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
void	closeDone() Called when the resource was close
boolean	closeResourceRequested(ResourceProvider resource)
protected boolean	compare(java.lang.Object str1, java.lang.Object str2)
protected JDBCHelper	createHelper()
protected JDBCStoreParameters	createStoreParams()
protected void	doDispose() Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.
DataStoreParameters	get(java.lang.String name)
NewDataStoreParameters	getAddParameters() Return a instance of NewDataStoreParameters to fill
java.util.List	getDataStoreProviderNames() Return the list of provider names that this server allow.
FeatureType	getFeatureType(DataStoreParameters dsp) Return the FeatureType of the store of dsp store
protected JDBCHelper	getHelper()
protected JDBCServerExplorerParameters	getJDBCParameters()
protected DataManagerProviderServices	getManager()
DataStoreParameters	getOpenParameters()
java.lang.String	getProviderName() Get the user name
java.lang.String	getStoreName() Return the name of DataStoreProvider returned by this ServerExplorer
boolean	hasGeometrySupport()
java.util.List	list() Provides a list of available stores in the server.
java.util.List	list(boolean showInformationDBTables)
java.util.List	list(int mode) Provides a list of available stores in the server of a type.
java.util.List	list(int mode, boolean showInformationDBTables)
void	open() Open connection to the server
DataStore	open(DataStoreParameters dsp) Open a store defined by dsp
void	opendDone() Called when the resource was open
void	remove(DataStoreParameters dsp) Removes a store from the server given its DataStoreParameters.
void	resourceChanged(ResourceProvider resource)
void	updateTableStatistics(java.lang.String tableName)

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

canAdd, getAddParameters

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

getParameters, getResourcePath, getServerExplorerProviderServices

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

getServerExplorerProviderServices

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

getParameters, getResourcePath

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

dispose

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

helper

protected JDBCHelper helper

Constructor Detail

JDBCServerExplorer

public JDBCServerExplorer(JDBCServerExplorerParameters parameters,
                  DataServerExplorerProviderServices services)
                   throws InitializeException

Throws:

InitializeException

Method Detail

getJDBCParameters

protected JDBCServerExplorerParameters getJDBCParameters()

createHelper

protected JDBCHelper createHelper()
                           throws InitializeException

Throws:

InitializeException

getHelper

protected JDBCHelper getHelper()

list

public java.util.List list()
                    throws DataException

Description copied from interface: DataServerExplorer

Provides a list of available stores in the server.

Specified by:

list in interface DataServerExplorer

Returns:

list of DataStoreParameters

Throws:

DataException

list

public java.util.List list(boolean showInformationDBTables)
                    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

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

getManager

protected DataManagerProviderServices getManager()

hasGeometrySupport

public boolean hasGeometrySupport()

closeResourceRequested

public boolean closeResourceRequested(ResourceProvider resource)

Specified by:

closeResourceRequested in interface ResourceConsumer

resourceChanged

public void resourceChanged(ResourceProvider resource)

Specified by:

resourceChanged in interface ResourceConsumer

remove

public void remove(DataStoreParameters dsp)
            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

Throws:

RemoveException

getOpenParameters

public DataStoreParameters getOpenParameters()
                                      throws DataException

Throws:

DataException

getAddParameters

public NewDataStoreParameters getAddParameters()
                                        throws DataException

Description copied from interface: DBServerExplorer

Return a instance of NewDataStoreParameters to fill

Specified by:

getAddParameters in interface DBServerExplorer

Returns:

Throws:

DataException

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

open

public DataStore open(DataStoreParameters dsp)
               throws DataException

Description copied from interface: DBServerExplorer

Open a store defined by dsp

Specified by:

open in interface DBServerExplorer

Returns:

Throws:

DataException

checkIsMine

protected void checkIsMine(DataStoreParameters dsp)

compare

protected boolean compare(java.lang.Object str1,
              java.lang.Object str2)

createStoreParams

protected JDBCStoreParameters createStoreParams()
                                         throws InitializeException,
                                                ProviderNotRegisteredException

Throws:

InitializeException

ProviderNotRegisteredException

list

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

Throws:

DataException

open

public void open()
          throws OpenException

Description copied from interface: DBServerExplorer

Open connection to the server

Specified by:

open in interface DBServerExplorer

Throws:

OpenException

close

public void close()
           throws CloseException

Description copied from interface: DBServerExplorer

Close connection to the server

Specified by:

close in interface DBServerExplorer

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

getProviderName

public java.lang.String getProviderName()

Description copied from interface: JDBCHelperUser

Get the user name

Specified by:

getProviderName in interface DataServerExplorer

Specified by:

getProviderName in interface JDBCHelperUser

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 class AbstractDBServerExplorer

Returns:

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

Returns:

true if this DataServerExplorer can be created or false otherwise.

getFeatureType

public FeatureType getFeatureType(DataStoreParameters dsp)
                           throws DataException

Description copied from interface: DBServerExplorer

Return the FeatureType of the store of dsp store

Specified by:

getFeatureType in interface DBServerExplorer

Returns:

Throws:

DataException

add

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

Description copied from interface: DataServerExplorer

Creates a new DataStore in this server.

Specified by:

add in interface DataServerExplorer

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

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

Returns:

List of provider names

updateTableStatistics

public void updateTableStatistics(java.lang.String tableName)
                           throws JDBCExecuteSQLException

Throws:

JDBCExecuteSQLException

get

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

Specified by:

get in interface DataServerExplorer

Overrides:

get in class AbstractDataServerExplorer

Throws:

DataException