org.mapfish.print.processor.jasper

Class LegendProcessor

java.lang.Object

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

org.mapfish.print.processor.jasper.LegendProcessor

All Implemented Interfaces:

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

public final class LegendProcessor
extends AbstractProcessor<LegendProcessor.Input,LegendProcessor.Output>

Create a legend.

See also: !legend attribute

[[examples=verboseExample,legend_cropped,legend_scaled]]

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LegendProcessor.Input The Input Parameter object for LegendProcessor.
static class	LegendProcessor.Output The Output object of the legend processor method.

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 inherited from interface org.mapfish.print.processor.Processor

MDC_JOB_ID_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LegendProcessor() Constructor.

Method Summary

Modifier and Type	Method and Description
LegendProcessor.Input	createInputParameter() Returns a new/clean instance of a parameter object.
LegendProcessor.Output	execute(LegendProcessor.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	setDpi(java.lang.Double dpi) The DPI value that is used for the legend graphics.
void	setMaxWidth(java.lang.Integer maxWidth) The maximum width in pixels for the legend graphics.
void	setScaled(boolean scaled) When the image is too big do a scaled (default) otherwise do a scale.
void	setTemplate(java.lang.String template) The path to the Jasper Report template for rendering the legend data.

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

Constructor Detail

LegendProcessor

protected LegendProcessor()

Constructor.

Method Detail

setTemplate

public void setTemplate(java.lang.String template)

The path to the Jasper Report template for rendering the legend data.

Parameters:

template - path to the template file

setMaxWidth

public void setMaxWidth(java.lang.Integer maxWidth)

The maximum width in pixels for the legend graphics. If this parameter is set, the legend graphics are cropped or scaled to the given maximum width. In this case a sub-report is created containing the graphic. For reference see the example [[examples=legend_cropped,legend_scaled]].

Parameters:

maxWidth - The maximum width.

setDpi

public void setDpi(java.lang.Double dpi)

The DPI value that is used for the legend graphics.

Parameters:

dpi - The DPI value.

setScaled

public void setScaled(boolean scaled)

When the image is too big do a scaled (default) otherwise do a scale. See the example [[examples=legend_scaled]] Note: This parameter is only considered when `maxWidth` is set.

Parameters:

scaled - do a scaled.

createInputParameter

public LegendProcessor.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 LegendProcessor.Output execute(LegendProcessor.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 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<LegendProcessor.Input,LegendProcessor.Output>

Parameters:

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

configuration - the containing configuration