Class GridLayerPlugin
- java.lang.Object
-
- org.mapfish.print.map.geotools.AbstractFeatureSourceLayerPlugin<GridParam>
-
- org.mapfish.print.map.geotools.grid.GridLayerPlugin
-
- All Implemented Interfaces:
MapLayerFactoryPlugin<GridParam>
public final class GridLayerPlugin extends AbstractFeatureSourceLayerPlugin<GridParam>
A layer which is a spatial grid of lines on the map.Type:
grid
[[examples=crosses_point_grid]]
-
-
Field Summary
-
Fields inherited from class org.mapfish.print.map.geotools.AbstractFeatureSourceLayerPlugin
forkJoinPool, parser
-
-
Constructor Summary
Constructors Constructor Description GridLayerPlugin()
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GridParam
createParameter()
Create an instance of a param object.GridLayer
parse(Template template, GridParam layerData)
Inspect the json data and return Optional<MapLayer> or Optional.absent().-
Methods inherited from class org.mapfish.print.map.geotools.AbstractFeatureSourceLayerPlugin
createStyleFunction, getTypeNames, setParser
-
-
-
-
Method Detail
-
createParameter
public GridParam 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. SeeReflectiveAttribute.createValue(org.mapfish.print.config.Template)
()} for details on how the parsing mechanism works.
-
parse
@Nonnull public GridLayer parse(@Nonnull Template template, @Nonnull GridParam layerData)
Description copied from interface:MapLayerFactoryPlugin
Inspect the json data and return Optional<MapLayer> or Optional.absent().- Parameters:
template
- the configuration related to the current request.layerData
- an object populated from the json for the layer
-
-