Package com.luciad.wms.client.model
Class TLcdWMSDescribeLayerRequest
java.lang.Object
com.luciad.wms.client.model.TLcdWMSDescribeLayerRequest
- All Implemented Interfaces:
ILcdOWSRequest
A class which represents a WMS
DescribeLayer
request.
Instances of this class can be created using the
TLcdWMSClient.createDescribeLayerRequest()
method.
This method will ensure a request object is created that is compatible with the WMS version
implemented by the WMS server.- 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
setNamedLayer
(String aLayerName) Sets the layer to display in the result.void
setNamedLayers
(List<String> aLayerNames) Sets the list of layers which will be displayed in the result.void
setTransportData
(Object aTransportData) Sets an object representing data to be used by the transportation layer (seeILcdOWSTransport
) to perform this OGC Web Service request.
-
Method Details
-
setNamedLayer
Sets the layer to display in the result. All previously set names will be cleared.- Parameters:
aLayerName
- A valid layer name.- See Also:
-
setNamedLayers
Sets the list of layers which will be displayed in the result. The names in the list should correspond to layer names in the capabilities document of the server. All previously set names will be cleared.- Parameters:
aLayerNames
- A list containing layer names.- See Also:
-
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
-