org.mapfish.print.map.image.wms

Class WmsLayerFactoryPlugin

java.lang.Object

org.mapfish.print.map.geotools.AbstractGridCoverageLayerPlugin

org.mapfish.print.map.image.wms.WmsLayerFactoryPlugin

All Implemented Interfaces:

MapLayerFactoryPlugin<WmsLayerParam>

public final class WmsLayerFactoryPlugin
extends AbstractGridCoverageLayerPlugin
implements MapLayerFactoryPlugin<WmsLayerParam>

Renders WMS layers as single image.

Type: wms

[[examples=printwms_tyger_ny_EPSG_3857,printwms_UsaPopulation_EPSG_4326]]

Constructor Summary

Constructors

Constructor and Description
WmsLayerFactoryPlugin()

Method Summary

Modifier and Type	Method and Description
WmsLayerParam	createParameter() Create an instance of a param object.
java.util.Set<java.lang.String>	getTypeNames() Return a set of all the values the json 'type' property should have for this plugin to apply typenames MUST be lowercase.
WmsLayer	parse(Template template, WmsLayerParam layerData) Inspect the json data and return Optional<MapLayer> or Optional.absent().

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

createStyleSupplier

Methods inherited from class java.lang.Object

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

Constructor Detail

WmsLayerFactoryPlugin

public WmsLayerFactoryPlugin()

Method Detail

getTypeNames

public java.util.Set<java.lang.String> getTypeNames()

Description copied from interface: MapLayerFactoryPlugin

Return a set of all the values the json 'type' property should have for this plugin to apply typenames MUST be lowercase.

Specified by:

getTypeNames in interface MapLayerFactoryPlugin<WmsLayerParam>

createParameter

public WmsLayerParam createParameter()

Description copied from interface: MapLayerFactoryPlugin

Create an instance of a param object. Each instance must be new and unique. Instances must NOT be shared.

The object will be populated from the json. Each public field will be populated by looking up the value in the json.

The same mechanism used for reading from the JSON into the param object is also used for parsing the JSON into Attribute value objects. See ReflectiveAttribute.createValue(org.mapfish.print.config.Template)()} for details on how the parsing mechanism works.

Specified by:

createParameter in interface MapLayerFactoryPlugin<WmsLayerParam>

parse

@Nonnull
public WmsLayer parse(@Nonnull
                               Template template,
                               @Nonnull
                               WmsLayerParam layerData)

Description copied from interface: MapLayerFactoryPlugin

Inspect the json data and return Optional<MapLayer> or Optional.absent().

Specified by:

parse in interface MapLayerFactoryPlugin<WmsLayerParam>

Parameters:

template - the configuration related to the current request.

layerData - an object populated from the json for the layer