org.mapfish.print.processor.map

Class CreateOverviewMapProcessor

java.lang.Object

org.mapfish.print.processor.AbstractProcessor<CreateOverviewMapProcessor.Input,CreateOverviewMapProcessor.Output>

org.mapfish.print.processor.map.CreateOverviewMapProcessor

All Implemented Interfaces:

ConfigurationObject, Processor<CreateOverviewMapProcessor.Input,CreateOverviewMapProcessor.Output>

public class CreateOverviewMapProcessor
extends AbstractProcessor<CreateOverviewMapProcessor.Input,CreateOverviewMapProcessor.Output>

Processor to create overview maps. Internally CreateMapProcessor is used.

Example Configuration:

 attributes:
    ...
    overviewMap: !overviewMap
      width: 300
      height: 200
      maxDpi: 400
 processors:
    ...
    - !createOverviewMap
      outputMapper:
        layerGraphics: overviewMapLayerGraphics
 

Features:

The attribute overviewMap allows to overwrite all properties of the main map, for example to use different layers. The overview map can have a different rotation than the main map. For example the main map is rotated and the overview map faces north. But the overview map can also be rotated.

The style of the bbox rectangle can be changed by setting the style property.

See also: !overviewMap attribute

[[examples=verboseExample,overviewmap_tyger_ny_EPSG_3857]]

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateOverviewMapProcessor.Input The Input object for the processor.
static class	CreateOverviewMapProcessor.Output Output for the processor.

Nested classes/interfaces inherited from class org.mapfish.print.processor.AbstractProcessor

AbstractProcessor.Context

Nested classes/interfaces inherited from interface org.mapfish.print.processor.Processor

Processor.ExecutionContext

Constructor Summary

Constructors

Constructor and Description
CreateOverviewMapProcessor() Constructor.

Method Summary

Modifier and Type	Method and Description
CreateOverviewMapProcessor.Input	createInputParameter() Returns a new/clean instance of a parameter object.
CreateOverviewMapProcessor.Output	execute(CreateOverviewMapProcessor.Input values, Processor.ExecutionContext context) Perform the process on the input attributes.
protected void	extraValidation(java.util.List<java.lang.Throwable> validationErrors, Configuration configuration) Perform any extra validation a subclass may need to perform.

Methods inherited from class org.mapfish.print.processor.AbstractProcessor

checkCancelState, getInputMapperBiMap, getInputPrefix, getOutputMapperBiMap, getOutputPrefix, getOutputType, setInputMapper, setInputPrefix, setOutputMapper, setOutputPrefix, setPrefix, toString, toString, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateOverviewMapProcessor

public CreateOverviewMapProcessor()

Constructor.

Method Detail

createInputParameter

public final CreateOverviewMapProcessor.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

public final CreateOverviewMapProcessor.Output execute(CreateOverviewMapProcessor.Input values,
                                                       Processor.ExecutionContext context)
                                                throws java.lang.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:

java.lang.Exception

extraValidation

protected final void extraValidation(java.util.List<java.lang.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<CreateOverviewMapProcessor.Input,CreateOverviewMapProcessor.Output>

Parameters:

validationErrors - a list to add errors to so that all validation errors are reported as one.

configuration - the containing configuration