Package org.mapfish.print.map.geotools.grid

Class GridLayer

java.lang.Object
org.mapfish.print.map.geotools.grid.GridLayer
All Implemented Interfaces:
MapLayer
public final class GridLayer extends Object implements MapLayer
A layer which is a spatial grid of lines on the map.

  • Constructor Details

    • GridLayer

      public GridLayer(ExecutorService executorService, FeatureSourceSupplier featureSourceSupplier, StyleSupplier<org.geotools.api.data.FeatureSource<?,?>> styleSupplier, boolean renderAsSvg, GridParam params, org.mapfish.print.map.geotools.grid.LabelPositionCollector labels)
      Constructor.
      Parameters:
      executorService - the thread pool for doing the rendering.
      featureSourceSupplier - a function that creates the feature source. This will only be called once.
      styleSupplier - a function that creates the style for styling the features. This will only be called once.
      renderAsSvg - is the layer rendered as SVG?
      params - the parameters for this layer
      labels - the grid labels to render

  • Method Details

    • tryAddLayer

      public 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 MapLayer.LayerContext prepareRender(MapfishMapContext transformer, MfClientHttpRequestFactory clientHttpRequestFactory)
      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.
      clientHttpRequestFactory - the factory to use for making http requests.
      Returns:
      the LayerContext for this requested rendering.

    • render

      public void render(Graphics2D graphics, MfClientHttpRequestFactory clientHttpRequestFactory, MapfishMapContext transformer, Processor.ExecutionContext context, MapLayer.LayerContext layerContext)
      Description copied from interface: MapLayer
      Render the layer to the graphics2D object.
      Specified by:
      render in interface MapLayer
      Parameters:
      graphics - 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
      layerContext - the context of this layer

    • 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 String getName()
      Description copied from interface: MapLayer
      The layer name.
      Specified by:
      getName in interface MapLayer

    • getRenderType

      public MapLayer.RenderType getRenderType()
      Description copied from interface: MapLayer
      Specify whether layer should be rendered as PNG, JPEG or SVG.
      Specified by:
      getRenderType in interface MapLayer
      Returns:
      render type

    • prefetchResources

      public MapLayer.LayerContext prefetchResources(HttpRequestFetcher httpRequestFetcher, MfClientHttpRequestFactory clientHttpRequestFactory, MapfishMapContext transformer, Processor.ExecutionContext context, MapLayer.LayerContext layerContext)
      Description copied from interface: MapLayer
      Cache any needed resources on disk.
      Specified by:
      prefetchResources in interface MapLayer
      Parameters:
      httpRequestFetcher - TODO
      clientHttpRequestFactory - client http request factory
      transformer - transformer
      context - the job ID
      layerContext - the context of this layer
      Returns:
      the same layer context or one with updated contextual information

    • getOpacity

      public double getOpacity()
      Description copied from interface: MapLayer
      Gets the opacity.
      Specified by:
      getOpacity in interface MapLayer
      Returns:
      the opacity