org.gvsig.raster.tilecache.io

Class TileServerExplorer

java.lang.Object

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

org.gvsig.raster.tilecache.io.TileServerExplorer

All Implemented Interfaces:

FileFilter, DataServerExplorer, FilesystemFileFilter, FilesystemServerExplorerProvider, DataServerExplorerProvider, Disposable

public class TileServerExplorer
extends AbstractFilesystemServerExplorerProvider
implements DataServerExplorerProvider

Field Summary

Fields

Modifier and Type	Field and Description
static 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
TileServerExplorer()
TileServerExplorer(TileServerExplorerParameters parameters, DataServerExplorerProviderServices services)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(File pathname) When the source is a file then this method will check if exists a provider that can manage it
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.
boolean	canCreate()
boolean	canCreate(NewDataStoreParameters parameters)
void	create(NewDataStoreParameters parameters, boolean overwrite)
void	dispose() Disposes the current object, to allow it to close and dispose any used resources.
DataStoreParameters	get(String name)
NewDataStoreParameters	getAddParameters(String storeName) Given the store's name, returns its parameters for creation.
NewDataStoreParameters	getCreateParameters()
String	getDataStoreProviderName()
List	getDataStoreProviderNames() Return the list of provider names that this server allow.
String	getDescription()
int	getMode()
DataServerExplorerParameters	getParameters() Returns this DataServerExplorer parameters
DataStoreParameters	getParameters(File file)
String	getProviderName() Returns the DataServerExplorer's name
File	getResourcePath(DataStore dataStore, String resourceName) Return the file resource associated to this name and store.
DataServerExplorerProviderServices	getServerExplorerProviderServices()
void	initialize(FilesystemServerExplorerProviderServices serverExplorer)
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 class org.gvsig.fmap.dal.serverexplorer.filesystem.impl.AbstractFilesystemServerExplorerProvider

getResourceRootPathName, isMode, removeFileExtension

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

TileServerExplorer

public TileServerExplorer()

TileServerExplorer

public TileServerExplorer(TileServerExplorerParameters parameters,
                  DataServerExplorerProviderServices services)
                   throws InitializeException

Throws:

InitializeException

Method Detail

canCreate

public boolean canCreate()

Specified by:

canCreate in interface FilesystemServerExplorerProvider

canCreate

public boolean canCreate(NewDataStoreParameters parameters)

Specified by:

canCreate in interface FilesystemServerExplorerProvider

create

public void create(NewDataStoreParameters parameters,
          boolean overwrite)
            throws CreateException

Specified by:

create in interface FilesystemServerExplorerProvider

Throws:

CreateException

getCreateParameters

public NewDataStoreParameters getCreateParameters()
                                           throws DataException

Specified by:

getCreateParameters in interface FilesystemServerExplorerProvider

Throws:

DataException

initialize

public void initialize(FilesystemServerExplorerProviderServices serverExplorer)

Specified by:

initialize in interface FilesystemServerExplorerProvider

remove

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

Throws:

RemoveException

getDataStoreProviderName

public String getDataStoreProviderName()

Specified by:

getDataStoreProviderName in interface FilesystemFileFilter

accept

public boolean accept(File pathname)

When the source is a file then this method will check if exists a provider that can manage it

Specified by:

accept in interface FileFilter

getDescription

public String getDescription()

Specified by:

getDescription in interface FilesystemFileFilter

getParameters

public DataStoreParameters getParameters(File file)
                                  throws DataException

Throws:

DataException

getParameters

public DataServerExplorerParameters 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.

getMode

public int getMode()

Specified by:

getMode in interface FilesystemServerExplorerProvider

Overrides:

getMode in class AbstractFilesystemServerExplorerProvider

getServerExplorerProviderServices

public DataServerExplorerProviderServices getServerExplorerProviderServices()

Specified by:

getServerExplorerProviderServices in interface DataServerExplorerProvider

add

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

Description copied from interface: DataServerExplorer

Creates a new DataStore in this server.

Specified by:

add in interface DataServerExplorer

parameters - , 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.

canAdd

public boolean canAdd(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

getAddParameters

public NewDataStoreParameters getAddParameters(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

getDataStoreProviderNames

public 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

getProviderName

public 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

list

public 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 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

dispose

public void dispose()

Description copied from interface: Disposable

Disposes the current object, to allow it to close and dispose any used resources.

NOTE:After calling this method, the object may not be usable anymore.

Specified by:

dispose in interface Disposable

get

public DataStoreParameters get(String name)
                        throws DataException

Specified by:

get in interface DataServerExplorer

Throws:

DataException

getResourcePath

public File getResourcePath(DataStore dataStore,
                   String resourceName)
                     throws DataException

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

Returns:

file resource or null

Throws:

DataException