org.gvsig.remoteclient.wms

Class WMSProtocolHandler

java.lang.Object

org.gvsig.remoteclient.ogc.OGCProtocolHandler

org.gvsig.remoteclient.wms.WMSProtocolHandler

Direct Known Subclasses:

WMSProtocolHandler1_1_0, WMSProtocolHandler1_1_1, WMSProtocolHandler1_3_0

public abstract class WMSProtocolHandler
extends OGCProtocolHandler

Abstract class that represents handlers to comunicate via WMS protocol.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	encoding Encoding used to parse different xml documents.
TreeMap	layers
WMSLayer	rootLayer
protected WMSServiceInformation	serviceInfo WMS metadata

Fields inherited from class org.gvsig.remoteclient.ogc.OGCProtocolHandler

downloader, host, name, port, version

Constructor Summary

Constructors

Constructor and Description
WMSProtocolHandler()

Method Summary

Modifier and Type	Method and Description
byte[]	_getMap(WMSStatus status) Builds a GetMap request that is sent to the WMS the response (image) will be redirect to the WMS client
static String	buildCapabilitiesSuitableVersionRequest(String _host, String _version) Builds the GetCapabilitiesRequest according to the OGC WMS Specifications without a VERSION, to get the highest version than a WMS supports.
void	close()
protected abstract WMSGetCapabilitiesRequest	createGetCapabilitiesRequest(WMSStatus status)
protected abstract WMSGetFeatureInfoRequest	createGetFeatureInfoRequest(WMSStatus status, int x, int y)
protected abstract WMSGetLegendGraphicRequest	createGetLegendGraphicRequest(WMSStatus status, String layerName)
protected abstract WMSGetMapRequest	createGetMapRequest(WMSStatus status)
void	getCapabilities(WMSStatus status, boolean override, ICancellable cancel) Builds a GetCapabilities request that is sent to the WMS the response will be parse to extract the data needed by the WMS client
String	getExceptionMessage(File f) Returns the exception message if the file is a XML instead of a image.
String	getFeatureInfo(WMSStatus status, int x, int y, int featureCount, ICancellable cancel) It will send a GetFeatureInfo request to the WMS Parsing the response and redirecting the info to the WMS client TODO: return a stored file instead a String.
File	getLegendGraphic_old(WMSStatus status, String layerName, ICancellable cancel)
File	getLegendGraphic(WMSStatus status, String layerName, ICancellable cancel)
File	getMap(WMSStatus status, ICancellable cancel)
URL	getMapURL(WMSStatus status, ICancellable cancel)
String	getName() returns the alfanumeric information of the layers at the specified point.
OGCServiceInformation	getServiceInformation()
protected String	parseException(byte[] data)
protected void	parseGetFeatureInfoTag(KXmlParser parser) Parses the GetFeatureInfo tag
protected void	parseGetLegendGraphicTag(KXmlParser parser) Parses the GetLegendGraphic tag
protected void	parseGetMapTag(KXmlParser parser) Parses the GetMap tag
protected void	parseRequestTag(KXmlParser parser) Parses the Request tag

Methods inherited from class org.gvsig.remoteclient.ogc.OGCProtocolHandler

addOperationByAttribute, fileToBytes, getHost, getPort, getSymbol, getVersion, parseCapabilities, parseHTTPTag, parserDcpType, setHost, setName, setPort, setVersion

Methods inherited from class java.lang.Object

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

Field Detail

encoding

protected String encoding

Encoding used to parse different xml documents.

serviceInfo

protected WMSServiceInformation serviceInfo

WMS metadata

layers

public TreeMap layers

rootLayer

public WMSLayer rootLayer

Constructor Detail

WMSProtocolHandler

public WMSProtocolHandler()

Method Detail

getName

public String getName()

returns the alfanumeric information of the layers at the specified point. the diference between the other getfeatureInfo method is that this will be implemented by each specific version because the XML from the server will be parsed and presented by a well known structure.

Overrides:

getName in class OGCProtocolHandler

Returns:

Returns the name.

getServiceInformation

public OGCServiceInformation getServiceInformation()

Specified by:

getServiceInformation in class OGCProtocolHandler

getCapabilities

public void getCapabilities(WMSStatus status,
                            boolean override,
                            ICancellable cancel)

Builds a GetCapabilities request that is sent to the WMS the response will be parse to extract the data needed by the WMS client

Parameters:

override, - if true the previous downloaded data will be overridden

getFeatureInfo

public String getFeatureInfo(WMSStatus status,
                             int x,
                             int y,
                             int featureCount,
                             ICancellable cancel)

It will send a GetFeatureInfo request to the WMS Parsing the response and redirecting the info to the WMS client

TODO: return a stored file instead a String.

_getMap

public byte[] _getMap(WMSStatus status)
               throws ServerErrorException,
                      WMSException

Builds a GetMap request that is sent to the WMS the response (image) will be redirect to the WMS client

Throws:

ServerErrorException

WMSException

getLegendGraphic_old

public File getLegendGraphic_old(WMSStatus status,
                                 String layerName,
                                 ICancellable cancel)
                          throws ServerErrorException,
                                 WMSException

Throws:

ServerErrorException

WMSException

getLegendGraphic

public File getLegendGraphic(WMSStatus status,
                             String layerName,
                             ICancellable cancel)
                      throws ServerErrorException,
                             WMSException

Throws:

ServerErrorException

WMSException

getMapURL

public URL getMapURL(WMSStatus status,
                     ICancellable cancel)
              throws ServerErrorException,
                     WMSException

Throws:

ServerErrorException

WMSException

getExceptionMessage

public String getExceptionMessage(File f)
                           throws IOException

Returns the exception message if the file is a XML instead of a image.

Parameters:

file3 -

Returns:

Throws:

IOException

getMap

public File getMap(WMSStatus status,
                   ICancellable cancel)
            throws ServerErrorException,
                   WMSException

Throws:

ServerErrorException

WMSException

parseException

protected String parseException(byte[] data)

buildCapabilitiesSuitableVersionRequest

public static String buildCapabilitiesSuitableVersionRequest(String _host,
                                                             String _version)

Builds the GetCapabilitiesRequest according to the OGC WMS Specifications without a VERSION, to get the highest version than a WMS supports.

close

public void close()

createGetMapRequest

protected abstract WMSGetMapRequest createGetMapRequest(WMSStatus status)

Parameters:

status - The WMS status

protocolHandler - The handler to parse the requests

Returns:

an object to send the GetMap requests

createGetFeatureInfoRequest

protected abstract WMSGetFeatureInfoRequest createGetFeatureInfoRequest(WMSStatus status,
                                                                        int x,
                                                                        int y)

createGetLegendGraphicRequest

protected abstract WMSGetLegendGraphicRequest createGetLegendGraphicRequest(WMSStatus status,
                                                                            String layerName)

createGetCapabilitiesRequest

protected abstract WMSGetCapabilitiesRequest createGetCapabilitiesRequest(WMSStatus status)

parseRequestTag

protected void parseRequestTag(KXmlParser parser)
                        throws IOException,
                               XmlPullParserException

Parses the Request tag

Throws:

IOException

XmlPullParserException

parseGetMapTag

protected void parseGetMapTag(KXmlParser parser)
                       throws IOException,
                              XmlPullParserException

Parses the GetMap tag

Throws:

IOException

XmlPullParserException

parseGetFeatureInfoTag

protected void parseGetFeatureInfoTag(KXmlParser parser)
                               throws IOException,
                                      XmlPullParserException

Parses the GetFeatureInfo tag

Throws:

IOException

XmlPullParserException

parseGetLegendGraphicTag

protected void parseGetLegendGraphicTag(KXmlParser parser)
                                 throws IOException,
                                        XmlPullParserException

Parses the GetLegendGraphic tag

Throws:

IOException

XmlPullParserException