org.mapfish.print.map.image.wms

Class WmsLayerParam

java.lang.Object

org.mapfish.print.map.AbstractLayerParams

org.mapfish.print.map.tiled.AbstractTiledLayerParams

org.mapfish.print.map.tiled.AbstractWMXLayerParams

org.mapfish.print.map.image.wms.WmsLayerParam

Direct Known Subclasses:

TiledWmsLayerParam

public class WmsLayerParam
extends AbstractWMXLayerParams

Layer parameters for WMS layer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WmsLayerParam.ServerType The WMS server type.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	baseURL The base URL for the WMS.
java.lang.String	imageFormat The format of the image.
java.lang.String[]	layers The wms layer to request in the GetMap request.
WmsLayerParam.ServerType	serverType The server type ("mapserver", "geoserver" or "qgisserver").
java.lang.String[]	styles The styles to apply to the layers.
boolean	useNativeAngle If true transform the map angle to customParams.angle for GeoServer, and customParams.map_angle for MapServer.
java.lang.String	version The WMS version to use when making requests.

Fields inherited from class org.mapfish.print.map.tiled.AbstractWMXLayerParams

customParams, mergeableParams

Fields inherited from class org.mapfish.print.map.tiled.AbstractTiledLayerParams

rasterStyle

Fields inherited from class org.mapfish.print.map.AbstractLayerParams

failOnError, name, opacity

Constructor Summary

Constructors

Constructor and Description
WmsLayerParam()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBaseUrl() Get the base url for all tile requests.
void	postConstruct() Validate some of the properties of this layer.

Methods inherited from class org.mapfish.print.map.tiled.AbstractWMXLayerParams

createCommonUrl, getCustomParams, getMergeableParams, setCustomParam, validateBaseUrl

Methods inherited from class java.lang.Object

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

Field Detail

baseURL

public java.lang.String baseURL

The base URL for the WMS. Used for making WMS requests.

layers

public java.lang.String[] layers

The wms layer to request in the GetMap request. The order is important. It is the order that they will appear in the request. As with the WMS specification, the first layer will be the first layer drawn on the map (the bottom/base layer) of the map. This means that layer at position 0 in the array will covered by layer 1 (where not transparent) and so on.

styles

public java.lang.String[] styles

The styles to apply to the layers. If this is defined there should be the same number as the layers and the style are applied to the layer in the layers field.

version

public java.lang.String version

The WMS version to use when making requests.

useNativeAngle

public boolean useNativeAngle

If true transform the map angle to customParams.angle for GeoServer, and customParams.map_angle for MapServer.

serverType

public WmsLayerParam.ServerType serverType

The server type ("mapserver", "geoserver" or "qgisserver"). By specifying the server type vendor specific parameters (like for the DPI value) can be used when making the request.

imageFormat

public java.lang.String imageFormat

The format of the image. for example image/png, image/jpeg, etc...

Constructor Detail

WmsLayerParam

public WmsLayerParam()

Method Detail

getBaseUrl

public final java.lang.String getBaseUrl()

Description copied from class: AbstractTiledLayerParams

Get the base url for all tile requests. For example it might be 'http://server.com/geoserver/gwc/service/wmts'.

Specified by:

getBaseUrl in class AbstractTiledLayerParams

postConstruct

public void postConstruct()
                   throws java.net.URISyntaxException

Validate some of the properties of this layer.

Throws:

java.net.URISyntaxException