| java.lang.Object
 org.geotools.data.ows.AbstractRequest
org.geotools.data.wms.request.AbstractWMSRequest
org.geotools.data.wms.request.AbstractGetMapRequest
| AbstractGetMapRequest | | abstract public class AbstractGetMapRequest extends AbstractWMSRequest implements GetMapRequest(Code) | |
author:
Richard Gould
author:
TODO To change the template for this generated type comment go to
author:
Window - Preferences - Java - Code Style - Code Templates |
| Method Summary | |
| public void | addLayer(Layer layer, String style)
| | public void | addLayer(Layer layer)
| | public void | addLayer(String layerName, String style)
| | public void | addLayer(Layer layer, Style style)
| | public void | addLayer(String layerName, Style style)
| | public URL | getFinalURL()
| | protected void | initRequest()
| | abstract protected void | initVersion()
| | public void | setBBox(String bbox)
From the Web Map Service Implementation Specification: "The required
BBOX parameter allows a Client to request a particular Bounding Box.
The value of the BBOX parameter in a GetMap request is a list of
comma-separated numbers of the form "minx,miny,maxx,maxy". | | public void | setBBox(CRSEnvelope box)
| | public void | setBGColour(String bgColour)
Specifies the colour, in hexidecimal format, to be used as the
background of the map. | | public void | setDimensions(String width, String height)
From the Web Map Service Implementation Specification: "The required
WIDTH and HEIGHT parameters specify the size in integer pixels of the
map image to be produced. | | public void | setDimensions(int width, int height)
| | public void | setElevation(String elevation)
| | public void | setExceptions(String exceptions)
The exceptions type specifies what format the server should return
exceptions in. | | public void | setFormat(String format)
From the Web Map Service Implementation Specification: "The required
FORMAT parameter states the desired format of the response to an
operation. | | public void | setProperties(Properties p)
| | public void | setSRS(String srs)
From the Web Map Service Implementation Specification: "The required SRS
parameter states which Spatial Reference System applies to the values
in the BBOX parameter. | | public void | setSampleDimensionValue(String name, String value)
| | public void | setTime(String time)
| | public void | setTransparent(boolean transparent)
From the Web Map Service Implementation Specification: "The optional
TRANSPARENT parameter specifies whether the map background is to be
made transparent or not. | | public void | setVendorSpecificParameter(String name, String value)
Used to implement vendor specific parameters. | | public void | setVersion(String version)
Sets the version number of the request. |
| AbstractGetMapRequest | | public AbstractGetMapRequest(URL onlineResource, Properties properties)(Code) | | Constructs a GetMapRequest. The data passed in represents valid values
that can be used.
Parameters:
onlineResource - the location that the request should be applied to
Parameters:
properties - pre-set properties to be used. Can be null. |
| addLayer | | public void addLayer(Layer layer, Style style)(Code) | | |
| addLayer | | public void addLayer(String layerName, Style style)(Code) | | |
| initRequest | | protected void initRequest()(Code) | | |
| initVersion | | abstract protected void initVersion()(Code) | | |
| setBBox | | public void setBBox(String bbox)(Code) | | From the Web Map Service Implementation Specification: "The required
BBOX parameter allows a Client to request a particular Bounding Box.
The value of the BBOX parameter in a GetMap request is a list of
comma-separated numbers of the form "minx,miny,maxx,maxy". If the WMS
server has declared that a Layer is not subsettable, then the Client
shall specify exactly the declared Bounding Box values in the GetMap
request and the Server may issue a Service Exception otherwise."
Parameters:
bbox - A string representing a bounding box in the format"minx,miny,maxx,maxy" |
| setBGColour | | public void setBGColour(String bgColour)(Code) | | Specifies the colour, in hexidecimal format, to be used as the
background of the map. It is a String representing RGB values in
hexidecimal format, prefixed by "0x". The format is: 0xRRGGBB. The
default value is 0xFFFFFF (white)
Parameters:
bgColour - the background colour of the map, in the format 0xRRGGBB |
| setDimensions | | public void setDimensions(String width, String height)(Code) | | From the Web Map Service Implementation Specification: "The required
WIDTH and HEIGHT parameters specify the size in integer pixels of the
map image to be produced. WIDTH specifies the number of pixels to be
used between the minimum and maximum X values (inclusive) in the BBOX
parameter, while HEIGHT specifies the number of pixels between the
minimum and maximum Y values. If the WMS server has declared that a
Layer has fixed width and height, then the Client shall specify exactly
those WIDTH and HEIGHT values in the GetMap request and the Server may
issue a Service Exception otherwise."
Parameters:
width -
Parameters:
height - |
| setDimensions | | public void setDimensions(int width, int height)(Code) | | |
| setElevation | | public void setElevation(String elevation)(Code) | | See the Web Map Server Implementation Specification 1.1.1, Annex C, in
particular section C.4
Parameters:
elevation - See the Web Map Server Implementation Specification1.1.1, Annex C |
| setExceptions | | public void setExceptions(String exceptions)(Code) | | The exceptions type specifies what format the server should return
exceptions in.
Valid values are:
-
"application/vnd.ogc.se_xml" (the default)
-
"application/vnd.ogc.se_inimage"
-
"application/vnd.ogc.se_blank"
Parameters:
exceptions - |
| setFormat | | public void setFormat(String format)(Code) | | From the Web Map Service Implementation Specification: "The required
FORMAT parameter states the desired format of the response to an
operation. Supported values for a GetMap request on a WMS instance are
listed in one or more <Format> elements in the
&;ltRequest><GetMap> element of its Capabilities XML. The entire
MIME type string in <Format> is used as the value of the FORMAT
parameter."
Parameters:
format - The desired format for the GetMap response |
| setSRS | | public void setSRS(String srs)(Code) | | From the Web Map Service Implementation Specification: "The required SRS
parameter states which Spatial Reference System applies to the values
in the BBOX parameter. The value of the SRS parameter shall be on of
the values defined in the character data section of an <SRS> element
defined or inherited by the requested layer. The same SRS applies to
all layers in a single request. If the WMS has declared SRS=NONE for a
Layer, then the Layer does not have a well-defined spatial reference
system and should not be shown in conjunction with other layers. The
client shall specify SRS as "none" in the GetMap request and the Server
may issue a Service Exception otherwise."
Parameters:
srs - A String indicating the Spatial Reference System to renderthe layers in. |
| setSampleDimensionValue | | public void setSampleDimensionValue(String name, String value)(Code) | | See the Web Map Server Implementation Specification 1.1.1, Annex C, in
particular section C.4.2
Example use: request.setSampleDimensionValue("DIM_WAVELENGTH",
"4000");
Parameters:
name - the request parameter name to set (usually with 'dim_' asprefix)
Parameters:
value - the value of the request parameter (value, interval orcomma-separated list) |
| setTime | | public void setTime(String time)(Code) | | See the Web Map Server Implementation Specification 1.1.1, Annexes B and
C
Parameters:
time - See the Web Map Server Implementation Specification 1.1.1,Annexes B and C |
| setTransparent | | public void setTransparent(boolean transparent)(Code) | | From the Web Map Service Implementation Specification: "The optional
TRANSPARENT parameter specifies whether the map background is to be
made transparent or not. The default value is false if the parameter is
absent from the request."
Parameters:
transparent - true for transparency, false otherwise |
| setVendorSpecificParameter | | public void setVendorSpecificParameter(String name, String value)(Code) | | Used to implement vendor specific parameters. Entirely optional.
Parameters:
name - a request parameter name
Parameters:
value - a value to accompany the name |
| setVersion | | public void setVersion(String version)(Code) | | Sets the version number of the request.
Parameters:
version - A String indicting a WMS Version ("1.0.0", "1.1.0","1.1.1", or "1.3.0") |
| Methods inherited from org.geotools.data.wms.request.AbstractWMSRequest | protected void initService()(Code)(Java Doc)
|
|
|