org.deegree_impl.services.wms.protocol
Class WMSGetFeatureInfoRequest_Impl

java.lang.Object
  org.deegree_impl.services.OGCWebServiceRequest_Impl
      org.deegree_impl.services.wms.protocol.WMSGetFeatureInfoRequest_Impl

All Implemented Interfaces:

Marshallable, OGCWebServiceRequest, WMSGetFeatureInfoRequest

public class WMSGetFeatureInfoRequest_Impl

extends OGCWebServiceRequest_Impl

implements WMSGetFeatureInfoRequest, Marshallable

--------------------------------------------------------

Version:

$Revision: 1.1 $ $Date: 2004/04/02 06:41:56 $

Author:

Katharina Lupp Katharina Lupp

Field Summary

private java.awt.Point	clickPoint
private java.lang.String	exceptions
private int	featureCount
private WMSGetMapRequest	getMapRequestCopy
private java.lang.String	infoFormat
private java.util.ArrayList	queryLayers
private StyledLayerDescriptor	sld

Fields inherited from class org.deegree_impl.services.OGCWebServiceRequest_Impl

id, request, service, vendorSpecificParameter, version

Constructor Summary

(package private)

WMSGetFeatureInfoRequest_Impl(java.lang.String version, java.lang.String id, java.lang.String[] queryLayers, WMSGetMapRequest getMapRequestCopy, java.lang.String infoFormat, int featureCount, java.awt.Point clickPoint, java.lang.String exceptions, StyledLayerDescriptor sld, java.util.HashMap vendorSpecificParameter) Creates a new WMSFeatureInfoRequest_Impl object.

Method Summary

void	addQueryLayers(java.lang.String queryLayers) adds the
java.lang.String	exportAsXML() Produces an XML-representation of this object.
java.awt.Point	getClickPoint() The required X and Y parameters indicate a point of interest on the map.
java.lang.String	getExceptions() The optional EXCEPTIONS parameter states the manner in which errors are to be reported to the client.
int	getFeatureCount() The optional FEATURE_COUNT parameter states the maximum number of features for which feature information should be returned.
WMSGetMapRequest	getGetMapRequestCopy()
java.lang.String	getInfoFormat() The optional INFO_FORMAT indicates what format to use when returning the feature information.
java.lang.String[]	getQueryLayers() The required QUERY_LAYERS parameter states the map layer(s) from which feature information is desired to be retrieved.
java.lang.String	getRequestParameter() returns the parameter of a HTTP GET request.
StyledLayerDescriptor	getStyledLayerDescriptor() returns the SLD the request is made of.
void	setClickPoint(java.awt.Point clickPoint) sets the
void	setExceptions(java.lang.String exceptions) sets the
void	setFeatureCount(int featureCount) sets the
void	setGetMapRequestCopy(WMSGetMapRequest getMapRequestCopy) sets the
void	setInfoFormat(java.lang.String infoFormat) sets the
void	setQueryLayers(java.lang.String[] queryLayers) sets the
void	setStyledLayerDescriptor(StyledLayerDescriptor sld) sets the SLD the request is made of.
java.lang.String	toString()

Methods inherited from class org.deegree_impl.services.OGCWebServiceRequest_Impl

getId, getRequest, getService, getVendorSpecificParameter, getVendorSpecificParameters, getVersion, putVendorSpecificParameter, setId, setRequest, setService, setVendorSpecificParameter, setVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.deegree.services.OGCWebServiceRequest

getId, getRequest, getService, getVendorSpecificParameter, getVendorSpecificParameters, getVersion

Field Detail

queryLayers

private java.util.ArrayList queryLayers

clickPoint

private java.awt.Point clickPoint

exceptions

private java.lang.String exceptions

infoFormat

private java.lang.String infoFormat

sld

private StyledLayerDescriptor sld

getMapRequestCopy

private WMSGetMapRequest getMapRequestCopy

featureCount

private int featureCount

Constructor Detail

WMSGetFeatureInfoRequest_Impl

WMSGetFeatureInfoRequest_Impl(java.lang.String version,
                              java.lang.String id,
                              java.lang.String[] queryLayers,
                              WMSGetMapRequest getMapRequestCopy,
                              java.lang.String infoFormat,
                              int featureCount,
                              java.awt.Point clickPoint,
                              java.lang.String exceptions,
                              StyledLayerDescriptor sld,
                              java.util.HashMap vendorSpecificParameter)

Creates a new WMSFeatureInfoRequest_Impl object.

Parameters:

version -

id -

queryLayers -

getMapRequestCopy -

infoFormat -

featureCount -

clickPoint -

exceptions -

sld -

vendorSpecificParameter -

Method Detail

getGetMapRequestCopy

public WMSGetMapRequest getGetMapRequestCopy()

Specified by:

getGetMapRequestCopy in interface WMSGetFeatureInfoRequest

setGetMapRequestCopy

public void setGetMapRequestCopy(WMSGetMapRequest getMapRequestCopy)

sets the

getQueryLayers

public java.lang.String[] getQueryLayers()

The required QUERY_LAYERS parameter states the map layer(s) from which feature information is desired to be retrieved. Its value is a comma- separated list of one or more map layers that are returned as an array. This parameter shall contain at least one layer name, but may contain fewer layers than the original GetMap request.

If any layer in this list is not contained in the Capabilities XML of the WMS, the results are undefined and the WMS shall produce an exception response.

Specified by:

getQueryLayers in interface WMSGetFeatureInfoRequest

addQueryLayers

public void addQueryLayers(java.lang.String queryLayers)

adds the

setQueryLayers

public void setQueryLayers(java.lang.String[] queryLayers)

sets the

getInfoFormat

public java.lang.String getInfoFormat()

The optional INFO_FORMAT indicates what format to use when returning the feature information. Supported values for a GetFeatureInfo request on a WMS instance are listed as MIME types in one or more elements inside the element of its Capabilities XML. The entire MIME type string in is used as the value of the INFO_FORMAT parameter. In an HTTP environment, the MIME type shall be set on the returned object using the Content-type entity header.

EXAMPLE: The parameter INFO_FORMAT=application/vnd.ogc.gml requests that the feature information be formatted in Geography Markup Language (GML).

Specified by:

getInfoFormat in interface WMSGetFeatureInfoRequest

setInfoFormat

public void setInfoFormat(java.lang.String infoFormat)

sets the

getFeatureCount

public int getFeatureCount()

The optional FEATURE_COUNT parameter states the maximum number of features for which feature information should be returned. Its value is a positive integer greater than zero. The default value is 1 if this parameter is omitted.

Specified by:

getFeatureCount in interface WMSGetFeatureInfoRequest

setFeatureCount

public void setFeatureCount(int featureCount)

sets the

getClickPoint

public java.awt.Point getClickPoint()

The required X and Y parameters indicate a point of interest on the map. X and Y identify a single point within the borders of the WIDTH and HEIGHT parameters of the embedded GetMap request. The origin is set to (0,0) centered in the pixel at the upper left corner; X increases to the right and Y increases downward. X and Y are retruned as java.awt.Point class/datastructure.

Specified by:

getClickPoint in interface WMSGetFeatureInfoRequest

setClickPoint

public void setClickPoint(java.awt.Point clickPoint)

sets the

getExceptions

public java.lang.String getExceptions()

The optional EXCEPTIONS parameter states the manner in which errors are to be reported to the client. The default value is application/vnd.ogc.se_xml if this parameter is absent from the request. At present, not other values are defined for the WMS GetFeatureInfo request.

Specified by:

getExceptions in interface WMSGetFeatureInfoRequest

setExceptions

public void setExceptions(java.lang.String exceptions)

sets the

getStyledLayerDescriptor

public StyledLayerDescriptor getStyledLayerDescriptor()

returns the SLD the request is made of. This implies that a 'simple' HTTP GET-Request will be transformed into a valid SLD. This is mandatory within a JaGo WMS.

This mean even if a GetMap request is send using the HTTP GET method, an implementing class has to map the request to a SLD data sructure.

Specified by:

getStyledLayerDescriptor in interface WMSGetFeatureInfoRequest

setStyledLayerDescriptor

public void setStyledLayerDescriptor(StyledLayerDescriptor sld)

sets the SLD the request is made of. This implies that a 'simple' HTTP GET-Request or a part of it will be transformed into a valid SLD. For convenience it is asumed that the SLD names just a single layer to generate display elements of.

exportAsXML

public java.lang.String exportAsXML()

Description copied from interface: Marshallable

Produces an XML-representation of this object.

Specified by:

exportAsXML in interface Marshallable

Returns:

XML-representation of this object

toString

public java.lang.String toString()

Overrides:

toString in class OGCWebServiceRequest_Impl

Returns:

getRequestParameter

public java.lang.String getRequestParameter()
                                     throws WebServiceException

returns the parameter of a HTTP GET request.

Specified by:

getRequestParameter in interface OGCWebServiceRequest

Overrides:

getRequestParameter in class OGCWebServiceRequest_Impl

Throws:

WebServiceException