org.mapfish.print.map.image.wms

Class WmsLayer

java.lang.Object

org.mapfish.print.map.geotools.AbstractGeotoolsLayer

org.mapfish.print.map.image.AbstractSingleImageLayer

org.mapfish.print.map.image.wms.WmsLayer

All Implemented Interfaces:

MapLayer

public final class WmsLayer
extends AbstractSingleImageLayer

Wms layer.

Nested Class Summary

Nested classes/interfaces inherited from interface org.mapfish.print.attribute.map.MapLayer

MapLayer.RenderType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WmsLayer(java.util.concurrent.ExecutorService executorService, StyleSupplier<org.geotools.coverage.grid.GridCoverage2D> styleSupplier, WmsLayerParam params, com.codahale.metrics.MetricRegistry registry, Configuration configuration) Constructor.

Method Summary

Modifier and Type	Method and Description
void	cacheResources(HttpRequestCache httpRequestCache, MfClientHttpRequestFactory requestFactory, MapfishMapContext transformer, java.lang.String jobId) Cache any needed resources on disk.
WmsLayerParam	getParams() Get the HTTP params.
MapLayer.RenderType	getRenderType() Specify whether layer should be rendered as PNG, JPEG or SVG.
protected java.awt.image.BufferedImage	loadImage(MfClientHttpRequestFactory requestFactory, MapfishMapContext transformer) Load the image at the requested size for the provided map bounds.
boolean	supportsNativeRotation() If supported by the WMS server, a parameter "angle" can be set on "customParams" or "mergeableParams".

Methods inherited from class org.mapfish.print.map.image.AbstractSingleImageLayer

getImageBufferScaling, getLayers

Methods inherited from class org.mapfish.print.map.geotools.AbstractGeotoolsLayer

getFailOnError, getLayerTransformer, getName, getOpacity, prepareRender, render, tryAddLayer

Methods inherited from class java.lang.Object

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

Constructor Detail

WmsLayer

protected WmsLayer(@Nonnull
                   java.util.concurrent.ExecutorService executorService,
                   @Nonnull
                   StyleSupplier<org.geotools.coverage.grid.GridCoverage2D> styleSupplier,
                   @Nonnull
                   WmsLayerParam params,
                   @Nonnull
                   com.codahale.metrics.MetricRegistry registry,
                   @Nonnull
                   Configuration configuration)

Constructor.

Parameters:

executorService - the thread pool for doing the rendering.

styleSupplier - the style to use when drawing the constructed grid coverage on the map.

params - the params from the request data.

registry - the metrics registry.

configuration - the configuration.

Method Detail

loadImage

protected java.awt.image.BufferedImage loadImage(@Nonnull
                                                 MfClientHttpRequestFactory requestFactory,
                                                 @Nonnull
                                                 MapfishMapContext transformer)
                                          throws java.lang.Throwable

Description copied from class: AbstractSingleImageLayer

Load the image at the requested size for the provided map bounds.

Specified by:

loadImage in class AbstractSingleImageLayer

Parameters:

requestFactory - the factory to use for making http requests

transformer - object containing map rendering information

Throws:

java.lang.Throwable

getParams

public WmsLayerParam getParams()

Get the HTTP params.

Returns:

the HTTP params

supportsNativeRotation

public boolean supportsNativeRotation()

If supported by the WMS server, a parameter "angle" can be set on "customParams" or "mergeableParams". In this case the rotation will be done natively by the WMS.

Specified by:

supportsNativeRotation in interface MapLayer

Overrides:

supportsNativeRotation in class AbstractGeotoolsLayer

Returns:

True if the layer itself takes care of rotating.

getRenderType

public MapLayer.RenderType getRenderType()

Description copied from interface: MapLayer

Specify whether layer should be rendered as PNG, JPEG or SVG.

Returns:

render type

cacheResources

public void cacheResources(@Nonnull
                           HttpRequestCache httpRequestCache,
                           @Nonnull
                           MfClientHttpRequestFactory requestFactory,
                           @Nonnull
                           MapfishMapContext transformer,
                           @Nonnull
                           java.lang.String jobId)

Description copied from interface: MapLayer

Cache any needed resources on disk.

Specified by:

cacheResources in interface MapLayer

Overrides:

cacheResources in class AbstractGeotoolsLayer

Parameters:

httpRequestCache - TODO

requestFactory - client http request factory

transformer - transformer

jobId - the job ID