一.前言
JasperReport是一个强大、灵活的报表生成工具，能够展示丰富的页面内容，并将之转换成PDF，HTML，或者XML格式。该库完全由Java写成，可以用于在各种Java应用程序，包括J2EE，Web应用程序中生成动态内容。
二.图表高级定制介绍
在JasperReport中允许用户实现JRChartCustomizer接口覆写customize方法来扩展对图表显示的高级定制,我将这个功能称之为JasperReport的一个扩展图表显示的插件.
在报表流程中,这个插件运行的时间是在报表填充时,重载的方法customize会被自动调用,用来实现定制报表的显示.
示例代码:
public class BESChartCustomizers extends JRAbstractChartCustomizer {
public void customize(JFreeChart chart, JRChart jasperChart) {
// TODO Auto-generated method stub
}
}注意:
在报表中,如果报表模板中的”parameter”,” variable”,”field”也需要被定制化,那么开发人员需要编写定制类继承类抽象类JRAbstractChartCustomizer,而不是通过实现接口JRChartCustomizer的方式来定制.因为抽象类JRAbstractChartCustomizer实现了接口JRChartCustomizer而且提供一系列对”parameter”,” variable”,”field”操作的方式.
示例代码:
public class BESChartCustomizers extends JRAbstractChartCustomizer {
public void customize(JFreeChart chart, JRChart jasperChart) {
Object parameterValue = getParameterValue("ParameterXXX");
}
}三.customize方法
customize方法是接口JRAbstractChartCustomizer 中定义的抽象方法,所有对齐实现的方法结构如下
public void customize(JFreeChart chart, JRChart jasperChart) {
// TODO Auto-generated method stub
}关于参数:
第一个参数是chart,提供所有对JFreeChart功能的支持,我们可以对它进行一些定制的修改达到我们需要现实的效果.运行时的实际类型是org.jfree.chart.JFreeChart
第二个参数是jasperChart,提供图表版本类型和一系列在定制化报表中可能需要的数据比如(TitleExpression,TitleFont),运行时的实际类型是net.sf.jasperreports.engine.fill.JRFillChart
如果只是定制渲染报表的显示效果,更过时候我们更加关注第一个参数,因为它是对图表渲染控制的JFreeChart实例.
方法调用时机:
报表填充的时候,图表被渲染之前调用
四.开发思路
针对不同类型的图表有不同的API,这个应该根据具体的业务需求来进行开发.首先我们通过判断运行时实际图表的类型来过滤出设计图表的类型,然后进行强转成实际Plot对象,然后再进行报表功能的自定义.
public class YvesChartCustomizer implements JRChartCustomizer {
public void customize(JFreeChart chart, JRChart jasperChart) {
if (chart.getPlot() instanceof CategoryPlot) {
CategoryPlot plot = (CategoryPlot) chart.getPlot();
if (plot != null) {
if (plot.getRenderer() instanceof BarRenderer) {
BarRenderer renderer = (BarRenderer) plot.getRenderer();
renderer.setDrawBarOutline(true);
for (int i = 0; i < plot.getDataset().getRowKeys().size(); i++) {
renderer.setSeriesOutlinePaint(i, Color.BLACK);
renderer.setSeriesOutlineStroke(i, new BasicStroke(3.0f));
}
}
}
}
}
}效果图
五.常用开发功能
1.获取模板中定义的parameter,variable,field
JRAbstractChartCustomizer中提供了一系列protected修饰的方法用于获取parameter,variable,field的值.
这里选取getParameterValue方法来举例说明,variable和field使用方法使用类似.
public class BESChartCustomizers extends JRAbstractChartCustomizer {
public void customize(JFreeChart chart, JRChart jasperChart) {
// 在设置报表参数时候,知道参数的类型,这里可以进行强制转换
Object parameterValue = getParameterValue("ParameterName");
}
}关于重载的方法getParameterValue的使用规则:
我们可以看到如下源码:
protected final Object getParameterValue(String parameterName)
{
return getParameterValue(parameterName, false);
}
protected final Object getParameterValue(String parameterName, boolean fromInputDataset)
{
return (fromInputDataset ? chartDataset.getInputDataset() : filler.getMainDataset()).getParameterValue(parameterName);
}解释说明:
参数fromInputDataset 是设置参数是从输入的数据集中获取还是从报表数据集中获取.
fromInputDataset 为false也就是getParameterValue(String parameterName)的情况,参数是从报表数据集中获取参数.
仅仅当一个图表设计成使用子数据集作为数据输入的时候才需要使用方法getParameterValue(String parameterName, boolean fromInputDataset)通过参数fromInputDataset来指定获取参数的数据集具体是哪一个.fromInputDataset为true的时代表从子数据集中获取参数.
2.判断运行时实际图表的类型
方式一: 通过第二个参数JRChart jasperChart来判断
byte chartType = jasperChart.getChartType();
public static final byte CHART_TYPE_AREA = 1;
public static final byte CHART_TYPE_BAR3D = 2;
public static final byte CHART_TYPE_BAR = 3;
public static final byte CHART_TYPE_BUBBLE = 4;
public static final byte CHART_TYPE_CANDLESTICK = 5;
public static final byte CHART_TYPE_HIGHLOW = 6;
public static final byte CHART_TYPE_LINE = 7;
public static final byte CHART_TYPE_PIE3D = 8;
public static final byte CHART_TYPE_PIE = 9;
public static final byte CHART_TYPE_SCATTER = 10;
public static final byte CHART_TYPE_STACKEDBAR3D = 11;
public static final byte CHART_TYPE_STACKEDBAR = 12;
public static final byte CHART_TYPE_XYAREA = 13;
public static final byte CHART_TYPE_XYBAR = 14;
public static final byte CHART_TYPE_XYLINE = 15;
public static final byte CHART_TYPE_TIMESERIES = 16;
public static final byte CHART_TYPE_METER = 17;
public static final byte CHART_TYPE_THERMOMETER = 18;
public static final byte CHART_TYPE_MULTI_AXIS = 19;
public static final byte CHART_TYPE_STACKEDAREA = 20;
public static final byte CHART_TYPE_GANTT = 21;方式二: 通过第一个参数JFreeChart chart来判断(原理是根据JFreeChart里面的Plot实例类型来判断)
Plot plot = chart.getPlot();
CategoryPlot
|_CombinedDomainCategoryPlot
|_CombinedRangeCategoryPlot
CompassPlot
ContourPlot
DialPlot
FastScatterPlot
MeterPlot
MultiplePiePlot
PiePlot
|_PiePlot3D
|_RingPlot
PolarPlot
SpiderWebPlot
ThermometerPlot
WaferMapPlot
XYPlot
|_CombinedDomainXYPlot
|_CombinedRangeXYPlot