org.gvsig.fmap.dal

Interface DataServerExplorer

All Superinterfaces:

DataFactoryUnit, Disposable

All Known Subinterfaces:

DataServerExplorer_v2, DataServerExplorerProvider, DBServerExplorer, FilesystemServerExplorer, FilesystemServerExplorerProviderServices, JDBCServerExplorer, JDBCServerExplorer, RasterDataServerExplorer

All Known Implementing Classes:

AbstractDataServerExplorer, AbstractDBServerExplorer, DefaultFilesystemServerExplorer, GMLDataExplorer, JDBCServerExplorerBase, JDBCServerExplorerBase, MultiFileServerExplorer, OGRDataExplorer, PostGISRasterServerExplorer, TileServerExplorer, WCSServerExplorer, WFSServerExplorer, WMSServerExplorer, WMTSServerExplorer

public interface DataServerExplorer
extends Disposable, DataFactoryUnit

DataServerExplorer is an abstraction for any type of data server. It allows connecting to the server and browsing its contents. More specifically, this interface provides a list of the available data stores in a server.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODE_ALL
static int	MODE_FEATURE
static int	MODE_GEOMETRY
static int	MODE_RASTER

Method Summary

Modifier and Type	Method and Description
boolean	add(String provider, NewDataStoreParameters parameters, boolean overwrite) Creates a new DataStore in this server.
boolean	canAdd() Indicates whether this DataServerExplorer can create a new DataStore in the server.
boolean	canAdd(String storeName) Indicates whether this DataServerExplorer can create a new DataStore in the server, given the store name.
DataStoreParameters	get(String name)
NewDataStoreParameters	getAddParameters(String storeName) Given the store's name, returns its parameters for creation.
List	getDataStoreProviderNames() Return the list of provider names that this server allow.
DataServerExplorerParameters	getParameters() Returns this DataServerExplorer parameters
String	getProviderName() Returns the DataServerExplorer's name
File	getResourcePath(DataStore dataStore, String resourceName) Return the file resource associated to this name and store.
List	list() Provides a list of available stores in the server.
List	list(int mode) Provides a list of available stores in the server of a type.
void	remove(DataStoreParameters parameters) Removes a store from the server given its DataStoreParameters.

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

dispose

Field Detail

MODE_ALL

static final int MODE_ALL

See Also:

Constant Field Values

MODE_FEATURE

static final int MODE_FEATURE

See Also:

Constant Field Values

MODE_GEOMETRY

static final int MODE_GEOMETRY

See Also:

Constant Field Values

MODE_RASTER

static final int MODE_RASTER

See Also:

Constant Field Values

Method Detail

getProviderName

String getProviderName()

Returns the DataServerExplorer's name

Returns:

String containing this DataServerExplorer's name

canAdd

boolean canAdd()

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

Returns:

true if this DataServerExplorer can be created or false otherwise.

canAdd

boolean canAdd(String storeName)
        throws DataException

Indicates whether this DataServerExplorer can create a new DataStore in the server, given the store name.

Parameters:

storeName - store name.

Returns:

true if this DataServerExplorer can create a new store or false otherwise.

Throws:

DataException

list

List list()
   throws DataException

Provides a list of available stores in the server.

Returns:

list of DataStoreParameters

Throws:

DataException

get

DataStoreParameters get(String name)
                 throws DataException

Throws:

DataException

list

List list(int mode)
   throws DataException

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

Parameters:

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

Returns:

list of DataStoreParameters

Throws:

DataException

add

boolean add(String provider,
            NewDataStoreParameters parameters,
            boolean overwrite)
     throws DataException

Creates a new DataStore in this server.

Parameters:

parameters - , an instance of DataStoreParameters from 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

remove

void remove(DataStoreParameters parameters)
     throws DataException

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.

Parameters:

parameters -

Throws:

DataException

getAddParameters

NewDataStoreParameters getAddParameters(String storeName)
                                 throws DataException

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

Parameters:

storeName -

Returns:

parameters to create a store

Throws:

DataException

getParameters

DataServerExplorerParameters getParameters()

Returns this DataServerExplorer parameters

Returns:

an instance of DataServerExplorerParameters containing this DataServerExplorer parameters.

getDataStoreProviderNames

List getDataStoreProviderNames()

Return the list of provider names that this server allow.

Returns:

List of provider names

getResourcePath

File getResourcePath(DataStore dataStore,
                     String resourceName)
              throws DataException

Return the file resource associated to this name and store. If the resource not exists or the explorer don't support this opperation return null.

Parameters:

dataStore -

resourceName -

Returns:

file resource or null

Throws:

DataException