org.mapfish.print.map.geotools

Class AbstractGeotoolsLayer

java.lang.Object

org.mapfish.print.map.geotools.AbstractGeotoolsLayer

All Implemented Interfaces:

MapLayer

Direct Known Subclasses:

AbstractFeatureSourceLayer, AbstractGridCoverage2DReaderLayer, AbstractSingleImageLayer, AbstractTiledLayer

public abstract class AbstractGeotoolsLayer
extends java.lang.Object
implements MapLayer

The AbstractGeotoolsLayer class.

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	AbstractGeotoolsLayer(java.util.concurrent.ExecutorService executorService, AbstractLayerParams params) Constructor.

Method Summary

Modifier and Type	Method and Description
void	cacheResources(HttpRequestCache httpRequestCache, MfClientHttpRequestFactory clientHttpRequestFactory, MapfishMapContext transformer, java.lang.String jobId) Cache any needed resources on disk.
boolean	getFailOnError()
protected abstract java.util.List<? extends org.geotools.map.Layer>	getLayers(MfClientHttpRequestFactory httpRequestFactory, MapfishMapContext transformer, java.lang.String jobId) Get the DataStore object that contains the data for this layer.
protected MapfishMapContext	getLayerTransformer(MapfishMapContext transformer) If the layer transformer has not been prepared yet, do it.
java.lang.String	getName() The layer name.
double	getOpacity() Gets the opacity.
void	prepareRender(MapfishMapContext transformer) Render the layer to the graphics2D object.
void	render(java.awt.Graphics2D graphics2D, MfClientHttpRequestFactory clientHttpRequestFactory, MapfishMapContext transformer, java.lang.String jobId) Render the layer to the graphics2D object.
boolean	supportsNativeRotation() Indicate if the layer supports native rotation (e.g.
com.google.common.base.Optional<MapLayer>	tryAddLayer(MapLayer newLayer) Attempt to add the layer this layer so that both can be rendered as a single layer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mapfish.print.attribute.map.MapLayer

getImageBufferScaling, getRenderType

Constructor Detail

AbstractGeotoolsLayer

protected AbstractGeotoolsLayer(java.util.concurrent.ExecutorService executorService,
                                AbstractLayerParams params)

Constructor.

Parameters:

executorService - the thread pool for doing the rendering.

params - the parameters for this layer

Method Detail

tryAddLayer

public final com.google.common.base.Optional<MapLayer> tryAddLayer(MapLayer newLayer)

Description copied from interface: MapLayer

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.

Specified by:

tryAddLayer in interface MapLayer

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.

prepareRender

public void prepareRender(MapfishMapContext transformer)

Description copied from interface: MapLayer

Render the layer to the graphics2D object.

Specified by:

prepareRender in interface MapLayer

Parameters:

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

render

public final void render(java.awt.Graphics2D graphics2D,
                         MfClientHttpRequestFactory clientHttpRequestFactory,
                         MapfishMapContext transformer,
                         java.lang.String jobId)

Description copied from interface: MapLayer

Render the layer to the graphics2D object.

Specified by:

render in interface MapLayer

Parameters:

graphics2D - the graphics object.

clientHttpRequestFactory - The factory to use for making http requests.

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

jobId - the job ID

getOpacity

public double getOpacity()

Description copied from interface: MapLayer

Gets the opacity.

Specified by:

getOpacity in interface MapLayer

Returns:

the opacity

getLayers

protected abstract java.util.List<? extends org.geotools.map.Layer> getLayers(MfClientHttpRequestFactory httpRequestFactory,
                                                                              MapfishMapContext transformer,
                                                                              java.lang.String jobId)
                                                                       throws java.lang.Exception

Get the DataStore object that contains the data for this layer.

Parameters:

httpRequestFactory - the factory for making http requests

transformer - the map transformer

jobId - the job ID

Throws:

java.lang.Exception

supportsNativeRotation

public boolean supportsNativeRotation()

Description copied from interface: MapLayer

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

Specified by:

supportsNativeRotation in interface MapLayer

Returns:

True if the layer itself takes care of rotating.

getName

public final java.lang.String getName()

Description copied from interface: MapLayer

The layer name.

Specified by:

getName in interface MapLayer

getFailOnError

public final boolean getFailOnError()

getLayerTransformer

protected final MapfishMapContext getLayerTransformer(MapfishMapContext transformer)

If the layer transformer has not been prepared yet, do it.

Parameters:

transformer - the transformer

cacheResources

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

Description copied from interface: MapLayer

Cache any needed resources on disk.

Specified by:

cacheResources in interface MapLayer

Parameters:

httpRequestCache - TODO

clientHttpRequestFactory - client http request factory

transformer - transformer

jobId - the job ID