Package org.mapfish.print.processor.map

Class AddStaticLayersProcessor

java.lang.Object
org.mapfish.print.processor.AbstractProcessor<AddStaticLayersProcessor.Input,Void>
org.mapfish.print.processor.map.AddStaticLayersProcessor
All Implemented Interfaces:
ConfigurationObject, Processor<AddStaticLayersProcessor.Input,Void>
public final class AddStaticLayersProcessor extends AbstractProcessor<AddStaticLayersProcessor.Input,Void>
This processor adds the configured set of layers to the map.

This is useful when all maps should have a default set of background layers or overlays added to those that the client sends for printing.

This can simplify the client so the client only needs to be concerned with the data layers.

See also: !staticLayers attribute [[examples=add_overlay_layer,report]]

  • Constructor Details

    • AddStaticLayersProcessor

      protected AddStaticLayersProcessor()
      Constructor.

  • Method Details

    • setPosition

      public void setPosition(AddStaticLayersProcessor.StaticLayerPosition position)
      Set the position enumeration which indicates where the layers should be added to the map: AddStaticLayersProcessor.StaticLayerPosition.
      Parameters:
      position - the position.

    • extraValidation

      protected void extraValidation(List<Throwable> validationErrors, Configuration configuration)
      Description copied from class: AbstractProcessor
      Perform any extra validation a subclass may need to perform.
      Specified by:
      extraValidation in class AbstractProcessor<AddStaticLayersProcessor.Input,Void>
      Parameters:
      validationErrors - a list to add errors to so that all validation errors are reported as one.
      configuration - the containing configuration

    • createInputParameter

      @Nullable public AddStaticLayersProcessor.Input createInputParameter()
      Description copied from interface: Processor
      Returns a new/clean instance of a parameter object. This instance's will be inspected using reflection to find its public fields and the properties will be set from the Values object.

      The way the properties will be looked up is to

      1. take the bean property name
      2. map it using the input mapper, (if the input mapper does not have a mapping for the property then the unmapped property name is used)
      3. Look up the property value in the Values object using the mapped property name
      4. set the value on the instance created by this method. If the value is null an exception will be thrown UNLESS the HasDefaultValue annotation is on the field for the property.
      The populated instance will be passed to the execute method. It is imperative that a new instance is created each time because they will be used in a multi-threaded environment and thus the same processor instance may be ran in multiple threads with different instances of the parameter object.

      It is important to realize that super classes will also be analyzed, so care must be had with inheritance.

    • execute

      @Nullable public Void execute(AddStaticLayersProcessor.Input values, Processor.ExecutionContext context) throws Exception
      Description copied from interface: Processor
      Perform the process on the input attributes.
      Parameters:
      values - A Java object whose public fields are populated from the Values object (which is used for transferring properties between processors).
      context - The execution context for a print task.
      Returns:
      A Java object whose public fields will be put into the Values object. The key in the Values object is the name of the field or if there is a mapping in the Processor.getOutputMapperBiMap() map, the mapped name. The key is determined in a similar way as for the input object.
      Throws:
      Exception