public class TLcdWMSGetFeatureInfoRequest extends Object implements 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.
TLcdWMSClient
,
TLcdWMSGetFeatureInfoContext
Modifier and Type | Method and Description |
---|---|
Map |
getKVPEncoding()
Returns a key-value pair (KVP) encoding of this request.
|
URI |
getRestEncoding(URI aBaseURI)
Returns
null , REST encoding is not supported. |
Object |
getTransportData()
Returns an object representing data to be used by the transportation layer (see
ILcdOWSTransport )
to perform this OGC Web Service request. |
InputStream |
getXMLEncoding()
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
(see
ILcdOWSTransport ) 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.
|
public void setGetMapRequest(TLcdWMSGetMapRequest aGetMapRequest)
aGetMapRequest
- A valid 'GetMap' request.public void setQueryLayerNames(List<String> aLayerNames)
aLayerNames
- A list of layer names corresponding to layers which where used in the 'GetMap' request.public void setInfoFormat(String aFormat)
aFormat
- A mime type corresponding to a feature info format in the capabilities of the server.public void setFeatureCount(int aFeatureCount)
aFeatureCount
- An integer specifying the maximum number of features, if smaller than or equal to zero, the
parameter will be cleared.public void setX(int aX)
aX
- A value between 0 and the width of the map.public void setY(int aY)
aY
- A value between 0 and the height of the map.public void setAdditionalParameters(Map<String,String> aParameters)
aParameters
- A Map with String keys and String values.public Map getKVPEncoding()
ILcdOWSRequest
null
should be returned.getKVPEncoding
in interface ILcdOWSRequest
public InputStream getXMLEncoding()
ILcdOWSRequest
null
should be returned.getXMLEncoding
in interface ILcdOWSRequest
public void setTransportData(Object aTransportData)
ILcdOWSTransport
) to perform this
OGC Web Service request. The type of object and the data contained in it depends on
the ILcdOWSTransport
object used to perform this request.aTransportData
- an object representing data to be used by the transportation layer
to perform this OGC Web Service request.getTransportData()
public Object getTransportData()
ILcdOWSRequest
ILcdOWSTransport
)
to perform this OGC Web Service request. The type of object and the data contained in it depends on
the ILcdOWSTransport
object used to perform this request.
An example in the case of a HTTP transport connection is a map of request properties
(see URLConnection.getRequestProperties()
) to be used
for the request.getTransportData
in interface ILcdOWSRequest
public URI getRestEncoding(URI aBaseURI)
null
, REST encoding is not supported.getRestEncoding
in interface ILcdOWSRequest
aBaseURI
- null