org.gvsig.raster.wms.io

Class WMSServerExplorer

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

org.gvsig.fmap.dal.spi.AbstractDataServerExplorer

org.gvsig.raster.wms.io.WMSServerExplorer

All Implemented Interfaces:

RasterDataServerExplorer, DataFactoryUnit, DataServerExplorer, DataServerExplorer_v2, DataServerExplorerProvider, Disposable

public class WMSServerExplorer
extends AbstractDataServerExplorer
implements RasterDataServerExplorer, DataServerExplorerProvider

Explorer for a WMS server

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

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

TIME

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

MODE_ALL, MODE_FEATURE, MODE_GEOMETRY, MODE_RASTER

Constructor Summary

Constructors

Constructor and Description
WMSServerExplorer(WMSServerExplorerParameters parameters, DataServerExplorerProviderServices services)

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.
void	connect(ICancellable cancellable) Connect to the server
void	connect(ICancellable cancellable, boolean updateCache) Connects to the server and throws a getCapabilities.
String	getAbstract() Gets the description of this service
NewDataStoreParameters	getAddParameters(String storeName) Given the store's name, returns its parameters for creation.
Rectangle2D	getBoundingBox(String[] layerNames, String srs)
String	getDataStoreProviderName() Gets the provider's name
List<?>	getDataStoreProviderNames() Return the list of provider names that this server allow.
String	getDescription()
String[]	getFormats() Gets the list of raster formats supported by the server
String	getHost() Gets the host URI
String[]	getInfoFormats() Gets the list of raster information formats supported by the server
WMSLayerNode	getLayer(String layerName) Gets a layer using its name
Rectangle2D	getLayersExtent(String[] layerName, String srs)
WMSLayerNode	getLayerTree() Gets a tree of nodes which represents the server information
Hashtable	getOnlineResources() Gets the online resources
WMSServerExplorerParameters	getParameters() Returns this DataServerExplorer parameters
String	getProviderName() Returns the DataServerExplorer's name
DataServerExplorerProviderServices	getServerExplorerProviderServices()
String	getServerType() Gets the server title
String	getServiceTitle()
DataStoreParameters	getStoredParameters() Returns the internal parameters, that is, the parameters that are not tiled.
String	getTitle() Gets the title
String	getVersion() Gets the protocol supported by the server
boolean	isConnected() Returns true if this provider is connected to the server
boolean	isHostReachable() Checks if the network and host are reachable
boolean	isHostReachable(int timeout) Checks if the network and host are reachable
boolean	isQueryable()
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.spi.AbstractDataServerExplorer

createSQLBuilder, doDispose, get, getResourcePath

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

get, getResourcePath

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

dispose

Field Detail

NAME

public static final String NAME

Constructor Detail

WMSServerExplorer

public WMSServerExplorer(WMSServerExplorerParameters parameters,
                         DataServerExplorerProviderServices services)
                  throws InitializeException

Throws:

InitializeException

Method Detail

getDataStoreProviderName

public String getDataStoreProviderName()

Gets the provider's name

Returns:

getDescription

public String getDescription()

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

getParameters

public WMSServerExplorerParameters getParameters()

Description copied from interface: DataServerExplorer

Returns this DataServerExplorer parameters

Specified by:

getParameters in interface DataServerExplorer

Overrides:

getParameters in class AbstractDataServerExplorer

Returns:

an instance of DataServerExplorerParameters containing this DataServerExplorer parameters.

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

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

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

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

connect

public void connect(ICancellable cancellable,
                    boolean updateCache)
             throws ConnectException

Connects to the server and throws a getCapabilities. This loads the basic information to make requests.

Throws:

RemoteServiceException

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

isConnected

public boolean isConnected()

Returns true if this provider is connected to the server

Returns:

getAbstract

public String getAbstract()

Gets the description of this service

Returns:

getFormats

public String[] getFormats()

Gets the list of raster formats supported by the server

Returns:

getInfoFormats

public String[] getInfoFormats()

Gets the list of raster information formats supported by the server

Returns:

getLayerTree

public WMSLayerNode getLayerTree()

Gets a tree of nodes which represents the server information

Returns:

getServerType

public String getServerType()

Gets the server title

Returns:

getOnlineResources

public Hashtable getOnlineResources()

Gets the online resources

Returns:

getVersion

public String getVersion()

Gets the protocol supported by the server

Returns:

getLayersExtent

public Rectangle2D getLayersExtent(String[] layerName,
                                   String srs)

getLayer

public WMSLayerNode getLayer(String layerName)

Gets a layer using its name

Parameters:

layerName -

Returns:

getHost

public String getHost()

Gets the host URI

Returns:

getBoundingBox

public Rectangle2D getBoundingBox(String[] layerNames,
                                  String srs)

isQueryable

public boolean isQueryable()

getTitle

public String getTitle()

Gets the title

Returns:

getServiceTitle

public String getServiceTitle()

Returns:

The title of the service offered by the WMS server.

getServerExplorerProviderServices

public DataServerExplorerProviderServices getServerExplorerProviderServices()

Specified by:

getServerExplorerProviderServices in interface DataServerExplorerProvider

Overrides:

getServerExplorerProviderServices in class AbstractDataServerExplorer