|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GetMapRequest
Construct a WMS getMap request.
Constructs a getMapRequest based on the following property values:
Q: List availableFormats and availableExceptions - why are these here? It looks like they are designed to restrict the values used for SRS, format and exceptions. If so the code never uses them. Q: How constant is the GetMapRequest format across WMS versions? Do we need to generalize here?
Field Summary | |
---|---|
static java.lang.String |
BBOX
Represents the BBOX parameter |
static java.lang.String |
BGCOLOR
Represents the BGCOLOR parameter |
static java.lang.String |
ELEVATION
Represents the ELEVATION parameter |
static java.lang.String |
EXCEPTION_BLANK
Represents the EXCEPTION_BLANK value |
static java.lang.String |
EXCEPTION_INIMAGE
Represents the EXCEPTION_INIMAGE value |
static java.lang.String |
EXCEPTION_XML
|
static java.lang.String |
EXCEPTIONS
Represents the EXCEPTIONS parameter |
static java.lang.String |
FORMAT
Represents the FORMAT parameter |
static java.lang.String |
HEIGHT
Represents the HEIGHT parameter |
static java.lang.String |
LAYERS
Represents the LAYERS parameter |
static java.lang.String |
REMOTE_OWS_TYPE
Represents REMOTE_OWS_TYPE parameter |
static java.lang.String |
REMOTE_OWS_WCS
REMOTE_OWS_WCS indicates WCS as a REMOTE_OWS_TYPE |
static java.lang.String |
REMOTE_OWS_WFS
REMOTE_OWS_WFS indicates WFS as a REMOTE_OWS_TYPE |
static java.lang.String |
REMOVE_OWS_URL
Represents REMOTE_OWS_URL parameter |
static java.lang.String |
SLD
Represents the SLD parameter |
static java.lang.String |
SLD_BODY
Represents the SLD_BODY parameter |
static java.lang.String |
SRS
Represents the SRS parameter |
static java.lang.String |
STYLES
Represents the STYLES parameter |
static java.lang.String |
TIME
Represents the TIME parameter |
static java.lang.String |
TRANSPARENT
Represents the TRANSPARENT parameter |
static java.lang.String |
WFS
Represents the WFS parameter mentioned briefly in 1.1.1 |
static java.lang.String |
WIDTH
Represents the WIDTH parameter |
Fields inherited from interface org.geotools.data.ows.Request |
---|
REQUEST, SERVICE, VERSION, WMTVER |
Method Summary | |
---|---|
void |
addLayer(Layer layer)
Adds a Layer to the list of layers to be requested. |
void |
addLayer(Layer layer,
java.lang.String styleName)
Adds a Layer to the list of layers to be requested. |
void |
addLayer(Layer layer,
StyleImpl style)
Adds a Layer to the list of layers to be requested. |
void |
addLayer(java.lang.String layerName,
java.lang.String styleName)
Adds a Layer to the list of layers to be requested. |
void |
addLayer(java.lang.String layerName,
StyleImpl style)
Adds a Layer to the list of layers to be requested. |
void |
setBBox(org.opengis.geometry.BoundingBox box)
|
void |
setBBox(CRSEnvelope box)
|
void |
setBBox(java.lang.String bbox)
From the Web Map Service Implementation Specification: "The required BBOX parameter allows a Client to request a particular Bounding Box. |
void |
setBGColour(java.lang.String bgColour)
Specifies the colour, in hexidecimal format, to be used as the background of the map. |
void |
setDimensions(java.awt.Dimension imageDimension)
|
void |
setDimensions(int width,
int height)
|
void |
setDimensions(java.lang.String width,
java.lang.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. |
void |
setElevation(java.lang.String elevation)
See the Web Map Server Implementation Specification 1.1.1, Annex C, in particular section C.4 |
void |
setExceptions(java.lang.String exceptions)
The exceptions type specifies what format the server should return exceptions in. |
void |
setFormat(java.lang.String format)
From the Web Map Service Implementation Specification: "The required FORMAT parameter states the desired format of the response to an operation. |
void |
setProperties(java.util.Properties p)
create a request using a properties file to save time |
void |
setSampleDimensionValue(java.lang.String name,
java.lang.String value)
See the Web Map Server Implementation Specification 1.1.1, Annex C, in particular section C.4.2 |
void |
setSRS(java.lang.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. |
void |
setTime(java.lang.String time)
See the Web Map Server Implementation Specification 1.1.1, Annexes B and C |
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. |
void |
setVendorSpecificParameter(java.lang.String name,
java.lang.String value)
Used to implement vendor specific parameters. |
void |
setVersion(java.lang.String version)
Sets the version number of the request. |
Methods inherited from interface org.geotools.data.ows.Request |
---|
createResponse, getFinalURL, getPostContentType, getProperties, performPostOutput, requiresPost, setProperty |
Field Detail |
---|
static final java.lang.String ELEVATION
static final java.lang.String TIME
static final java.lang.String EXCEPTIONS
static final java.lang.String BGCOLOR
static final java.lang.String TRANSPARENT
static final java.lang.String WIDTH
static final java.lang.String HEIGHT
static final java.lang.String FORMAT
static final java.lang.String BBOX
static final java.lang.String SRS
static final java.lang.String LAYERS
static final java.lang.String STYLES
static final java.lang.String EXCEPTION_XML
static final java.lang.String EXCEPTION_INIMAGE
static final java.lang.String EXCEPTION_BLANK
static final java.lang.String SLD
static final java.lang.String SLD_BODY
static final java.lang.String WFS
static final java.lang.String REMOTE_OWS_TYPE
static final java.lang.String REMOVE_OWS_URL
static final java.lang.String REMOTE_OWS_WFS
REMOTE_OWS_WFS
indicates WFS as a REMOTE_OWS_TYPE
static final java.lang.String REMOTE_OWS_WCS
REMOTE_OWS_WCS
indicates WCS as a REMOTE_OWS_TYPE
Method Detail |
---|
void setVersion(java.lang.String version)
version
- A String indicting a WMS Version ("1.0.0", "1.1.0",
"1.1.1", "1.3.0", etc.)void addLayer(Layer layer, StyleImpl style)
layer
- the Layer to usestyle
- the style to use. If it is null, the default style is used.void addLayer(java.lang.String layerName, StyleImpl style)
layerName
- the Layer to usestyle
- the style to use. If it is null, the default style is used.void addLayer(java.lang.String layerName, java.lang.String styleName)
layerName
- the name of the layer to usestyleName
- the style to use to draw the layer, can also be NULL, "" or "default"void addLayer(Layer layer, java.lang.String styleName)
layer
- the Layer to usestyleName
- the style to use to draw the layer, can also be NULL, "" or "default"void addLayer(Layer layer)
layer
- the Layer to usevoid setSRS(java.lang.String srs)
srs
- A String indicating the Spatial Reference System to render
the layers in.void setBBox(java.lang.String bbox)
bbox
- A string representing a bounding box in the format
"minx,miny,maxx,maxy"void setBBox(CRSEnvelope box)
void setBBox(org.opengis.geometry.BoundingBox box)
void setFormat(java.lang.String format)
format
- The desired format for the GetMap responsevoid setDimensions(java.lang.String width, java.lang.String height)
width
- height
- void setDimensions(int width, int height)
void setDimensions(java.awt.Dimension imageDimension)
void setTransparent(boolean transparent)
transparent
- true for transparency, false otherwisevoid setBGColour(java.lang.String bgColour)
bgColour
- the background colour of the map, in the format 0xRRGGBBvoid setExceptions(java.lang.String exceptions)
Valid values are:
exceptions
- void setTime(java.lang.String time)
time
- See the Web Map Server Implementation Specification 1.1.1,
Annexes B and Cvoid setElevation(java.lang.String elevation)
elevation
- See the Web Map Server Implementation Specification
1.1.1, Annex Cvoid setSampleDimensionValue(java.lang.String name, java.lang.String value)
Example use: request.setSampleDimensionValue("DIM_WAVELENGTH",
"4000");
name
- the request parameter name to set (usually with 'dim_' as
prefix)value
- the value of the request parameter (value, interval or
comma-separated list)void setVendorSpecificParameter(java.lang.String name, java.lang.String value)
name
- a request parameter namevalue
- a value to accompany the namevoid setProperties(java.util.Properties p)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |