com.luciad.wms.client.model

LuciadLightspeedClass TLcdWMSDescribeLayerRequest

java.lang.Object

com.luciad.wms.client.model.TLcdWMSDescribeLayerRequest

All Implemented Interfaces:

ILcdOWSRequest

public class TLcdWMSDescribeLayerRequest
extends Object
implements 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:

TLcdWMSClient

Method Summary

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	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 (see ILcdOWSTransport) to perform this OGC Web Service request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setNamedLayer

public void setNamedLayer(String aLayerName)

Sets the layer to display in the result. All previously set names will be cleared.

Parameters:

aLayerName - A valid layer name.

See Also:

setNamedLayers(java.util.List)

setNamedLayers

public void setNamedLayers(List<String> aLayerNames)

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:

setNamedLayer(String)

getKVPEncoding

public Map 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 interface ILcdOWSRequest

Returns:

the key-value pair (KVP) representation of this request.

getXMLEncoding

public InputStream getXMLEncoding()

Description copied from interface: ILcdOWSRequest

Returns the XML encoding of this request.

If no XML encoding is supported for this request, nullshould be returned.

Specified by:

getXMLEncoding in interface ILcdOWSRequest

Returns:

the XML representation of this request.

setTransportData

public 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. The type of object and the data contained in it depends on the ILcdOWSTransport 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()

getTransportData

public Object getTransportData()

Description copied from interface: ILcdOWSRequest

Returns an object representing data to be used by the transportation layer (see 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.

Specified by:

getTransportData in interface ILcdOWSRequest

Returns:

an object representing data to be used by the transportation layer to perform this OGC Web Service request.

getRestEncoding

public URI getRestEncoding(URI aBaseURI)

Returns null, REST encoding is not supported.

Specified by:

getRestEncoding in interface ILcdOWSRequest

Parameters:

aBaseURI -

Returns:

null

Since:

2013.0