public class TLcdWMSGetMapRequest extends Object implements ILcdOWSRequest
A class which represents a WMS GetMap
request. Instances of this class can be created using the
TLcdWMSClient.createGetMapRequest()
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.getMap(TLcdWMSGetMapRequest)
method. This is low level
API though. There is higher level API available to perform GetMap requests, see TLcdWMSGetMapContext
.
TLcdWMSClient
,
TLcdWMSGetMapContext
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 |
setBackgroundColor(Color aBackgroundColor)
Sets the background color which should be used for the requested map.
|
void |
setBoundingBox(double aMinX,
double aMaxX,
double aMinY,
double aMaxY)
Sets the values of the 'bbox' parameter to the values of this bounding box.
|
void |
setCRS(String aCRS)
Sets the CRS which applies to the bounding box specified with
setBoundingBox(double, double, double, double) . |
void |
setDimension(String aDimensionName,
TLcdOGCWMSDimensionExtent aExtent)
Sets the value for a given dimension name.
|
void |
setExceptions(String aExceptionType)
Sets the optional 'exceptions' parameter of the request.
|
void |
setFormat(String aFormat)
Sets the format which should be used for the requested map.
|
void |
setHeight(int aHeight)
A mandatory argument which specifies the height in pixels of the map which will be produced.
|
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 |
setNamedStyle(String aStyleName)
Sets the style to be used for the layer which is set in
setNamedLayer(java.lang.String) . |
void |
setNamedStyles(List<String> aLayerStyles)
Sets the list of styles which will be used to visualize layers in the result.
|
void |
setPixelSize(double aPixelSize)
Sets the size of a pixel.
|
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 |
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 |
setTransparant(boolean aTransparent)
Deprecated.
Since 2021.0: use
setTransparent instead. |
void |
setTransparent(boolean aTransparent)
Sets whether background transparency should be used for the requested map.
|
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)
A mandatory argument which specifies the width in pixels of the map which will be produced.
|
public void setBoundingBox(double aMinX, double aMaxX, double aMinY, double aMaxY)
aMinX
- The minimum X coordinate of the bounding boxaMaxX
- The maximum X coordinate of the bounding boxaMinY
- The minimum Y coordinate of the bounding boxaMaxY
- The maximum Y coordinate of the bounding boxpublic void setNamedLayer(String aLayerName)
aLayerName
- A valid layer name.setNamedLayers(java.util.List<java.lang.String>)
public void setNamedLayers(List<String> aLayerNames)
aLayerNames
- A list containing layer names.setNamedLayer(java.lang.String)
public void setNamedStyles(List<String> aLayerStyles)
setNamedLayers(java.util.List<java.lang.String>)
.aLayerStyles
- A list containing names of layer styles.public void setNamedStyle(String aStyleName)
setNamedLayer(java.lang.String)
.aStyleName
- A valid layer style.public void setStyledLayerDescriptor(TLcdSLDStyledLayerDescriptor aSLD)
aSLD
- A valid SLD.setStyledLayerDescriptorURL(java.net.URL)
public void setStyledLayerDescriptorURL(URL aURL)
aURL
- A URL which points to a valid SLD.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 void setBackgroundColor(Color aBackgroundColor)
Color.WHITE
is used as background color,
following the WMS specification. If null
is set,
the background color parameter is omitted in requests.aBackgroundColor
- A color which should be used in the request.public void setTransparent(boolean aTransparent)
aTransparent
- boolean which should be true if the background pixels of the result should
be made transparent, false otherwise.public void setTransparant(boolean aTransparent)
setTransparent
instead.setTransparent(boolean)
public void setPixelSize(double aPixelSize)
aPixelSize
- The size of a pixel, in mm. The default value is calculated based on the resolution of the
screen.public void setCRS(String aCRS)
setBoundingBox(double, double, double, double)
. The
value is one of the values defined in the capabilities of the server.aCRS
- A String which corresponds to a valid CRS for the server.public void setDimension(String aDimensionName, TLcdOGCWMSDimensionExtent aExtent)
TLcdOGCWMSDimensionExtent
domain object is used to represent the value.
getXMLEncoding()
will return null. Intervals are not supported.
For the 'elevation' dimension:These limitations are necessary to comply with the GetMap schema.
aDimensionName
- Name of a dimension, without the 'dim_' prefix.aExtent
- The actual extent of the dimension containing either values or
intervals.public void setRemoteOWSType(String aOWSType)
aOWSType
- A valid OWS type.public void setRemoteOWSURL(String aOWSURL)
aOWSURL
- The URL of an OWS.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