org.gvsig.raster.postgis.io

Class PostGISRasterServerExplorer

java.lang.Object

org.gvsig.raster.postgis.io.PostGISRasterServerExplorer

All Implemented Interfaces:

RasterDataServerExplorer, DataFactoryUnit, DataServerExplorer, DataServerExplorerProvider, Disposable

public class PostGISRasterServerExplorer
extends java.lang.Object
implements RasterDataServerExplorer, DataServerExplorerProvider

Server explorer for a PostGIS raster server

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface org.gvsig.fmap.dal.coverage.store.RasterDataServerExplorer

TIME

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
PostGISRasterServerExplorer(PostGISRasterServerExplorerParameters parameters, DataServerExplorerProviderServices services)

Method Summary

Modifier and Type	Method and Description
boolean	add(java.lang.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(java.lang.String storeName) Indicates whether this DataServerExplorer can create a new DataStore in the server, given the store name.
void	connect(ICancellable cancellable) Connect to the server
void	dispose() Disposes the current object, to allow it to close and dispose any used resources.
NewDataStoreParameters	getAddParameters(java.lang.String storeName) Given the store's name, returns its parameters for creation.
java.util.List<?>	getDataStoreProviderNames() Return the list of provider names that this server allow.
DataServerExplorerParameters	getParameters() Returns this DataServerExplorer parameters
java.lang.String	getProviderName() Returns the DataServerExplorer's name
DataServerExplorerProviderServices	getServerExplorerProviderServices()
DataStoreParameters	getStoredParameters() Returns the internal parameters, that is, the parameters that are not tiled.
boolean	isHostReachable() Checks if the network and host are reachable
boolean	isHostReachable(int timeout) Checks if the network and host are reachable
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.
void	remove(DataStoreParameters parameters) Removes a store from the server given its DataStoreParameters.

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.DataServerExplorer

exists, get, getResourcePath, getResourcesStorage, getResourcesStorage, getResourcesStorage

Field Detail

NAME

public static final java.lang.String NAME

Constructor Detail

PostGISRasterServerExplorer

public PostGISRasterServerExplorer(PostGISRasterServerExplorerParameters parameters,
                                   DataServerExplorerProviderServices services)
                            throws InitializeException

Throws:

InitializeException

Method Detail

getServerExplorerProviderServices

public DataServerExplorerProviderServices getServerExplorerProviderServices()

Specified by:

getServerExplorerProviderServices in interface DataServerExplorerProvider

add

public boolean add(java.lang.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(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

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

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

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.

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

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

remove

public void remove(DataStoreParameters parameters)
            throws DataException

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:

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

getStoredParameters

public DataStoreParameters getStoredParameters()

Description copied from interface: RasterDataServerExplorer

Returns the internal parameters, that is, the parameters that are not tiled.

Specified by:

getStoredParameters in interface RasterDataServerExplorer

Returns:

connect

public void connect(ICancellable cancellable)
             throws ConnectException

Description copied from interface: RasterDataServerExplorer

Connect to the server

Specified by:

connect in interface RasterDataServerExplorer

Throws:

ConnectException

isHostReachable

public boolean isHostReachable(int timeout)

Checks if the network and host are reachable

Specified by:

isHostReachable in interface RasterDataServerExplorer

Parameters:

timeout - for the host

Returns:

true if both are reachable and false if they are not

isHostReachable

public boolean isHostReachable()

Checks if the network and host are reachable

Specified by:

isHostReachable in interface RasterDataServerExplorer

Returns:

true if both are reachable and false if they are not