| org.deegree.ogcwebservices.wms.operation.WMSRequestBase
 org.deegree.ogcwebservices.wms.operation.GetFeatureInfo
| GetFeatureInfo | | public class GetFeatureInfo extends WMSRequestBase (Code) | |
author:
Katharina Lupp Katharina Lupp
version:
$Revision: 9348 $ $Date: 2007-12-27 08:59:14 -0800 (Thu, 27 Dec 2007) $ |
| Method Summary | |
| public void | addQueryLayers(String queryLayers)
| | public static GetFeatureInfo | create(String version, String id, String[] queryLayers, GetMap getMapRequestCopy, String infoFormat, int featureCount, java.awt.Point clickPoint, String exceptions, StyledLayerDescriptor sld, Map<String, String> vendorSpecificParameter)
creates a WMSFeatureInfoRequest from the request parameters. | | public static GetFeatureInfo | create(Map<String, String> model)
creates a WMSFeatureInfoRequest from a HashMap that
contains the request parameters as key-value-pairs. | | public 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. | | public String | getExceptions()
The optional EXCEPTIONS parameter states the manner in which errors are
to be reported to the client. | | public int | getFeatureCount()
The optional FEATURE_COUNT parameter states the maximum number of
features for which feature information should be returned. | | public GetMap | getGetMapRequestCopy()
| | public String | getInfoFormat()
The optional INFO_FORMAT indicates what format to use when returning the
feature information. | | public String[] | getQueryLayers()
The required QUERY_LAYERS parameter states the map layer(s) from which
feature information is desired to be retrieved. | | public String | getRequestParameter()
returns the parameter of a HTTP GET request. | | public StyledLayerDescriptor | getStyledLayerDescriptor()
returns the SLD the request is made of. | | public boolean | isInfoFormatDefault()
| | public void | setClickPoint(Point clickPoint)
| | public void | setExceptions(String exceptions)
| | public void | setFeatureCount(int featureCount)
| | public void | setGetMapRequestCopy(GetMap getMapRequestCopy)
| | public void | setInfoFormat(String infoFormat)
| | public void | setQueryLayers(String[] queryLayers)
| | public void | setStyledLayerDescriptor(StyledLayerDescriptor sld)
sets the SLD the request is made of. | | public String | toString()
|
| addQueryLayers | | public void addQueryLayers(String queryLayers)(Code) | | adds the
Parameters:
queryLayers - |
| create | | public static GetFeatureInfo create(String version, String id, String[] queryLayers, GetMap getMapRequestCopy, String infoFormat, int featureCount, java.awt.Point clickPoint, String exceptions, StyledLayerDescriptor sld, Map<String, String> vendorSpecificParameter)(Code) | | creates a WMSFeatureInfoRequest from the request parameters.
an instance of WMSFeatureInfoRequest
Parameters:
version - VERSION=version (R): Request version.
Parameters:
id - the request id
Parameters:
queryLayers - QUERY_LAYERS=layer_list (R): Comma-separated list of one ormore layers to be queried.
Parameters:
getMapRequestCopy - <map_request_copy> (R): Partial copy of the Map requestparameters that generated the map for which information isdesired.
Parameters:
infoFormat - INFO_FORMAT=output_format (O): Return format of featureinformation (MIME type).
Parameters:
featureCount - FEATURE_COUNT=number (O): Number of features about which toreturn information (default=1).
Parameters:
clickPoint - X=pixel_column (R): X coordinate in pixels of feature(measured from upper left corner=0) Y=pixel_row (R): Ycoordinate in pixels of feature (measured from upper leftcorner=0)
Parameters:
exceptions - EXCEPTIONS=exception_format (O): The format in whichexceptions are to be reported by the WMS(default=application/vnd.ogc.se_xml).
Parameters:
sld - StyledLayerDescriptor
Parameters:
vendorSpecificParameter - Vendor-specific parameters (O): Optional experimentalparameters. |
| getClickPoint | | public Point getClickPoint()(Code) | | 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.
the point of interest |
| getExceptions | | public String getExceptions()(Code) | | 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.
the exception format |
| getFeatureCount | | public int getFeatureCount()(Code) | | 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.
the count |
| getGetMapRequestCopy | | public GetMap getGetMapRequestCopy()(Code) | | |
| getInfoFormat | | public String getInfoFormat()(Code) | | 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).
the format |
| getQueryLayers | | public String[] getQueryLayers()(Code) | | 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.
the layer names |
| getStyledLayerDescriptor | | public StyledLayerDescriptor getStyledLayerDescriptor()(Code) | | 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.
the sld |
| isInfoFormatDefault | | public boolean isInfoFormatDefault()(Code) | | whether the info format is the default setting |
| setClickPoint | | public void setClickPoint(Point clickPoint)(Code) | | sets the
Parameters:
clickPoint - |
| setExceptions | | public void setExceptions(String exceptions)(Code) | | sets the
Parameters:
exceptions - |
| setFeatureCount | | public void setFeatureCount(int featureCount)(Code) | | sets the
Parameters:
featureCount - |
| setGetMapRequestCopy | | public void setGetMapRequestCopy(GetMap getMapRequestCopy)(Code) | | sets the
Parameters:
getMapRequestCopy - |
| setInfoFormat | | public void setInfoFormat(String infoFormat)(Code) | | sets the
Parameters:
infoFormat - |
| setQueryLayers | | public void setQueryLayers(String[] queryLayers)(Code) | | sets the
Parameters:
queryLayers - |
| setStyledLayerDescriptor | | public void setStyledLayerDescriptor(StyledLayerDescriptor sld)(Code) | | 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.
Parameters:
sld - |
| Methods inherited from org.deegree.ogcwebservices.wms.operation.WMSRequestBase | public String getServiceName()(Code)(Java Doc)
|
|
|