Package org.gvsig.fmap.dal.store.jdbc2

Interface JDBCServerExplorer

All Superinterfaces:

DataFactoryUnit, DataServerExplorer, DataServerExplorer_v2, org.gvsig.tools.dispose.Disposable, JDBCServerExplorer, org.gvsig.tools.util.PropertiesSupport, ResourceConsumer

public interface JDBCServerExplorer
extends ResourceConsumer, JDBCServerExplorer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	QUERY_DONT_ADD_PRIMARY_KEY_IN_THE_ORDER
static final int	SHOW_TABLES
static final int	SHOW_TABLES_AND_VIEWS
static final int	SHOW_VIEWS

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

FILESYSTEM_SERVER_EXPLORER_NAME, MODE_ALL, MODE_FEATURE, MODE_GEOMETRY, MODE_RASTER

Method Summary

Modifier and Type	Method	Description
boolean	add(String providerName, NewDataStoreParameters theParams, boolean overwrite)	Creates a new DataStore in this server.
boolean	canAdd()	Indicates whether this DataServerExplorer can create a new DataStore in the server.
void	dropCaches()
boolean	exists()	Check if the explorer defined by this parameters reference to a database.
JDBCStoreParameters	get(String name)
JDBCNewStoreParameters	getAddParameters()
String	getConnectionProviderStatus()
List<String>	getCreateTableSQLs(String databaseName, String schemaName, String tableName, FeatureType type)
List	getDataStoreProviderNames()	Return the list of provider names that this server allow.
FeatureType	getFeatureType(DataStoreParameters theParams)
JDBCStoreParameters	getOpenParameters()
JDBCServerExplorerParameters	getParameters()	Returns this DataServerExplorer parameters
String	getProviderName()	Returns the DataServerExplorer's name
org.gvsig.tools.resourcesstorage.ResourcesStorage	getResourcesStorage(String name)
String	getStoreName()
List<DataStoreParameters>	list(int mode)	Provides a list of available stores in the server of a type.
List<DataStoreParameters>	list(int mode, int tablesOrViews)	Provides a list of available stores in the server of a type.
DataStore	open(String tableName)
DataStore	open(DataStoreParameters params)	Open a store defined by dsp
void	remove(DataStoreParameters theParams)	Removes a store from the server given its DataStoreParameters.
void	setCustomResources(String tableName, String resourcesTableName)
void	setCustomResources(String tableName, String resourcesTableName, boolean readonly)
void	updateTableStatistics(String database, String schema, String table)

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

canAdd, exists, getAddParameters, getResourcePath, getResourcesStorage, getResourcesStorage, getResourcesStorage, list

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

close, createSQLBuilder, open

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

dispose

Methods inherited from interface org.gvsig.fmap.dal.store.jdbc.JDBCServerExplorer

execute

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

getProperties, getProperty, setProperty

Methods inherited from interface org.gvsig.fmap.dal.resource.spi.ResourceConsumer

closeResourceRequested, resourceChanged

Field Details

QUERY_DONT_ADD_PRIMARY_KEY_IN_THE_ORDER

static final String QUERY_DONT_ADD_PRIMARY_KEY_IN_THE_ORDER

See Also:

• Constant Field Values

SHOW_TABLES_AND_VIEWS

static final int SHOW_TABLES_AND_VIEWS

See Also:

• Constant Field Values

SHOW_TABLES

static final int SHOW_TABLES

See Also:

• Constant Field Values

SHOW_VIEWS

static final int SHOW_VIEWS

See Also:

• Constant Field Values

Method Details

getParameters

JDBCServerExplorerParameters getParameters()

Description copied from interface: DataServerExplorer

Returns this DataServerExplorer parameters

Specified by:

getParameters in interface DataServerExplorer

Returns:

an instance of DataServerExplorerParameters containing this DataServerExplorer parameters.

getProviderName

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

String getStoreName()

Specified by:

getStoreName in interface JDBCServerExplorer

canAdd

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.

add

boolean add(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

Parameters:

providerName -

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

list

List<DataStoreParameters> 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,

invalid reference

#MODE_FEATURE_GEOMETRY

, DataServerExplorer.MODE_RASTER

Returns:

list of DataStoreParameters

Throws:

DataException

open

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 JDBCServerExplorer

Parameters:

params -

Returns:

Throws:

DataException

open

DataStore open(String tableName)
        throws DataException

Throws:

DataException

remove

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

Parameters:

theParams -

Throws:

RemoveException

updateTableStatistics

void updateTableStatistics(String database,
 String schema,
 String table)
                    throws JDBCException

Specified by:

updateTableStatistics in interface JDBCServerExplorer

Throws:

JDBCException

getAddParameters

JDBCNewStoreParameters getAddParameters()
                                 throws DataException

Specified by:

getAddParameters in interface JDBCServerExplorer

Throws:

DataException

getOpenParameters

JDBCStoreParameters getOpenParameters()
                               throws DataException

Specified by:

getOpenParameters in interface JDBCServerExplorer

Throws:

DataException

get

JDBCStoreParameters get(String name)
                 throws DataException

Specified by:

get in interface DataServerExplorer

Specified by:

get in interface JDBCServerExplorer

Throws:

DataException

getDataStoreProviderNames

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

getFeatureType

FeatureType getFeatureType(DataStoreParameters theParams)
                    throws DataException

Specified by:

getFeatureType in interface JDBCServerExplorer

Throws:

DataException

setCustomResources

void setCustomResources(String tableName,
 String resourcesTableName)

setCustomResources

void setCustomResources(String tableName,
 String resourcesTableName,
 boolean readonly)

list

List<DataStoreParameters> list(int mode,
 int tablesOrViews)
                        throws DataException

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,

invalid reference

#MODE_FEATURE_GEOMETRY

, DataServerExplorer.MODE_RASTER

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

Returns:

list of DataStoreParameters

Throws:

DataException

exists

boolean exists()

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

Returns:

true if database exists, false if not.

getConnectionProviderStatus

String getConnectionProviderStatus()

getResourcesStorage

org.gvsig.tools.resourcesstorage.ResourcesStorage getResourcesStorage(String name)

dropCaches

void dropCaches()

getCreateTableSQLs

List<String> getCreateTableSQLs(String databaseName,
 String schemaName,
 String tableName,
 FeatureType type)
                         throws DataException

Throws:

DataException