org.geotools.ows.wms.request

Interface GetFeatureInfoRequest

All Superinterfaces:

Request

All Known Implementing Classes:

AbstractGetFeatureInfoRequest, WMS1_0_0.GetFeatureInfoRequest, WMS1_1_0.GetFeatureInfoRequest, WMS1_1_1.GetFeatureInfoRequest, WMS1_3_0.GetFeatureInfoRequest

public interface GetFeatureInfoRequest
extends Request

Information required for a GetFeatureInfo request.

Q: queryableLayers is a Set - is this true? Or is order important Q: infoFormats - what does this do? Do these match up with querableLayers? Or is it a list of formats our client is willing to understand?

Author:

Richard Gould, Refractions Research

Field Summary

Fields

Modifier and Type	Field and Description
static String	FEATURE_COUNT Represents the FEATURE_COUNT parameter
static String	INFO_FORMAT Represents the INFO_FORMAT parameter
static String	QUERY_LAYERS Represents the QUERY_LAYERS parameter
static String	QUERY_X Represents the X parameter
static String	QUERY_Y Represents the Y parameter

Fields inherited from interface Request

REQUEST, SERVICE, VERSION, WMTVER

Method Summary

Modifier and Type	Method and Description
void	addQueryLayer(Layer layer) Add a Layer to the set of layers to be queried in the request.
void	setFeatureCount(int featureCount)
void	setFeatureCount(String featureCount)
void	setInfoFormat(String infoFormat) Sets the INFO_FORMAT parameter, which specifies the format of the GetFeatureInfoResponse.
void	setQueryLayers(Set<Layer> layers) An unordered set of type Layer.
void	setQueryPoint(int x, int y) The point on the image (in pixels) to be queried.

Methods inherited from interface Request

createResponse, getFinalURL, getPostContentType, getProperties, getRequestHints, performPostOutput, requiresPost, setProperty, setRequestHints

Field Detail

INFO_FORMAT

static final String INFO_FORMAT

Represents the INFO_FORMAT parameter

See Also:

Constant Field Values

FEATURE_COUNT

static final String FEATURE_COUNT

Represents the FEATURE_COUNT parameter

See Also:

Constant Field Values

QUERY_X

static final String QUERY_X

Represents the X parameter

See Also:

Constant Field Values

QUERY_Y

static final String QUERY_Y

Represents the Y parameter

See Also:

Constant Field Values

QUERY_LAYERS

static final String QUERY_LAYERS

Represents the QUERY_LAYERS parameter

See Also:

Constant Field Values

Method Detail

setQueryLayers

void setQueryLayers(Set<Layer> layers)

An unordered set of type Layer. These are the layers that the GetFeatureInfo request will be performed on.

Parameters:

layers - A Set of type Layer, each to be queried

addQueryLayer

void addQueryLayer(Layer layer)

Add a Layer to the set of layers to be queried in the request. This Layer must have queryable set to true.

Parameters:

layer - a queryable Layer

setInfoFormat

void setInfoFormat(String infoFormat)

Sets the INFO_FORMAT parameter, which specifies the format of the GetFeatureInfoResponse. Valid values are available in getInfoFormats()

Parameters:

infoFormat - a value from getInfoFormats()

setFeatureCount

void setFeatureCount(String featureCount)

Parameters:

featureCount - the maximum number of features to return in the response

setFeatureCount

void setFeatureCount(int featureCount)

Parameters:

featureCount - the maximum number of features to return in the response

setQueryPoint

void setQueryPoint(int x,
                   int y)

The point on the image (in pixels) to be queried. The image is represented by the GetMapRequest passed into the constructor.

Parameters:

x - the x point, in pixels

y - the y point, in pixels