org.vfny.geoserver.requests.wms
Class GetMapRequest

java.lang.Object
  org.vfny.geoserver.requests.Request
      org.vfny.geoserver.requests.WMSRequest
          org.vfny.geoserver.requests.wms.GetMapRequest

public class GetMapRequest

extends WMSRequest

represents a WMS GetMap request. as a extension to the WMS spec 1.1, we provide the posibility to pass xml encoded Filters in the FILTERS parameters. This list of filters attachs to the same constraints as the parameters LAYERS and STYLES. In a few words, if the FILTERS parameter is present, it's value must contain as many comma separated filters as LAYERS requested, in a one to one order relationship. If for a given layer the user do not wants to specify any filter, it's position in the list of filters may be empty.

Field Summary

static java.lang.String

SE_XML DOCUMENT ME!

Fields inherited from class org.vfny.geoserver.requests.Request

httpServletRequest, request, service, version

Constructor Summary

GetMapRequest()
Creates a new GetMapRequest object.

Method Summary

java.util.List	getAttributes() Gets the list of attributes to use in the request.
com.vividsolutions.jts.geom.Envelope	getBbox() DOCUMENT ME!
java.awt.Color	getBgColor() DOCUMENT ME!
java.lang.String	getCrs() DOCUMENT ME!
java.lang.String	getExceptions() DOCUMENT ME!
org.geotools.filter.Filter[]	getFilters() DOCUMENT ME!
java.lang.String	getFormat() DOCUMENT ME!
int	getHeight() DOCUMENT ME!
FeatureTypeInfo[]	getLayers() DOCUMENT ME!
java.util.List	getStyles() Gets a list of the names of the styles to be returned by the server.
int	getWidth() DOCUMENT ME!
boolean	getWriteSvgHeader()
boolean	isTransparent() DOCUMENT ME!
void	setAttributes(java.util.List attributes) DOCUMENT ME!
void	setBbox(com.vividsolutions.jts.geom.Envelope bbox) DOCUMENT ME!
void	setBgColor(java.awt.Color bgColor) DOCUMENT ME!
void	setCrs(java.lang.String crs) DOCUMENT ME!
void	setExceptions(java.lang.String exceptions) DOCUMENT ME!
void	setFilters(org.geotools.filter.Filter[] filters) DOCUMENT ME!
void	setFormat(java.lang.String format) DOCUMENT ME!
void	setHeight(int height) DOCUMENT ME!
void	setLayers(FeatureTypeInfo[] layers) DOCUMENT ME!
void	setStyles(java.util.List styles) DOCUMENT ME!
void	setTransparent(boolean transparent) DOCUMENT ME!
void	setWidth(int width) DOCUMENT ME!
void	setWriteSvgHeader(boolean writeSvgHeader)

Methods inherited from class org.vfny.geoserver.requests.Request

equals, getBaseUrl, getGeoServer, getHttpServletRequest, getRequest, getRootDir, getService, getValidationProcessor, getVersion, hashCode, isLoggedIn, setHttpServletRequest, setRequest, setService, setVersion

Methods inherited from class java.lang.Object

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

Field Detail

SE_XML

public static final java.lang.String SE_XML

DOCUMENT ME!

See Also:

Constant Field Values

Constructor Detail

GetMapRequest

public GetMapRequest()

Creates a new GetMapRequest object.

Method Detail

getAttributes

public java.util.List getAttributes()

Gets the list of attributes to use in the request. This is a custom element, not part of the normal wms request.

Returns:

DOCUMENT ME!

getBbox

public com.vividsolutions.jts.geom.Envelope getBbox()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getBgColor

public java.awt.Color getBgColor()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getCrs

public java.lang.String getCrs()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getExceptions

public java.lang.String getExceptions()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getFormat

public java.lang.String getFormat()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getHeight

public int getHeight()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getLayers

public FeatureTypeInfo[] getLayers()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getStyles

public java.util.List getStyles()

Gets a list of the names of the styles to be returned by the server.

Returns:

A list of Strings of the names of the styles.

getFilters

public org.geotools.filter.Filter[] getFilters()

DOCUMENT ME!

Returns:

DOCUMENT ME!

isTransparent

public boolean isTransparent()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getWidth

public int getWidth()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setWriteSvgHeader

public void setWriteSvgHeader(boolean writeSvgHeader)

getWriteSvgHeader

public boolean getWriteSvgHeader()

setAttributes

public void setAttributes(java.util.List attributes)

DOCUMENT ME!

Parameters:

attributes - DOCUMENT ME!

setBbox

public void setBbox(com.vividsolutions.jts.geom.Envelope bbox)

DOCUMENT ME!

Parameters:

bbox - DOCUMENT ME!

setBgColor

public void setBgColor(java.awt.Color bgColor)

DOCUMENT ME!

Parameters:

bgColor - DOCUMENT ME!

setCrs

public void setCrs(java.lang.String crs)

DOCUMENT ME!

Parameters:

crs - DOCUMENT ME!

setExceptions

public void setExceptions(java.lang.String exceptions)

DOCUMENT ME!

Parameters:

exceptions - DOCUMENT ME!

setFormat

public void setFormat(java.lang.String format)

DOCUMENT ME!

Parameters:

format - DOCUMENT ME!

setHeight

public void setHeight(int height)

DOCUMENT ME!

Parameters:

height - DOCUMENT ME!

setFilters

public void setFilters(org.geotools.filter.Filter[] filters)

DOCUMENT ME!

Parameters:

filters - DOCUMENT ME!

setLayers

public void setLayers(FeatureTypeInfo[] layers)

DOCUMENT ME!

Parameters:

layers - DOCUMENT ME!

setStyles

public void setStyles(java.util.List styles)

DOCUMENT ME!

Parameters:

styles - DOCUMENT ME!

setTransparent

public void setTransparent(boolean transparent)

DOCUMENT ME!

Parameters:

transparent - DOCUMENT ME!

setWidth

public void setWidth(int width)

DOCUMENT ME!

Parameters:

width - DOCUMENT ME!