org.deegree.services.wms.protocol
Interface WMSGetFeatureInfoRequest

All Superinterfaces:

OGCWebServiceRequest

All Known Implementing Classes:

WMSGetFeatureInfoRequest_Impl

public interface WMSGetFeatureInfoRequest

extends OGCWebServiceRequest

Version:

$Revision: 1.1 $

Author:

$author$

Method Summary

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.
StyledLayerDescriptor	getStyledLayerDescriptor() returns the SLD the request is made of.

Methods inherited from interface org.deegree.services.OGCWebServiceRequest

getId, getRequest, getRequestParameter, getService, getVendorSpecificParameter, getVendorSpecificParameters, getVersion

Method Detail

getGetMapRequestCopy

public WMSGetMapRequest getGetMapRequestCopy()

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.

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

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.

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.

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.

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.