Jasper Reports 简明教程

JasperReports - Crosstabs

交叉表（交叉制表）报告是包含以表格形式排列数据（行和列）的表的报告。Crosstab 对象用于在主报告中插入交叉表报告。交叉表可与任何级别的数据（名义、序数、间隔或比率）协同使用，通常将存储在报告变量中的汇总数据显示为动态表格的形式。变量用于显示汇总数据，如合计、计数、平均值。

Crosstab Properties

JRXML 元素 <*crosstab*> 用于将交叉表插入报告。

Attribute

以下是一些 <*crosstab*> 元素的属性列表 -

isRepeatColumnHeaders − 指示是否应在分页符之后重新打印列标题。默认值为 true。
isRepeatRowHeaders − 指示是否应在交叉表列中断后重新打印行标题。默认值为 true。
columnBreakOffset − 当列中断发生时，表示在同一页上的前一个下方放置随后的交叉表部分之前的垂直空间量（以像素为单位）。默认值为 10。
runDirection − 表示应从左至右 (LTR) 填充交叉表数据还是从右至左 (RTL) 填充交叉表数据。默认值为 LTR。
ignoreWidth − 表示交叉表将超出于初始交叉表宽度限制，且不生成列中断。否则，它将停止在交叉表宽度限制内呈现列，且仅在所有行开始呈现后才继续处理其余列。默认值为 false。

Sub Elements

<crosstab> 元素下有以下子元素 -

<reportElement> − 此元素定义交叉表在封闭元素中的位置、宽度和高度。此元素的属性包括所有标准的 <reportElement> 属性。
<crosstabParameter> − 此元素用于从交叉表中访问报告变量和参数。此元素的属性包括 -name - 此属性定义参数名称。class - 此属性指示参数类。
<parametersMapExpression> − 此元素用于传递报告变量或包含 java.util.Map 实例的参数，作为交叉表的一组参数。此元素不包含任何属性。
<crosstabDataset> − 此元素定义用于填充交叉表的 a 数据集（有关详细说明，请参见下一节）。此元素的属性包括 -isDataPreSorted - 此属性指示数据集中数据的预排序状态。默认值为 false。
<crosstabHeaderCell> − 此元素定义交叉表左上角区域的内容，在此区域中列标题和行标题交汇。此单元格的大小根据已定义的行宽和行高自动计算。
<rowGroup> - 此元素定义了一个用于将数据分割成行的组。此元素的属性包括 -name - 用于定义行组的名称。width - 用于定义行组的宽度。headerPosition - 用于定义页眉内容的位置（顶部、中部、底部、拉伸）。totalPosition - 用于定义整列的位置（开始、结束、无）。此元素包含以下子元素 -<bucket><crosstabRowHeader><crosstabTotalRowHeader>
<columnGroup> - 此元素定义了一个用于将数据分割成列的组。此元素的属性包括 -name - 用于定义列组名称。height - 用于定义列组页眉的宽度。headerPosition - 用于定义页眉内容的位置（右侧、左侧、中心、拉伸）。totalPosition - 用于定义整列的位置（开始、结束、无）。此元素包含以下子元素 -<bucket><crosstabColumnHeader><crosstabTotalColumnHeader>
<measure> - 此元素定义在行和列中执行的计算。此元素的属性包括 -name - 用于定义度量名称。class - 用于指示度量类别。calculation - 用于指示要在交叉表单元格值之间执行的计算。其值可以是以下任意值：无、计数、计数、和、平均、最低、最高、标准差、方差和第一个。默认值是 Nothing 。
<crosstabCell> - 此元素定义非页眉单元格中的数据布局方式。此元素的属性包括 -columnTotalGroup - 用于指示用于计算列总数的组。height - 用于定义单元格的高度。rowTotalGroup - 用于指示用于计算行总数的组。width - 用于定义单元格的宽度。
<whenNoDataCell> - 此元素定义在空交叉表单元格中显示的内容。此元素不包含任何属性。

Data Grouping in Crosstab

交叉表计算引擎通过遍历关联数据集记录来聚合数据。要聚合数据，首先需要对数据进行分组。在交叉表中，行和列基于特定的组项（称为 buckets ）。存储段定义应包含 -

bucketExpression - 要评估以获取数据组项的表达式。
comparatorExpression - 如果值的自然排序不是最佳选择，则需要此项。
orderByExpression - 用于指示用于对数据进行排序的值。

交叉表中的行和列组（上述定义）依赖于 buckets 。

Built-In Crosstab Total Variables

下面是按名称命名的变量中可访问的与单元格对应的当前度量值和不同级别的总计列表：

度量计算的当前值存储在与度量同名的变量中。
<Measure>_<Column Group>_ALL - 这将生成来自同一行的列组中所有条目的总计。
<Measure>_<Row Group>_ALL - 这将生成来自同一列的行组中所有条目的总计。
<Measure>_<Row Group>_<Column Group>_ALL - 这将生成对应于行组和列组中所有条目的合并总计。

Example

为了演示交叉表，让我们编写一个新的报表模板（jasper_report_template.jrxml）。在此处，我们将交叉表添加到摘要部分。将其保存到目录 C:\tools\jasperreports-5.0.1\test 。该文件的具体内容如下：

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

<!DOCTYPE jasperReport PUBLIC "//JasperReports//DTD Report Design//EN"
   "http://jasperreports.sourceforge.net/dtds/jasperreport.dtd">

<jasperReport xmlns = "http://jasperreports.sourceforge.net/jasperreports"
   xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation = "http://jasperreports.sourceforge.net/jasperreports
   http://jasperreports.sourceforge.net/xsd/jasperreport.xsd"
   name = "jasper_report_template" language = "groovy" pageWidth = "595"
   pageHeight = "842" columnWidth = "555" leftMargin = "20" rightMargin = "20"
   topMargin = "20" bottomMargin = "20">

   <parameter name = "ReportTitle" class = "java.lang.String"/>
   <parameter name = "Author" class = "java.lang.String"/>

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

   <title>
      <band height = "70">

         <line>
            <reportElement x = "0" y = "0" width = "515" height = "1"/>
         </line>

         <textField isBlankWhenNull = "true" bookmarkLevel = "1">
            <reportElement x = "0" y = "10" width = "515" height = "30"/>

            <textElement textAlignment = "Center">
               <font size = "22"/>
            </textElement>

            <textFieldExpression class = "java.lang.String">
               <![CDATA[$P{ReportTitle}]]>
            </textFieldExpression>

            <anchorNameExpression>
               <![CDATA["Title"]]>
            </anchorNameExpression>
         </textField>

         <textField isBlankWhenNull = "true">
            <reportElement  x = "0" y = "40" width = "515" height = "20"/>

            <textElement textAlignment = "Center">
               <font size = "10"/>
            </textElement>

            <textFieldExpression class = "java.lang.String">
               <![CDATA[$P{Author}]]>
            </textFieldExpression>
         </textField>

      </band>
   </title>

   <summary>
      <band height = "60">

      <crosstab>
         <reportElement width = "782" y = "0" x = "0" height = "60"/>

         <rowGroup name = "nameGroup" width = "100">

            <bucket>
               <bucketExpression class = "java.lang.String">
                  <![CDATA[$F{name}]]>
               </bucketExpression>
            </bucket>

            <crosstabRowHeader>

               <cellContents>
                  <box border = "Thin" borderColor = "black"/>

                  <textField>
                     <reportElement width = "100" y = "0" x = "0" height = "20"/>
                     <textElement textAlignment = "Right"
                        verticalAlignment = "Middle"/>

                     <textFieldExpression>
                        <![CDATA[$V{nameGroup}]]>
                     </textFieldExpression>
                  </textField>

               </cellContents>

            </crosstabRowHeader>

         </rowGroup>

         <columnGroup name = "countryGroup" height = "20">
            <bucket>

               <bucketExpression class = "java.lang.String">
                  $F{country}
               </bucketExpression>
            </bucket>

            <crosstabColumnHeader>
               <cellContents>
                  <box border = "Thin" borderColor = "black"/>
                  <textField isStretchWithOverflow = "true">
                     <reportElement width = "60" y = "0" x = "0" height = "20"/>
                     <textElement verticalAlignment = "Bottom"/>
                     <textFieldExpression>
                        <![CDATA[$V{countryGroup}]]>
                     </textFieldExpression>
                  </textField>
               </cellContents>
            </crosstabColumnHeader>

         </columnGroup>

         <measure name = "tailNumCount" class = "java.lang.Integer"
            calculation = "Count">
            <measureExpression>$F{country}</measureExpression>
         </measure>

         <crosstabCell height = "20" width = "60">
            <cellContents backcolor = "#FFFFFF">
               <box borderColor = "black" border = "Thin"/>
               <textField>
                  <reportElement x = "5" y = "0" width = "55" height = "20"/>
                  <textElement textAlignment = "Left"
                     verticalAlignment = "Bottom"/>
                  <textFieldExpression class = "java.lang.Integer">
                      $V{tailNumCount}
                  </textFieldExpression>
               </textField>
            </cellContents>
         </crosstabCell>

      </crosstab>

      </band>
   </summary>

</jasperReport>

上述文件的详细信息如下：

交叉表由 <crosstab> 元素定义。
<rowGroup> 元素定义了一个用于将数据分割成行的组。在此处，每行将针对不同的名称显示数据。
<bucket> 和 <bucketExpression> 元素定义要作为 <rowGroup> 组分隔符使用的报告表达式。在这里，我们使用 name 字段作为分隔符，以便按 name 拆分行。
<crosstabRowHeader> 元素定义要作为行标题使用的表达式。它包含一个 <cellContents> 子元素，该子元素类似于 crosstab 中的内部频带。我们已经将 <crosstabRowHeader> 中文本字段的变量名称分配给 <rowGroup>（通过其名称属性），因而创建了隐式变量，而不是为该变量定义名称。<crosstabRowHeader> 元素定义针对整行的标题单元格的内容。它只将一个 <cellContents> 元素作为其唯一子元素。
<columnGroup> 元素及其子元素类似于 <rowGroup> 元素，但它们影响列而不是行。
<measure> 元素定义将在行和列中执行的计算。计算属性设置为 Count。
<crosstabCell> 元素定义非标题单元格中的数据将如何布置。此元素还包含一个 <crosstabCell> 元素作为其唯一子元素。

用于填充报告的 Java 代码保持不变。文件 C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\JasperReportFill.java 的内容如下 -

package com.tutorialspoint;

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\tutorialspoint\DataBean.java 的内容如下 -

package com.tutorialspoint;

public class DataBean {
   private String name;
   private String country;

   public String getName() {
      return name;
   }

   public void setName(String name) {
      this.name = name;
   }

   public String getCountry() {
      return country;
   }

   public void setCountry(String country) {
      this.country = country;
   }
}

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

package com.tutorialspoint;

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;
   }
}

Report Generation

接下来，让我们使用我们的常规 ANT 构建过程编译和执行上述文件。文件 build.xml（保存在目录 C:\tools\jasperreports-5.0.1\test 中）的内容如下所示。

导入文件 - baseBuild.xml 从第 Environment Setup 章中获取，并应放置在与 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 = ".">
               <include name = "*.jrxml" />
            </fileset>
         </src>
         <classpath refid = "classpath" />
      </jrc>

   </target>

</project>

接下来，让我们打开命令行窗口并转到放置 build.xml 的目录。最后，执行以下命令 ant -Dmain-class=com.tutorialspoint.JasperReportFill （viewFullReport 是默认目标） -

C:\tools\jasperreports-5.0.1\test>ant -Dmain-class=com.tutorialspoint.JasperReportFill
Buildfile: C:\tools\jasperreports-5.0.1\test\build.xml

clean-sample:
   [delete] Deleting directory C:\tools\jasperreports-5.0.1\test\classes
   [delete] Deleting: C:\tools\jasperreports-5.0.1\test\jasper_report_template.jasper

compile:
   [mkdir] Created dir: C:\tools\jasperreports-5.0.1\test\classes
   [javac] C:\tools\jasperreports-5.0.1\test\baseBuild.xml:28:
   warning: 'includeantruntime' was not set, defaulting to
   [javac] Compiling 3 source files to C:\tools\jasperreports-5.0.1\test\classes

compilereportdesing:
   [jrc] Compiling 1 report design files.
   [jrc] log4j:WARN No appenders could be found for logger
   (net.sf.jasperreports.engine.xml.JRXmlDigesterFactory).
   [jrc] log4j:WARN Please initialize the log4j system properly.
   [jrc] log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig
      for more info.
   [jrc] File : C:\tools\jasperreports-5.0.1\test\jasper_report_template.jrxml ... OK.

run:
   [echo] Runnin class : com.tutorialspoint.JasperReportFill
   [java] log4j:WARN No appenders could be found for logger
   (net.sf.jasperreports.extensions.ExtensionsEnvironment).
   [java] log4j:WARN Please initialize the log4j system properly.

viewFillReport:
   [java] log4j:WARN No appenders could be found for logger (
   net.sf.jasperreports.extensions.ExtensionsEnvironment).
   [java] log4j:WARN Please initialize the log4j system properly.

BUILD SUCCESSFUL
Total time: 20 minutes 53 seconds

作为上述编译的结果，一个 JasperViewer 窗口会打开，如以下给出的屏幕截图所示 -

在这里，我们看到每个国家和名称都被制成表格。