org.deegree.services.wms.protocol
Interface WMSGetMapRequest

All Superinterfaces:

OGCWebServiceRequest

All Known Implementing Classes:

WMSGetMapRequest_Impl

public interface WMSGetMapRequest

extends OGCWebServiceRequest

This interface describes the access to the parameters of a GeMap request. It is excpected that there are two kinds of request. The first is the 'normal' HTTP GET request with name-value-pair enconding and the second is a HTTP POST request containing a SLD.

Even it is possible to access the values of a HTTP GET request throught their bean accessor methods the request shall be mapped to a SLD data structure that is accessible using the getSLD().

--------------------------------------------------------------------

Version:

2002-03-01

Author:

Andreas Poth

Nested Class Summary

static interface

WMSGetMapRequest.Layer

Method Summary

java.awt.Color	getBGColor() The optional BGCOLOR parameter specifies the color to be used as the background of the map.
java.lang.String	getBGColorAsHex() transforms the color of the request from java.awt.Color to the hexadecimal representation as in an OGC conform WMS-GetMap request (e.g. white == "0xffffff").
GM_Envelope	getBoundingBox() The required BBOX parameter allows a Client to request a particular Bounding Box.
double[]	getElevation() Some geospatial information may be available at multiple elevations.
java.lang.String	getExceptions() The optional EXCEPTIONS parameter states the manner in which errors are to be reported to the client.
java.lang.String	getFormat() The FORMAT parameter specifies the output format of the response to an operation.
int	getHeight() HEIGHT specifies the number of pixels between the minimum and maximum Y values.
WMSGetMapRequest.Layer[]	getLayers() The required LAYERS parameter lists the map layer(s) to be returned by this GetMap request.
java.lang.String[]	getSampleDimension() Some geospatial information may be available at other dimensions (for example, satellite images in different wavelength bands).
java.net.URL	getSLD_URL() URL of Styled Layer Descriptor (as defined in SLD Specification).
java.lang.String	getSrs() The required SRS parameter states which Spatial Reference System applies to the values in the BBOX parameter.
StyledLayerDescriptor	getStyledLayerDescriptor() returns the SLD the request is made of.
java.lang.String	getTime() This specification is based on [ISO 8601:1988(E)]; it extends ISO 8601 in the following ways: It defines a syntax for expressing the start, end and periodicity of a data collection.
boolean	getTransparency() The optional TRANSPARENT parameter specifies whether the map background is to be made transparent or not.
java.net.URL	getWFS_URL() URL of Web Feature Service providing features to be symbolized using SLD.
int	getWidth() WIDTH specifies the number of pixels to be used between the minimum and maximum X values (inclusive) in the BBOX parameter.

Methods inherited from interface org.deegree.services.OGCWebServiceRequest

getId, getRequest, getRequestParameter, getService, getVendorSpecificParameter, getVendorSpecificParameters, getVersion

Method Detail

getFormat

public java.lang.String getFormat()

The FORMAT parameter specifies the output format of the response to an operation.

An OGC Web Service may offer only a subset of the formats known for that type of operation, but the server shall advertise in its Capabilities XML those formats it does support and shall accept requests for any format it advertises. A Service Instance may optionally offer a new format not previously offered by other instances, with the recognition that clients are not required to accept or process an unknown format. If a request contains a Format not offered by a particular server, the server shall throw a Service Exception (with code "InvalidFormat").

getLayers

public WMSGetMapRequest.Layer[] getLayers()

The required LAYERS parameter lists the map layer(s) to be returned by this GetMap request. The value of the LAYERS parameter is a comma-separated list of one or more valid layer names. Allowed layer names are the character data content of any element in the Capabilities XML.

A WMS shall render the requested layers by drawing the leftmost in the list bottommost, the next one over that, and so on.

Each layer is associated to a style. Styles are also is encoded as a comma- seperated list within the GetMap request.

The required STYLES parameter lists the style in which each layer is to be rendered. There is a one-to-one correspondence between the values in the LAYERS parameter and the values in the STYLES parameter. Because of this layer-style combinations are returned coupled within an array of Layer- objects. Each map in the list of LAYERS is drawn using the corresponding style in the same position in the list of STYLES. Each style Name shall be one that was defined in the element of a