org.mapfish.print.processor

Interface Processor<In,Out>

Type Parameters:

In - A Java DTO input parameter object of the execute method. The object properties are resolved by looking at the public fields in the object and setting those fields. Only fields in the object itself will be inspected. Object is populated from the Values object.

Out - A Java DTO output/return object from the execute method. properties will be put into the Values object so other processor can access the values.

All Superinterfaces:

ConfigurationObject

All Known Subinterfaces:

HttpProcessor<Param>

All Known Implementing Classes:

AbstractClientHttpRequestFactoryProcessor, AbstractProcessor, AddHeadersProcessor, AddStaticLayersProcessor, CompositeClientHttpRequestFactoryProcessor, CreateMapPagesProcessor, CreateMapProcessor, CreateNorthArrowProcessor, CreateOverviewMapProcessor, CreateScalebarProcessor, DataSourceProcessor, ForwardHeadersProcessor, JasperReportBuilder, LegendProcessor, MapUriProcessor, MergeDataSourceProcessor, PdfConfigurationProcessor, RestrictUrisProcessor, SetFeaturesProcessor, SetStyleProcessor, SetWmsCustomParamProcessor, TableProcessor, UseHttpForHttpsProcessor

public interface Processor<In,Out>
extends ConfigurationObject

Interface for processing input attributes. A processor must NOT contain mutable state because a single processor instance can be ran in multiple threads and one running processor must not interfere with the running of the other instance.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Processor.ExecutionContext An execution context for a specific print task.

Method Summary

Methods

Modifier and Type	Method and Description
In	createInputParameter() Returns a new/clean instance of a parameter object.
Out	execute(In values, Processor.ExecutionContext context) Perform the process on the input attributes.
com.google.common.collect.BiMap<java.lang.String,java.lang.String>	getInputMapperBiMap() Map the variable names to the processor inputs.
java.lang.String	getInputPrefix() Get the prefix to apply to each input value.
com.google.common.collect.BiMap<java.lang.String,java.lang.String>	getOutputMapperBiMap() Map output from processor to the variable in the Jasper Report.
java.lang.String	getOutputPrefix() Get the prefix to apply to each output value.
java.lang.Class<Out>	getOutputType() Get the class of the output type.

Methods inherited from interface org.mapfish.print.config.ConfigurationObject

validate

Method Detail

getOutputType

java.lang.Class<Out> getOutputType()

Get the class of the output type. This is used when determining the outputs this processor produces.

The public fields of the Processor will be the output of the processor and thus can be mapped to inputs of another processor.

getInputMapperBiMap

@Nullable
com.google.common.collect.BiMap<java.lang.String,java.lang.String> getInputMapperBiMap()

Map the variable names to the processor inputs.

createInputParameter

@Nullable
In createInputParameter()

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
Out execute(In values,
                   Processor.ExecutionContext context)
            throws java.lang.Exception

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 getOutputMapperBiMap() map, the mapped name. The key is determined in a similar way as for the input object.

Throws:

java.lang.Exception

getOutputMapperBiMap

@Nullable
com.google.common.collect.BiMap<java.lang.String,java.lang.String> getOutputMapperBiMap()

Map output from processor to the variable in the Jasper Report.

getInputPrefix

java.lang.String getInputPrefix()

Get the prefix to apply to each input value. This provides a simple way to make all output values have unique values.

If input prefix is non-null and non-empty (whitespace is removed) then the prefix will be prepended to the normal name of the input value.

When a prefix is appended the normal name will be capitalized. For example: if the normal name is: map and the prefix is page1 then the final name will be page1Map.

Note: If a mapping is in the getInputMapperBiMap() then the prefix will be ignored for that value and the un-prefixed name from the input mapper will be used directly.

Note: If a prefix has white space at the start or end it will be removed.

getOutputPrefix

java.lang.String getOutputPrefix()

Get the prefix to apply to each output value. This provides a simple way to make all output values have unique values.

If output prefix is non-null and non-empty (whitespace is removed) then the prefix will be prepended to the normal name of the output value.

When a prefix is appended the normal name will be capitalized. For example: if the normal name is: map and the prefix is page1 then the final name will be page1Map.

Note: If a mapping is in the getOutputMapperBiMap() then the prefix will be ignored for that value and the un-prefixed name from the output mapper will be used directly.

Note: If a prefix has white space at the start or end it will be removed.