org.geotools.ows.wms

Class WMS1_0_0.GetMapRequest

Object

AbstractRequest

AbstractWMSRequest

AbstractGetMapRequest

WMS1_0_0.GetMapRequest

All Implemented Interfaces:

Request, GetMapRequest

Direct Known Subclasses:

WMS1_1_0.GetMapRequest

Enclosing class:

WMS1_0_0

public static class WMS1_0_0.GetMapRequest
extends AbstractGetMapRequest

A GetMapRequest for a 1.0.0 Server

Field Summary

Fields inherited from class AbstractRequest

EXCEPTION_XML, hints, onlineResource, properties

Fields inherited from interface GetMapRequest

BBOX, BGCOLOR, ELEVATION, EXCEPTION_BLANK, EXCEPTION_INIMAGE, EXCEPTION_XML, EXCEPTIONS, FORMAT, HEIGHT, LAYERS, REMOTE_OWS_TYPE, REMOTE_OWS_WCS, REMOTE_OWS_WFS, REMOVE_OWS_URL, SLD, SLD_BODY, SRS, STYLES, TIME, TRANSPARENT, WFS, WIDTH

Fields inherited from interface Request

REQUEST, SERVICE, VERSION, WMTVER

Constructor Summary

Constructors

Constructor and Description
GetMapRequest(URL onlineResource) Constructs a GetMapRequest for use with a 1.0.0 server

Method Summary

Modifier and Type	Method and Description
Response	createResponse(HTTPResponse httpResponse) Each Request must know how to create it's counterpart Response.
protected String	getRequestException(String exception)
protected String	getRequestFormat(String format)
protected void	initRequest()
protected void	initVersion() Sets up the version number for this request.
protected String	processKey(String key) Some Open Web Servers do not abide by the fact that parameter keys should be case insensitive.
void	setExceptions(String exceptions) The exceptions type specifies what format the server should return exceptions in.
void	setFormat(String value) From the Web Map Service Implementation Specification: "The required FORMAT parameter states the desired format of the response to an operation.
void	setProperty(String name, String value) Sets the name/value property for this request.

Methods inherited from class AbstractGetMapRequest

addLayer, addLayer, addLayer, addLayer, addLayer, getFinalURL, isGeotoolsLongitudeFirstAxisOrderForced, setBBox, setBBox, setBGColour, setDimensions, setDimensions, setDimensions, setElevation, setProperties, setSampleDimensionValue, setSRS, setTime, setTransparent, setVendorSpecificParameter, setVersion, toServerCRS

Methods inherited from class AbstractWMSRequest

initService

Methods inherited from class AbstractRequest

getPostContentType, getProperties, getRequestHints, performPostOutput, requiresPost, setRequestHints

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Request

getPostContentType, getProperties, getRequestHints, performPostOutput, requiresPost, setRequestHints

Constructor Detail

GetMapRequest

public GetMapRequest(URL onlineResource)

Constructs a GetMapRequest for use with a 1.0.0 server

Parameters:

onlineResource - the URL for server's GetMap request

Method Detail

initRequest

protected void initRequest()

Overrides:

initRequest in class AbstractGetMapRequest

initVersion

protected void initVersion()

Description copied from class: AbstractRequest

Sets up the version number for this request. Typically something like setProperty("VERSION", "1.1.1");

Specified by:

initVersion in class AbstractGetMapRequest

setProperty

public void setProperty(String name,
                        String value)

Description copied from interface: Request

Sets the name/value property for this request.

Note that when using this method, it is up to the programmer to provide their own encoding of value according to the OWS specifications! The code will not do this for you.

Different OWS specifications define different ways to do this. There are notorious differences between WMS 1.1.1 (section 6.2.1) and WMS 1.3.0 (section 6.3.2) for example.

If value is null, "name" is removed from the properties table.

Specified by:

setProperty in interface Request

Overrides:

setProperty in class AbstractRequest

Parameters:

name - the name of the property

value - the value of the property

setFormat

public void setFormat(String value)

Description copied from class: AbstractGetMapRequest

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."

Specified by:

setFormat in interface GetMapRequest

Overrides:

setFormat in class AbstractGetMapRequest

Parameters:

value - The desired format for the GetMap response

setExceptions

public void setExceptions(String exceptions)

Description copied from class: AbstractGetMapRequest

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"

Specified by:

setExceptions in interface GetMapRequest

Overrides:

setExceptions in class AbstractGetMapRequest

getRequestException

protected String getRequestException(String exception)

getRequestFormat

protected String getRequestFormat(String format)

processKey

protected String processKey(String key)

Description copied from class: AbstractRequest

Some Open Web Servers do not abide by the fact that parameter keys should be case insensitive.

This method will allow a specification to determine the way that the parameter keys should be encoded in requests made by the server.

Overrides:

processKey in class AbstractRequest

Parameters:

key - the key to be processed

Returns:

the key, after being processed. (made upper case, for example)

createResponse

public Response createResponse(HTTPResponse httpResponse)
                        throws ServiceException,
                               IOException

Description copied from interface: Request

Each Request must know how to create it's counterpart Response. Given the content type and input stream (containin the response data), this method must return an appropriate Response object.

Throws:

ServiceException

IOException