org.mapfish.print.processor.map

Class SetTiledWmsProcessor

java.lang.Object

org.mapfish.print.processor.AbstractProcessor<SetTiledWmsProcessor.Input,java.lang.Void>

org.mapfish.print.processor.map.SetTiledWmsProcessor

All Implemented Interfaces:

ConfigurationObject, Processor<SetTiledWmsProcessor.Input,java.lang.Void>

public class SetTiledWmsProcessor
extends AbstractProcessor<SetTiledWmsProcessor.Input,java.lang.Void>

Processor that transforms WMS layers that are too big into tiled WMS layers.

This processor will reduce the given max tile size to best match the dimensions of the map. This is to reduce the amount of extra data that is fetched from the WMS server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SetTiledWmsProcessor.Input The input parameter object for SetFeaturesProcessor.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected UriMatchers	matchers The matchers that chooses if the processor is applied or not.

Fields inherited from interface org.mapfish.print.processor.Processor

MDC_JOB_ID_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SetTiledWmsProcessor() Constructor.

Method Summary

Modifier and Type	Method and Description
SetTiledWmsProcessor.Input	createInputParameter() Returns a new/clean instance of a parameter object.
java.lang.Void	execute(SetTiledWmsProcessor.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.
void	setMatchers(java.util.List<? extends URIMatcher> matchers) The matchers used to select the WMS urls that are going to be modified by the processor.
void	setMaxHeight(int maxHeight) Set the maximum height in pixels.
void	setMaxWidth(int maxWidth) Set the maximum width in pixels.

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

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

Field Detail

matchers

protected final UriMatchers matchers

The matchers that chooses if the processor is applied or not.

Constructor Detail

SetTiledWmsProcessor

protected SetTiledWmsProcessor()

Constructor.

Method Detail

createInputParameter

public final SetTiledWmsProcessor.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 java.lang.Void execute(SetTiledWmsProcessor.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<SetTiledWmsProcessor.Input,java.lang.Void>

Parameters:

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

configuration - the containing configuration

setMaxWidth

public void setMaxWidth(int maxWidth)

Set the maximum width in pixels.

Parameters:

maxWidth - the value

setMaxHeight

public void setMaxHeight(int maxHeight)

Set the maximum height in pixels.

Parameters:

maxHeight - the value

setMatchers

public final void setMatchers(java.util.List<? extends URIMatcher> matchers)

The matchers used to select the WMS urls that are going to be modified by the processor. For example:

 - !restrictUris
   matchers:
     - !dnsMatch
       host: labs.metacarta.com
       port: 80
 

Parameters:

matchers - the list of matcher to use to check if a url is permitted