org.gvsig.fmap.dal.serverexplorer.filesystem.impl

Class DefaultFilesystemServerExplorer

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

org.gvsig.fmap.dal.spi.AbstractDataServerExplorer

org.gvsig.fmap.dal.serverexplorer.filesystem.impl.DefaultFilesystemServerExplorer

All Implemented Interfaces:

java.io.FileFilter, DataFactoryUnit, DataServerExplorer, DataServerExplorer_v2, FilesystemFileFilter, FilesystemServerExplorer, FilesystemServerExplorerProviderServices, DataServerExplorerProvider, Disposable, PropertiesSupport

public class DefaultFilesystemServerExplorer
extends AbstractDataServerExplorer
implements FilesystemServerExplorerProviderServices, FilesystemFileFilter

Field Summary

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

LOGGER

Fields inherited from interface org.gvsig.fmap.dal.serverexplorer.filesystem.FilesystemServerExplorer

NAME

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
DefaultFilesystemServerExplorer(FilesystemServerExplorerParameters parameters, DataServerExplorerProviderServices services)

Method Summary

Modifier and Type	Method and Description
boolean	accept(java.io.File pathname)
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.
boolean	canAdd(java.lang.String storeName) Indicates whether this DataServerExplorer can create a new DataStore in the server, given the store name.
DataStoreParameters	createStoreParameters(java.io.File file)
DataStoreParameters	createStoreParameters(java.io.File file, java.lang.String providerName)
protected void	doDispose() Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.
boolean	exists(DataStoreParameters parameters)
DataStoreParameters	get(java.lang.String name)
NewDataStoreParameters	getAddParameters(java.io.File file)
NewDataStoreParameters	getAddParameters(java.lang.String storeName) Given the store's name, returns its parameters for creation.
java.io.File	getCurrentPath()
java.lang.String	getDataStoreProviderName()
java.util.List	getDataStoreProviderNames() Return the list of provider names that this server allow.
java.lang.String	getDescription()
FilesystemFileFilter	getFilter(int mode, java.lang.String description)
java.util.Iterator<FilesystemServerExplorerProvider>	getFilters()
java.util.Iterator	getFilters(int mode)
FilesystemFileFilter	getGenericFilter()
DataStoreParameters	getParametersFor(java.io.File file, java.lang.String providerName, boolean checksExist)
java.lang.String	getProviderName() Returns the DataServerExplorer's name
java.lang.String	getProviderName(java.io.File file)
java.util.List<java.lang.String>	getProviderNameList(java.io.File file)
java.util.List<FilesystemServerExplorerProvider>	getProviders()
java.util.List	getProviders(int mode)
java.io.File	getResourcePath(DataStore dataStore, java.lang.String resourceName) Deprecated.
ResourcesStorage	getResourcesStorage(DataStore dataStore)
ResourcesStorage	getResourcesStorage(DataStoreParameters parameters)
java.io.File	getRoot()
java.util.List	list() Provides a list of available stores in the server.
java.util.List	list(int mode) Provides a list of available stores in the server of a type.
DataStore	open(java.io.File file)
void	remove(DataStoreParameters dsp) Removes a store from the server given its DataStoreParameters.
void	setCurrentPath(java.io.File path)

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

close, createSQLBuilder, getParameters, getProperties, getProperty, getResourcesStorage, getServerExplorerProviderServices, open, open, 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.spi.DataServerExplorerProvider

getServerExplorerProviderServices

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

getParameters, getResourcesStorage

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

dispose

Constructor Detail

DefaultFilesystemServerExplorer

public DefaultFilesystemServerExplorer(FilesystemServerExplorerParameters parameters,
                                       DataServerExplorerProviderServices services)
                                throws InitializeException

Throws:

InitializeException

Method Detail

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

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

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

setCurrentPath

public void setCurrentPath(java.io.File path)
                    throws FileNotFoundException

Specified by:

setCurrentPath in interface FilesystemServerExplorer

Throws:

FileNotFoundException

getCurrentPath

public java.io.File getCurrentPath()

Specified by:

getCurrentPath in interface FilesystemServerExplorer

getRoot

public java.io.File getRoot()

Specified by:

getRoot in interface FilesystemServerExplorer

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

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

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.

getProviderName

public java.lang.String getProviderName()

Description copied from interface: DataServerExplorer

Returns the DataServerExplorer's name

Specified by:

getProviderName in interface DataServerExplorer

Returns:

String containing this DataServerExplorer's name

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

Returns:

parameters to create a store

Throws:

DataException

canAdd

public boolean canAdd(java.lang.String storeName)
               throws DataException

Description copied from interface: DataServerExplorer

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

Specified by:

canAdd in interface DataServerExplorer

Parameters:

storeName - store name.

Returns:

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

Throws:

DataException

createStoreParameters

public DataStoreParameters createStoreParameters(java.io.File file,
                                                 java.lang.String providerName)
                                          throws DataException

Specified by:

createStoreParameters in interface FilesystemServerExplorer

Throws:

DataException

createStoreParameters

public DataStoreParameters createStoreParameters(java.io.File file)
                                          throws DataException

Specified by:

createStoreParameters in interface FilesystemServerExplorer

Throws:

DataException

getParametersFor

public DataStoreParameters getParametersFor(java.io.File file,
                                            java.lang.String providerName,
                                            boolean checksExist)
                                     throws DataException

Throws:

DataException

getProviderNameList

public java.util.List<java.lang.String> getProviderNameList(java.io.File file)

Specified by:

getProviderNameList in interface FilesystemServerExplorer

getProviderName

public java.lang.String getProviderName(java.io.File file)

Specified by:

getProviderName in interface FilesystemServerExplorer

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

getProviders

public java.util.List<FilesystemServerExplorerProvider> getProviders()

getProviders

public java.util.List getProviders(int mode)

getFilters

public java.util.Iterator getFilters(int mode)

Specified by:

getFilters in interface FilesystemServerExplorer

getFilters

public java.util.Iterator<FilesystemServerExplorerProvider> getFilters()

Specified by:

getFilters in interface FilesystemServerExplorer

getFilter

public FilesystemFileFilter getFilter(int mode,
                                      java.lang.String description)

Specified by:

getFilter in interface FilesystemServerExplorer

getGenericFilter

public FilesystemFileFilter getGenericFilter()

Specified by:

getGenericFilter in interface FilesystemServerExplorer

getDataStoreProviderName

public java.lang.String getDataStoreProviderName()

Specified by:

getDataStoreProviderName in interface FilesystemFileFilter

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface FilesystemFileFilter

accept

public boolean accept(java.io.File pathname)

Specified by:

accept in interface java.io.FileFilter

open

public DataStore open(java.io.File file)
               throws DataException,
                      ValidateDataParametersException

Throws:

DataException

ValidateDataParametersException

getAddParameters

public NewDataStoreParameters getAddParameters(java.io.File file)
                                        throws DataException

Specified by:

getAddParameters in interface FilesystemServerExplorer

Throws:

DataException

getResourcePath

@Deprecated
public java.io.File getResourcePath(DataStore dataStore,
                                                java.lang.String resourceName)
                                         throws DataException

Deprecated.

Description copied from interface: DataServerExplorer

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.

Specified by:

getResourcePath in interface DataServerExplorer

Overrides:

getResourcePath in class AbstractDataServerExplorer

Returns:

file resource or null

Throws:

DataException

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

get

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

Specified by:

get in interface DataServerExplorer

Overrides:

get in class AbstractDataServerExplorer

Throws:

DataException

exists

public boolean exists(DataStoreParameters parameters)
               throws DataException

Specified by:

exists in interface DataServerExplorer

Overrides:

exists in class AbstractDataServerExplorer

Throws:

DataException