net.sf.jasperreports.customvisualization.Processor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jasperreports-custom-visualization Show documentation

JasperReports Custom Visualization Component

There is a newer version: 6.21.4

Show newest version

/*
 * JasperReports - Free Java Reporting Library.
 * Copyright (C) 2001 - 2023 Cloud Software Group, Inc. All rights reserved.
 * http://www.jaspersoft.com
 *
 * Unless you have purchased a commercial license agreement from Jaspersoft,
 * the following license terms apply:
 *
 * This program is part of JasperReports.
 *
 * JasperReports is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * JasperReports is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with JasperReports. If not, see .
 */
package net.sf.jasperreports.customvisualization;

import java.util.Map;

/**
 *
 * @author Giulio Toffoli ([email protected])
 */
public interface Processor 
{
	public static final String CONF_WIDTH  = "width";
	public static final String CONF_HEIGHT = "height";
	public static final String CONF_SERIES = "series";
	public static final String CONF_PRINT_ELEMENT = "element";
	
	/**
	 * Process a set of values, to build the script that will perform the
	 * visualization.
	 * 
	 * Why a Map and not a serious object?! Well, to be able to implement this
	 * class without having to declare any dependency by JasperReports.
	 * 
	 * Moreover, it is not really required to implement this interface, it is
	 * enough that a class provides this method, the component will look for it!
	 * 
	 * Input: a Map with the component, the item properties and the series.
	 * 
	 * 
	 * 
	 * 
	 *	  
	 *	  
	 *	  
	 * 
	 * 
	 *	  
	 *	  
	 *	  
	 * 
	 * 
	 *	  
	 *	  
	 *	  
	 * 
	 * 
	 *	  
	 *	  
	 *	  
	 * 
	 * 
	 *	  
	 *	  
	 *	  
	 * 
	 * key Type Description
Processor.CONF_PRINT_ELEMENT net.sf.jasperreports.engine.fill.JRTemplateGenericPrintElement The print element produced by the fill process
Processor.CONF_SERIES Collection a collection of series, which are List of Maps.
Processor.CONF_WIDTH Integer the element width
Processor.CONF_HEIGHT Integer the element height
Processor.CONF_KEY String the element key/id to be used in the HTML
	 * 
	 * 
	 * Series are represented as lists of Maps. The Map is the record, and contain the
	 * properties set for the series.
	 *
	 * 
	 * The result should include at least the "script key.
	 * output_html: a string with the main script, optional styles and other things that will be output
	 * 
	 * @param configuration the Map that will be passed to the velocity Template.
	 * @return the processing result
	 */
	public Map processConfiguration( Map configuration );

}

key	Type	Description
Processor.CONF_PRINT_ELEMENT	net.sf.jasperreports.engine.fill.JRTemplateGenericPrintElement	The print element produced by the fill process
Processor.CONF_SERIES	Collection	a collection of series, which are List of Maps.
Processor.CONF_WIDTH	Integer	the element width
Processor.CONF_HEIGHT	Integer	the element height
Processor.CONF_KEY	String	the element key/id to be used in the HTML