org.mapfish.print.map.tiled

Class AbstractTiledLayerParams

java.lang.Object

org.mapfish.print.map.AbstractLayerParams

org.mapfish.print.map.tiled.AbstractTiledLayerParams

Direct Known Subclasses:

AbstractWMXLayerParams, OsmLayerParam

public abstract class AbstractTiledLayerParams
extends AbstractLayerParams

Contains the standard parameters for tiled layers.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	imageFormat The format of the image.
java.lang.String	rasterStyle The name of the style (in Configuration or Template) to use when drawing the layer to the map.

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

name, opacity

Constructor Summary

Constructors

Constructor and Description
AbstractTiledLayerParams()

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.lang.String	createCommonUrl(com.google.common.base.Function<com.google.common.collect.Multimap<java.lang.String,java.lang.String>,com.google.common.collect.Multimap<java.lang.String,java.lang.String>> queryParamCustomization) Create a URL that is common to all image requests for this layer.
abstract java.lang.String	getBaseUrl() Get the base url for all tile requests.
abstract boolean	validateBaseUrl() Validates the provided base url.

Methods inherited from class java.lang.Object

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

Field Detail

rasterStyle

public java.lang.String rasterStyle

The name of the style (in Configuration or Template) to use when drawing the layer to the map. This is separate from the style in that it indicates how to draw the map. It allows one to apply any of the SLD raster styling.

imageFormat

public java.lang.String imageFormat

The format of the image. It is not a mimetype just the part after the image. for example png, gif, tiff, tif, bmp, etc...

If a protocol needs a mimetype it can add the prefix

Constructor Detail

AbstractTiledLayerParams

public AbstractTiledLayerParams()

Method Detail

getBaseUrl

public abstract java.lang.String getBaseUrl()

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

validateBaseUrl

public abstract boolean validateBaseUrl()

Validates the provided base url.

Returns:

True, if the url is valid.

createCommonUrl

public abstract java.lang.String createCommonUrl(com.google.common.base.Function<com.google.common.collect.Multimap<java.lang.String,java.lang.String>,com.google.common.collect.Multimap<java.lang.String,java.lang.String>> queryParamCustomization)
                                          throws java.net.URISyntaxException,
                                                 java.io.UnsupportedEncodingException

Create a URL that is common to all image requests for this layer. It will take the base url and append all mergeable and custom params to the base url.

Parameters:

queryParamCustomization - a function that can optionally modify the Multimap passed into the function and returns the Multimap that will contain all the query params that will be part of the URI. If the function returns null then the original map will be used as the params.

Throws:

java.net.URISyntaxException

java.io.UnsupportedEncodingException