Package com.luciad.wms.client.model
Class TLcdWMSGetFeatureInfoRequest
java.lang.Object
com.luciad.wms.client.model.TLcdWMSGetFeatureInfoRequest
- All Implemented Interfaces:
ILcdOWSRequest
A class which represents a WMS GetFeatureInfo
request. Instances of this class can be created using the
TLcdWMSClient.createGetFeatureInfoRequest()
method. This method will ensure a
request object is created that is compatible with the WMS version implemented by the WMS server.
This class can be passed to the TLcdWMSClient.getFeatureInfo(TLcdWMSGetFeatureInfoRequest)
method. This is low level API though. There is higher level API available to perform GetFeatureInfo
request, see TLcdWMSGetFeatureInfoContext
.
It currently only supports KVP encoding as there is no XML Schema available for this type of request.
- Since:
- 9.1
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionReturns a key-value pair (KVP) encoding of this request.getRestEncoding
(URI aBaseURI) Returnsnull
, REST encoding is not supported.Returns an object representing data to be used by the transportation layer (seeILcdOWSTransport
) to perform this OGC Web Service request.Returns the XML encoding of this request.void
setAdditionalParameters
(Map<String, String> aParameters) Sets a map containing additional (vendor-specific) parameters which should be used in the KVP request.void
setFeatureCount
(int aFeatureCount) Sets the optional 'feature_count' parameter of the request.void
setGetMapRequest
(TLcdWMSGetMapRequest aGetMapRequest) Sets the 'GetMap' request which created the map for which we request feature info.void
setInfoFormat
(String aFormat) Sets the mandatory 'info_format' parameter of the request.void
setQueryLayerNames
(List<String> aLayerNames) Sets mandatory 'query_layers' parameter of the request.void
setTransportData
(Object aTransportData) Sets an object representing data to be used by the transportation layer (seeILcdOWSTransport
) to perform this OGC Web Service request.void
setX
(int aX) Sets the mandatory 'X' ( or 'I') parameter of the request which specifies the pixel for which feature info is requested.void
setY
(int aY) Sets the mandatory 'Y' ( or 'J') parameter of the request which specifies the pixel for which feature info is requested.
-
Method Details
-
setGetMapRequest
Sets the 'GetMap' request which created the map for which we request feature info. The paramters of this request will be used in the 'GetFeatureInfo' request.- Parameters:
aGetMapRequest
- A valid 'GetMap' request.
-
setQueryLayerNames
Sets mandatory 'query_layers' parameter of the request.- Parameters:
aLayerNames
- A list of layer names corresponding to layers which where used in the 'GetMap' request.
-
setInfoFormat
Sets the mandatory 'info_format' parameter of the request. This specifies the format which should be returned by the server.- Parameters:
aFormat
- A mime type corresponding to a feature info format in the capabilities of the server.
-
setFeatureCount
public void setFeatureCount(int aFeatureCount) Sets the optional 'feature_count' parameter of the request. It specifies the maximum number of features per layer for which information should be returned.- Parameters:
aFeatureCount
- An integer specifying the maximum number of features, if smaller than or equal to zero, the parameter will be cleared.
-
setX
public void setX(int aX) Sets the mandatory 'X' ( or 'I') parameter of the request which specifies the pixel for which feature info is requested.- Parameters:
aX
- A value between 0 and the width of the map.
-
setY
public void setY(int aY) Sets the mandatory 'Y' ( or 'J') parameter of the request which specifies the pixel for which feature info is requested.- Parameters:
aY
- A value between 0 and the height of the map.
-
setAdditionalParameters
Sets a map containing additional (vendor-specific) parameters which should be used in the KVP request.- Parameters:
aParameters
- A Map with String keys and String values.- Since:
- 2017.1
-
getKVPEncoding
Description copied from interface:ILcdOWSRequest
Returns a key-value pair (KVP) encoding of this request. If no key-value pairs are defined, an empty map should be returned. If no key-value pair encoding is supported for this request,null
should be returned.- Specified by:
getKVPEncoding
in interfaceILcdOWSRequest
- Returns:
- the key-value pair (KVP) representation of this request.
-
getXMLEncoding
Description copied from interface:ILcdOWSRequest
Returns the XML encoding of this request. If no XML encoding is supported for this request,null
should be returned.- Specified by:
getXMLEncoding
in interfaceILcdOWSRequest
- Returns:
- the XML representation of this request.
-
setTransportData
Sets an object representing data to be used by the transportation layer (seeILcdOWSTransport
) to perform this OGC Web Service request. The type of object and the data contained in it depends on theILcdOWSTransport
object used to perform this request.- Parameters:
aTransportData
- an object representing data to be used by the transportation layer to perform this OGC Web Service request.- See Also:
-
getTransportData
Description copied from interface:ILcdOWSRequest
Returns an object representing data to be used by the transportation layer (seeILcdOWSTransport
) to perform this OGC Web Service request. The type of object and the data contained in it depends on theILcdOWSTransport
object used to perform this request. An example in the case of a HTTP transport connection is a map of request properties (seeURLConnection.getRequestProperties()
) to be used for the request.- Specified by:
getTransportData
in interfaceILcdOWSRequest
- Returns:
- an object representing data to be used by the transportation layer to perform this OGC Web Service request.
-
getRestEncoding
Returnsnull
, REST encoding is not supported.- Specified by:
getRestEncoding
in interfaceILcdOWSRequest
- Parameters:
aBaseURI
-- Returns:
null
- Since:
- 2013.0
-