TLcdWMSGetLegendGraphicRequest (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.wms.client.model.TLcdWMSGetLegendGraphicRequest

All Implemented Interfaces:

ILcdOWSRequest
```
public class TLcdWMSGetLegendGraphicRequest
extends Object
implements ILcdOWSRequest
```
A class which represents a WMS GetLegendGraphic request. Instances of this class can be created using the TLcdWMSClient.createGetLegendGraphicRequest() 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

All Methods Instance Methods Concrete Methods
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`	`setCoverage(String aCoverage)` Sets the coverage for which a legend graphic should be created.
`void`	`setExceptions(String aExceptionType)` Sets the optional 'exceptions' parameter of the request.
`void`	`setFeatureType(QName aFeatureType)` Sets the `QName` of a feature type for which a legend graphic should be created.
`void`	`setFormat(String aFormat)` Sets the format which should be used for the requested map.
`void`	`setHeight(int aHeight)` An optional argument which specifies the size in pixels of the graphic which will be produced.
`void`	`setLayer(String aLayerName)` Sets the mandatory 'layer' request parameter.
`void`	`setRemoteOWSType(String aOWSType)` Sets the optional 'remote_ows_type' parameter, should be 'WCS' or 'WFS'.
`void`	`setRemoteOWSURL(String aOWSURL)` Sets the optional 'remote_ows_url' parameter.
`void`	`setRule(String aRule)` Sets the optional rule of style parameter of the request.
`void`	`setScale(double aScale)` Sets the optional scale parameter of the request.
`void`	`setStyle(String aStyleName)` Sets the optional 'style' request parameter.
`void`	`setStyledLayerDescriptor(TLcdSLDStyledLayerDescriptor aSLD)` Sets a Styled Layer Descriptor which will be used for the 'sld_body' parameter.
`void`	`setStyledLayerDescriptorURL(URL aURL)` Sets an URL pointing to a valid Styled Layer Descriptor which will be used by the server.
`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`	`setWidth(int aWidth)` An optional argument which specifies the size in pixels of the graphic which will be produced.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setLayer
```
public void setLayer(String aLayerName)
```
    Sets the mandatory 'layer' request parameter.
    
    Parameters:
    
    aLayerName - A name corresponding to a layer.
  - setStyle
```
public void setStyle(String aStyleName)
```
    Sets the optional 'style' request parameter. The style must correspond to a valid style available for the layer.
    
    Parameters:
    
    aStyleName - The name of a style.
    
    See Also:
    
    setLayer(String)
  - setRemoteOWSType
```
public void setRemoteOWSType(String aOWSType)
```
    Sets the optional 'remote_ows_type' parameter, should be 'WCS' or 'WFS'.
    
    Parameters:
    
    aOWSType - A valid OWS type.
  - setRemoteOWSURL
```
public void setRemoteOWSURL(String aOWSURL)
```
    Sets the optional 'remote_ows_url' parameter.
    
    Parameters:
    
    aOWSURL - The URL of an OWS.
  - setFeatureType
```
public void setFeatureType(QName aFeatureType)
```
    Sets the QName of a feature type for which a legend graphic should be created. This parameter only needs to be set if the layer is a WFS layer and contains more then one feature type.
    
    Parameters:
    
    aFeatureType - A QName corresponding to a feature type which is displayed in the layer.
  - setCoverage
```
public void setCoverage(String aCoverage)
```
    Sets the coverage for which a legend graphic should be created. This parameter only needs to be set if the layer is a WCS layer and contains more then one coverage.
    
    Parameters:
    
    aCoverage - String corresponding to a coverage which is displayed in the layer.
  - setRule
```
public void setRule(String aRule)
```
    Sets the optional rule of style parameter of the request.
    
    Parameters:
    
    aRule - String corresponding to a rule of style.
  - setScale
```
public void setScale(double aScale)
```
    Sets the optional scale parameter of the request.
    
    Parameters:
    
    aScale - Double which is a standardized scale denominator.
  - setStyledLayerDescriptor
```
public void setStyledLayerDescriptor(TLcdSLDStyledLayerDescriptor aSLD)
```
    Sets a Styled Layer Descriptor which will be used for the 'sld_body' parameter. Setting this parameter to a non-null value will clear any previously set sld URL or sld.
    
    Parameters:
    
    aSLD - A valid SLD, can be null.
    
    See Also:
    
    setStyledLayerDescriptorURL(java.net.URL)
  - setStyledLayerDescriptorURL
```
public void setStyledLayerDescriptorURL(URL aURL)
```
    Sets an URL pointing to a valid Styled Layer Descriptor which will be used by the server. Setting this parameter to a non-null value will clear any previously set sld URL or sld.
    
    Parameters:
    
    aURL - A URL which points to a valid SLD, can be null to clear the currently set URL.
    
    See Also:
    
    setStyledLayerDescriptor(com.luciad.wms.sld.model.TLcdSLDStyledLayerDescriptor)
  - setWidth
```
public void setWidth(int aWidth)
```
    An optional argument which specifies the size in pixels of the graphic which will be produced.
    
    Parameters:
    
    aWidth - A positive integer specifying a size in pixels.
  - setHeight
```
public void setHeight(int aHeight)
```
    An optional argument which specifies the size in pixels of the graphic which will be produced.
    
    Parameters:
    
    aHeight - A positive integer specifying a size in pixels.
  - setFormat
```
public void setFormat(String aFormat)
```
    Sets the format which should be used for the requested map. The server will return a ServiceException in case the format is not supported.
    
    Parameters:
    
    aFormat - A valid mime type which specifies the desired format.
  - setExceptions
```
public void setExceptions(String aExceptionType)
```
    Sets the optional 'exceptions' parameter of the request. The default value is 'application/vnd.ogc.se_xml', other possible values are available in the capabilities of the WMS.
    
    Parameters:
    
    aExceptionType - String corresponding to a valid type of exception.
  - 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

LuciadLightspeedClass TLcdWMSGetLegendGraphicRequest

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setLayer

setStyle

setRemoteOWSType

setRemoteOWSURL

setFeatureType

setCoverage

setRule

setScale

setStyledLayerDescriptor

setStyledLayerDescriptorURL

setWidth

setHeight

setFormat

setExceptions

getKVPEncoding

getXMLEncoding

setTransportData

getTransportData

getRestEncoding