public class TLcdWMSGetLegendGraphicRequest extends Object implements ILcdOWSRequest
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.TLcdWMSClient
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.
|
public void setLayer(String aLayerName)
aLayerName
- A name corresponding to a layer.public void setStyle(String aStyleName)
aStyleName
- The name of a style.setLayer(String)
public void setRemoteOWSType(String aOWSType)
aOWSType
- A valid OWS type.public void setRemoteOWSURL(String aOWSURL)
aOWSURL
- The URL of an OWS.public void setFeatureType(QName aFeatureType)
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.aFeatureType
- A QName corresponding to a feature type which is displayed in the layer.public void setCoverage(String aCoverage)
aCoverage
- String corresponding to a coverage which is displayed in the layer.public void setRule(String aRule)
aRule
- String corresponding to a rule of style.public void setScale(double aScale)
aScale
- Double which is a standardized scale denominator.public void setStyledLayerDescriptor(TLcdSLDStyledLayerDescriptor aSLD)
aSLD
- A valid SLD, can be null.setStyledLayerDescriptorURL(java.net.URL)
public void setStyledLayerDescriptorURL(URL aURL)
aURL
- A URL which points to a valid SLD, can be null to clear the currently set URL.setStyledLayerDescriptor(com.luciad.wms.sld.model.TLcdSLDStyledLayerDescriptor)
public void setWidth(int aWidth)
aWidth
- A positive integer specifying a size in pixels.public void setHeight(int aHeight)
aHeight
- A positive integer specifying a size in pixels.public void setFormat(String aFormat)
aFormat
- A valid mime type which specifies the desired format.public void setExceptions(String aExceptionType)
aExceptionType
- String corresponding to a valid type of exception.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