Package org.mapfish.print.attribute.map

Interface MapLayer

All Known Implementing Classes:

AbstractFeatureSourceLayer, AbstractGeotoolsLayer, AbstractGridCoverage2DReaderLayer, AbstractSingleImageLayer, AbstractTiledLayer, FeatureLayer, GeoJsonLayer, GeotiffLayer, GmlLayer, GridLayer, ImageLayer, OsmLayer, TiledWmsLayer, WmsLayer, WMTSLayer

public interface MapLayer

Encapsulates the data required to load map data for a layer and render it.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MapLayer.RenderType	Enumerated type to specify whether layer should be rendered as PNG, JPEG or SVG.

Method Summary

Modifier and Type	Method	Description
double	getImageBufferScaling()	Get the scale ratio between the tiles resolution and the target resolution.
java.lang.String	getName()	The layer name.
double	getOpacity()	Gets the opacity.
MapLayer.RenderType	getRenderType()	Specify whether layer should be rendered as PNG, JPEG or SVG.
void	prefetchResources(HttpRequestFetcher httpRequestFetcher, MfClientHttpRequestFactory clientHttpRequestFactory, MapfishMapContext transformer, Processor.ExecutionContext context)	Cache any needed resources on disk.
void	prepareRender(MapfishMapContext transformer, MfClientHttpRequestFactory clientHttpRequestFactory)	Render the layer to the graphics2D object.
void	render(java.awt.Graphics2D graphics2D, MfClientHttpRequestFactory clientHttpRequestFactory, MapfishMapContext transformer, Processor.ExecutionContext context)	Render the layer to the graphics2D object.
boolean	supportsNativeRotation()	Indicate if the layer supports native rotation (e.g.
java.util.Optional<MapLayer>	tryAddLayer(MapLayer newLayer)	Attempt to add the layer this layer so that both can be rendered as a single layer.

Method Detail

tryAddLayer

java.util.Optional<MapLayer> tryAddLayer(MapLayer newLayer)

Attempt to add the layer this layer so that both can be rendered as a single layer.

For example: 2 WMS layers from the same WMS server can be combined into a single WMS layer and the map can be rendered with a single WMS request.

Parameters:

newLayer - the layer to combine with this layer. The new layer will be rendered below the current layer.

Returns:

If the two layers can be combined then a map layer representing the two layers will be returned. If the two layers cannot be combined then Option.absent() will be returned.

getImageBufferScaling

double getImageBufferScaling()

Get the scale ratio between the tiles resolution and the target resolution. Used to don't scale the tiles on tiled layer.

prepareRender

void prepareRender(MapfishMapContext transformer,
                   MfClientHttpRequestFactory clientHttpRequestFactory)

Render the layer to the graphics2D object.

Parameters:

transformer - the map transformer containing the map bounds and size.

clientHttpRequestFactory - the factory to use for making http requests.

render

void render(java.awt.Graphics2D graphics2D,
            MfClientHttpRequestFactory clientHttpRequestFactory,
            MapfishMapContext transformer,
            Processor.ExecutionContext context)

Render the layer to the graphics2D object.

Parameters:

graphics2D - the graphics object.

clientHttpRequestFactory - The factory to use for making http requests.

transformer - the map transformer containing the map bounds and size.

context - the job ID

supportsNativeRotation

boolean supportsNativeRotation()

Indicate if the layer supports native rotation (e.g. WMS layers with the "angle" parameter).

Returns:

True if the layer itself takes care of rotating.

getName

java.lang.String getName()

The layer name.

getRenderType

MapLayer.RenderType getRenderType()

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

Returns:

render type

prefetchResources

void prefetchResources(HttpRequestFetcher httpRequestFetcher,
                       MfClientHttpRequestFactory clientHttpRequestFactory,
                       MapfishMapContext transformer,
                       Processor.ExecutionContext context)

Cache any needed resources on disk.

Parameters:

httpRequestFetcher - TODO

clientHttpRequestFactory - client http request factory

transformer - transformer

context - the job ID

getOpacity

double getOpacity()

Gets the opacity.

Returns:

the opacity