|
||||||||||
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 String |
BBOX
Represents the BBOX parameter |
static String |
BGCOLOR
Represents the BGCOLOR parameter |
static String |
ELEVATION
Represents the ELEVATION parameter |
static String |
EXCEPTION_BLANK
Represents the EXCEPTION_BLANK value |
static String |
EXCEPTION_INIMAGE
Represents the EXCEPTION_INIMAGE value |
static String |
EXCEPTION_XML
|
static String |
EXCEPTIONS
Represents the EXCEPTIONS parameter |
static String |
FORMAT
Represents the FORMAT parameter |
static String |
HEIGHT
Represents the HEIGHT parameter |
static String |
LAYERS
Represents the LAYERS parameter |
static String |
REMOTE_OWS_TYPE
Represents REMOTE_OWS_TYPE parameter |
static String |
REMOTE_OWS_WCS
REMOTE_OWS_WCS indicates WCS as a REMOTE_OWS_TYPE |
static String |
REMOTE_OWS_WFS
REMOTE_OWS_WFS indicates WFS as a REMOTE_OWS_TYPE |
static String |
REMOVE_OWS_URL
Represents REMOTE_OWS_URL parameter |
static String |
SLD
Represents the SLD parameter |
static String |
SLD_BODY
Represents the SLD_BODY parameter |
static String |
SRS
Represents the SRS parameter |
static String |
STYLES
Represents the STYLES parameter |
static String |
TIME
Represents the TIME parameter |
static String |
TRANSPARENT
Represents the TRANSPARENT parameter |
static String |
WFS
Represents the WFS parameter mentioned briefly in 1.1.1 |
static String |
WIDTH
Represents the WIDTH parameter |
Fields inherited from interface 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,
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(String layerName,
String styleName)
Adds a Layer to the list of layers to be requested. |
void |
addLayer(String layerName,
StyleImpl style)
Adds a Layer to the list of layers to be requested. |
void |
setBBox(CRSEnvelope box)
|
void |
setBBox(String bbox)
From the Web Map Service Implementation Specification: "The required BBOX parameter allows a Client to request a particular Bounding Box. |
void |
setBGColour(String bgColour)
Specifies the colour, in hexidecimal format, to be used as the background of the map. |
void |
setDimensions(int width,
int height)
|
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. |
void |
setElevation(String elevation)
See the Web Map Server Implementation Specification 1.1.1, Annex C, in particular section C.4 |
void |
setExceptions(String exceptions)
The exceptions type specifies what format the server should return exceptions in. |
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. |
void |
setProperties(Properties p)
create a request using a properties file to save time |
void |
setSampleDimensionValue(String name,
String value)
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");
|
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. |
void |
setTime(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(String name,
String value)
Used to implement vendor specific parameters. |
void |
setVersion(String version)
Sets the version number of the request. |
Methods inherited from interface Request |
---|
createResponse, getFinalURL, getPostContentType, getProperties, performPostOutput, requiresPost, setProperty |
Field Detail |
---|
static final String ELEVATION
static final String TIME
static final String EXCEPTIONS
static final String BGCOLOR
static final String TRANSPARENT
static final String WIDTH
static final String HEIGHT
static final String FORMAT
static final String BBOX
static final String SRS
static final String LAYERS
static final String STYLES
static final String EXCEPTION_XML
static final String EXCEPTION_INIMAGE
static final String EXCEPTION_BLANK
static final String SLD
static final String SLD_BODY
static final String WFS
static final String REMOTE_OWS_TYPE
static final String REMOVE_OWS_URL
static final String REMOTE_OWS_WFS
REMOTE_OWS_WFS
indicates WFS as a REMOTE_OWS_TYPE
static final String REMOTE_OWS_WCS
REMOTE_OWS_WCS
indicates WCS as a REMOTE_OWS_TYPE
Method Detail |
---|
void setVersion(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(String layerName, StyleImpl style)
layerName
- the Layer to usestyle
- the style to use. If it is null, the default style is used.void addLayer(String layerName, 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, 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(String srs)
srs
- A String indicating the Spatial Reference System to render
the layers in.void setBBox(String bbox)
bbox
- A string representing a bounding box in the format
"minx,miny,maxx,maxy"void setBBox(CRSEnvelope box)
void setFormat(String format)
format
- The desired format for the GetMap responsevoid setDimensions(String width, String height)
width
- height
- void setDimensions(int width, int height)
void setTransparent(boolean transparent)
transparent
- true for transparency, false otherwisevoid setBGColour(String bgColour)
bgColour
- the background colour of the map, in the format 0xRRGGBBvoid setExceptions(String exceptions)
Valid values are:
exceptions
- void setTime(String time)
time
- See the Web Map Server Implementation Specification 1.1.1,
Annexes B and Cvoid setElevation(String elevation)
elevation
- See the Web Map Server Implementation Specification
1.1.1, Annex Cvoid setSampleDimensionValue(String name, 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(String name, String value)
name
- a request parameter namevalue
- a value to accompany the namevoid setProperties(Properties p)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |