jasperreports中文学习教程:[2]报表字段

jasperreports中文学习教程:[2]报表字段

工具/原料

jasperreports报表

方法/步骤

报表字段是代表数据源和报表模板之间的数据映射元素。

字段可以在报告中的表达式进行组合，以获得所需的输出。

报表模板可以包含零个或更多的<field>元素。当声明报表字段，数据源应提供相应的数据到所有在报告模板中定义的字段。

字段声明

字段声明做如下： 

<field name="FieldName" class="java.lang.String"/> 

name属性

<field>元素的name属性是强制性的。

它通过名称引用的报表表达的字段。

class属性

class属性指定的字段值的类名。

它的默认值是java.lang.String。这是可以改变的，以在运行时可用任何类。不论一个报表字段的类型，引擎采用铸造于该$ F{}标记用于报表表达式，从而使手工投射不必要。

字段描述

<fieldDesciption>元素是可选元素。

实现自定义的数据源，例如，当这是非常有用的。我们可以存储一个密钥或一些信息，使用它我们可以在运行时自定义数据源中检索字段的值。通过使用<fieldDesciption>元素而不是字段名，可以检索从数据源中的字段值时容易克服字段命名约定的限制。

下面是一段代码从我们现有的jrxml文件（第二章报告的设计）。

在这里我们可以看到name, class 和 fieldDescription 元素的使用。

<field name="country" class="java.lang.String">

    <fieldDescription><![CDATA[country]]></fieldDescription>

</field>

<field name="name" class="java.lang.String">

    <fieldDescription><![CDATA[name]]></fieldDescription>

</field>  

排序字段

数据的排序是必要的，数据源实现不支持它（如CSV数据源），JasperReports的支持在内存领域为基础的数据源排序。

排序可以使用的报表模板的一个或多个<sortField>元素来完成。

如果指定ATLEAST1排序字段，在报告填充过程中的数据源传递给JRSortableDataSource实例。

这反过来从获取数据源中的所有记录，根据指定的字段进行排序的内存中，并替换原来的数据源。

排序字段名称应该是相同的报表字段名称。用于排序的字段应该具有实现java.util.Comparable类型。

进行自然顺序排序的所有字段除外java.lang.String类型（对于字符串类型，对应报告的填充区域自动分页使用）。当有多个排序字段指定，排序将使用的字段进行中它们出现在报告模板的顺序排序键。下面的例子demonstartes显示排序功能。

在java代码报告填充保持不变。该文件 C:\tools\jasperreports-5.0.1\test\src\com\yiibai\JasperReportFill.java 的内容如下：

package com.yiibai;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.Map;

import net.sf.jasperreports.engine.JRException;

import net.sf.jasperreports.engine.JasperFillManager;

import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource;

public class JasperReportFill {

   @SuppressWarnings("unchecked")

   public static void main(String[] args) {

      String sourceFileName =

      "C://tools/jasperreports-5.0.1/test/jasper_report_template.jasper";

      DataBeanList DataBeanList = new DataBeanList();

      ArrayList<DataBean> dataList = DataBeanList.getDataBeanList();

      JRBeanCollectionDataSource beanColDataSource =

      new JRBeanCollectionDataSource(dataList);

      Map parameters = new HashMap();

      /**

       * Passing ReportTitle and Author as parameters

       */

      parameters.put("ReportTitle", "List of Contacts");

      parameters.put("Author", "Prepared By Manisha");

      try {

         JasperFillManager.fillReportToFile(

         sourceFileName, parameters, beanColDataSource);

      } catch (JRException e) {

         e.printStackTrace();

      }

   }

}  

文件 C:\tools\jasperreports-5.0.1\test\src\com\yiibai\DataBeanList.java 的内容如下：

package com.yiibai;

import java.util.ArrayList;

public class DataBeanList {

   public ArrayList<DataBean> getDataBeanList() {

      ArrayList<DataBean> dataBeanList = new ArrayList<DataBean>();

      dataBeanList.add(produce("Manisha", "India"));

      dataBeanList.add(produce("Dennis Ritchie", "USA"));

      dataBeanList.add(produce("V.Anand", "India"));

      dataBeanList.add(produce("Shrinath", "California"));

      return dataBeanList;

   }

   /**

    * This method returns a DataBean object,

    * with name and country set in it.

    */

   private DataBean produce(String name, String country) {

      DataBean dataBean = new DataBean();

      dataBean.setName(name);

      dataBean.setCountry(country);

      return dataBean;

   }

}  

报表生成

我们将编译和执行使用我们常规Ant构建过程上面的文件。 build.xml文件（目录下保存的内容 C:\tools\jasperreports-5.0.1\test) 如下： 

导入文件 - baseBuild.xml从环境设置章节中了解，并应放置在同一目录中的build.xml。

<?xml version="1.0" encoding="UTF-8"?>

<project name="JasperReportTest" default="viewFillReport" basedir=".">

   <import file="baseBuild.xml" />

   <target name="viewFillReport"

      depends="compile,compilereportdesing,run"

      description="Launches the report viewer to preview

      the report stored in the .JRprint file.">

      <java classname="net.sf.jasperreports.view.JasperViewer"

      fork="true">

         <arg value="-F${file.name}.JRprint" />

         <classpath refid="classpath" />

      </java>

   </target>

   <target name="compilereportdesing"

      description="Compiles the JXML file and

      produces the .jasper file.">

      <taskdef name="jrc"

      classname="net.sf.jasperreports.ant.JRAntCompileTask">

         <classpath refid="classpath" />

      </taskdef>

      <jrc destdir=".">

         <src>

         <fileset dir=".">

正如上文编译的结果，一个JasperViewer窗口打开如下面的屏幕：

同为比较常用的报表工具，FineReport在报表实现过程中所需的代码量远少于jasperreport，大部分的报表代码细节被隐藏，呈现出的是是可视化的设计过程，在FineReport中，定义好数据源之后，设计器会自动读取数据库中的字段，不需要二次定义，以excel导入行式报表为例进行说明，如下：

1.示例1-位置匹配(7.0.4)

如下图，可以看到Excel中的列标题与FineReport模板的列标题完全不一致，但是位置却保持一致：

注：行式报表根据位置匹配的前提是标题完全匹配不上，如果有一个标配能匹配得上，那么就会使用根据标题匹配。

另：若要导入的是Excel2007需要将poi2007_fat.jar拷贝至%FR_HOME%\WebReport\WEB-INF\lib 下。

1.1 模板制作

上图中我们可以看到，Excel中第一行数据在B3~K3中，在填报模板中，导入数据的单元格也要在B3~K3，单元格从上到下扩展：

注：706版本及之后版本可以不设置控件直接导入数据，但是空白单元格却不能导入数据，故我们设置完第一个单元格的扩展属性之后，可以选中所有需要导入数据的单元格，设置一下居中或者边框线等等样式，使所有单元格处于编辑过的状态，不再空白。

注：若导入的报表中不是空白的填报表，而是有取数的功能，则需要将报表的最左父格设置为列表显示。

1.2 报表填报属性设置

在报表填报属性中，只需要将第一行单元格与数据表的数据列进行绑定即可。

该例中，Excel中的原始数据供应商和类别都是具体的名字，若用户希望Excel导入的是名字，但实际入库的是ID怎么办呢？

此时可以在报表填报属性中使用map函数转换，以下具体介绍。

· 定义map函数需要的数据集

增加数据集ds1，SQL语句为：SELECT * FROM [供应商]，查询出供应商ID与供应商名字的对应关系；

再增加数据集ds2，SQL语句为：SELECT * FROM [产品类别]，查询出产品类别ID与类别名字的对应关系。

· 报表填报属性中使用map函数

Excel导入的是名字，使用map函数转换，如下图：

1.3 填报工具栏设置

默认填报工具栏是没有导入Excel按钮的，点击模板>模板web属性>填报页面设置，为该模板单独设置，勾选使用工具栏，为该报表单独设置工具栏，清空工具栏，然后在按钮面板中双击提交按钮和导入excel按钮，将这两个按钮添加到顶部工具栏中，如下图：

已完成模板可参考%FR_HOME%\WebReport\WEB-INF\reportlets\doc\SpecialSubject|\ExcelImport\ExcelImport_1.cpt。

在线查看模板效果请点击ExcelImport_1.cpt

注：在线查看模板需要用到示例中的excel，点击excelimport.xls下载。

2. 示例2-标题匹配(7.0.5)

7.0.5版本行式填报报表在线导入excel是根据列标题自动匹配，标题不相同，则显示空白，即必须保持标题一致，无关于位置，列的位置可以互换。

2.1 模板修改

打开模板%FR_HOME%\WebReport\WEB-INF\reportlets\doc\SpecialSubject|\ExcelImport\ExcelImport_1.cpt，修改如下图，删除左方和下方的空白行，将产品名称和类别列名称修改为产品和类别ID，与excel不一样，同时更换类别和供应商列的位置：