Package org.mapfish.print.processor.jasper

Class MergeDataSourceProcessor

java.lang.Object

org.mapfish.print.processor.AbstractProcessor<MergeDataSourceProcessor.In,MergeDataSourceProcessor.Out>

org.mapfish.print.processor.jasper.MergeDataSourceProcessor

All Implemented Interfaces:

ConfigurationObject, CustomDependencies, Processor<MergeDataSourceProcessor.In,MergeDataSourceProcessor.Out>

public final class MergeDataSourceProcessor
extends AbstractProcessor<MergeDataSourceProcessor.In,MergeDataSourceProcessor.Out>
implements CustomDependencies

This processor combines DataSources and individual processor outputs (or attribute values) into a single DataSource which can be used in a jasper report's detail section.

An example use case is where we might have zero or many of tables and zero or many legends. You can configure the template with a detail section that contains a subreport, the name of which is a field in the DataSources and the DataSources for the sub-template another field. Then you can merge the legend and the tables into a single DataSources. This way the report will nicely expand depending on if you have a legend and how many tables you have in your report. [[examples=merged_datasource]]

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MergeDataSourceProcessor.In	The input object for MergeDataSourceProcessor.
static final record	MergeDataSourceProcessor.Out	The output object for MergeDataSourceProcessor.
static final class	MergeDataSourceProcessor.Source	Describes the objects used as sources for a merged data source (see !mergeDataSources processor).
static enum	MergeDataSourceProcessor.SourceType	An enumeration of the different types of source objects.

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_APPLICATION_ID_KEY, MDC_JOB_ID_KEY

Method Summary

Modifier and Type	Method	Description
MergeDataSourceProcessor.In	createInputParameter()	Returns a new/clean instance of a parameter object.
MergeDataSourceProcessor.Out	execute(MergeDataSourceProcessor.In values, Processor.ExecutionContext context)	Perform the process on the input attributes.
protected void	extraValidation(List<Throwable> validationErrors, Configuration config)	Perform any extra validation a subclass may need to perform.
Collection<String>	getDependencies()	Get what we dynamically depends on, for the "values" input.
void	setSources(List<MergeDataSourceProcessor.Source> sources)	The source to add to the merged DataSource.

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

Method Details

setSources

public void setSources(List<MergeDataSourceProcessor.Source> sources)

The source to add to the merged DataSource.

Each source indicates if it should be treated as a datasource or as a single item to add to the merged DataSource. If the source indicates that it is a MergeDataSourceProcessor.SourceType.DATASOURCE the object each row in the datasource will be used to form a row in the merged DataSource. If the source type is MergeDataSourceProcessor.SourceType.SINGLE the object will be a single row even if it is in fact a DataSource.

See also: !mergeSource

Parameters:

sources - the source objects to merge

extraValidation

protected void extraValidation(List<Throwable> validationErrors,
 Configuration config)

Description copied from class: AbstractProcessor

Perform any extra validation a subclass may need to perform.

Specified by:

extraValidation in class AbstractProcessor<MergeDataSourceProcessor.In,MergeDataSourceProcessor.Out>

Parameters:

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

config - the containing configuration

createInputParameter

@Nullable
public MergeDataSourceProcessor.In 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.

Specified by:

createInputParameter in interface Processor<MergeDataSourceProcessor.In,MergeDataSourceProcessor.Out>

execute

@Nullable
public MergeDataSourceProcessor.Out execute(MergeDataSourceProcessor.In values,
 Processor.ExecutionContext context)
                                     throws Exception

Description copied from interface: Processor

Perform the process on the input attributes.

Specified by:

execute in interface Processor<MergeDataSourceProcessor.In,MergeDataSourceProcessor.Out>

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

getDependencies

@Nonnull
public Collection<String> getDependencies()

Description copied from interface: CustomDependencies

Get what we dynamically depends on, for the "values" input.

Specified by:

getDependencies in interface CustomDependencies