JasperReports - 交叉表

交叉表(交叉制表)报告是包含表格的报告,这些表格以表格形式跨行和列排列数据。交叉表对象用于在主报告中插入交叉表报告。交叉表可用于任何级别的数据(名义、序数、间隔或比率),通常以动态表的形式显示报告变量中包含的汇总数据。变量用于显示聚合数据,例如总和、计数、平均值。

交叉表属性

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

属性

以下是 <crosstab> 元素的属性列表 −

  • isRepeatColumnHeaders − 指示分页符后是否应重新打印列标题。默认值为 true

  • isRepeatRowHeaders − 指示交叉表列分隔符后是否应重新打印行标题。默认值为 true

  • columnBreakOffset − 发生列分隔符时,指示在同一页上下一个交叉表片段放置在前一个交叉表片段下方之前的垂直空间量(以像素为单位)。默认值为 10。

  • runDirection − 指示交叉表数据是否应从左到右 (LTR) 或从右到左 (RTL) 填充。默认值为 LTR。

  • ignoreWidth − 表示交叉表是否会超出初始交叉表宽度限制且不生成列分隔符。否则,它将停止渲染交叉表宽度限制内的列,并且仅在所有行都开始渲染后才继续渲染剩余的列。默认值为 false

子元素

<crosstab> 元素具有以下子元素 −

  • <reportElement> − 此元素定义交叉表在其封闭范围内的位置、宽度和高度。此元素的属性包括所有标准 <reportElement> 属性。

  • <crosstabParameter> − 此元素用于从交叉表内访问报告变量和参数。此元素的属性包括 −

    • name − 这定义参数名称。

    • class − 这表示参数类。

  • <parametersMapExpression> −此元素用于传递包含 java.util.Map 实例的报表变量或参数,作为交叉表的一组参数。此元素不包含任何属性。

  • <crosstabDataset> − 此元素定义用于填充交叉表的数据集(有关详细说明,请参阅下一节)。此元素的属性包括 −

    • isDataPreSorted − 这表示数据集中的数据是否已预先排序。默认值为 false

  • <crosstabHeaderCell> − 此元素定义交叉表左上角列标题和行标题相交区域的内容。此单元格的大小是根据定义的行和列的宽度和高度自动计算的。

  • <rowGroup> − 此元素定义用于将数据拆分为行的组。此元素的属性包括 −

    • name − 定义行组的名称。

    • width − 定义行组的宽度。

    • headerPosition − 定义标题内容的位置(顶部、中间、底部、延伸)。

    • totalPosition − 定义整个列的位置(开始、结束、无)。

    此元素包含以下子元素 −

    • <bucket>

    • <crosstabRowHeader>

    • <crosstabTotalRowHeader>

  • <columnGroup> − 此元素定义用于将数据拆分为列的组。此元素的属性包括 −

    • name − 这定义列组名称。

    • height − 这定义列组标题的高度。

    • headerPosition − 这定义标题内容的位置(右、左、居中、拉伸)。

    • totalPosition − 这定义整个列的位置(开始、结束、无)。

    此元素包含以下子元素 −

    • <bucket>

    • <crosstabColumnHeader>

    • <crosstabTotalColumnHeader>

  • <measure> − 此元素定义要跨行和列执行的计算。此元素的属性包括 −

    • name − 这定义度量名称。

    • class − 这表示度量类。

    • calculation − 这表示要在交叉表单元格值之间执行的计算。其值可以是以下任何值 - Nothing、Count、DistinctCount、Sum、Average、Lowest、Highest、StandardDeviation、VarianceFirst。默认值为 Nothing

  • <crosstabCell> −此元素定义非标题单元格中的数据如何布局。此元素的属性包括 −

    • columnTotalGroup − 这表示用于计算列总计的组。

    • height − 这定义单元格的高度。

    • rowTotalGroup − 这表示用于计算行总计的组。

    • width − 这定义单元格的宽度。

  • <whenNoDataCell> − 此元素定义在空交叉表单元格上显示的内容。此元素不包含任何属性。

交叉表中的数据分组

交叉表计算引擎通过遍历相关数据集记录来聚合数据。为了聚合数据,需要先对它们进行分组。在交叉表中,行和列基于特定的组项,称为存储桶。存储桶定义应包含 −

  • bucketExpression − 要评估的表达式,以便获得数据组项。

  • comparatorExpression − 在值的自然排序不是最佳选择的情况下需要。

  • orderByExpression −表示用于对数据进行排序的值。

交叉表中的行组和列组(如上定义)依赖于存储桶

内置交叉表总计变量

以下是度量的当前值列表,可以通过按照以下方案命名的变量访问与单元格相对应的不同级别的总计 −

  • 度量计算的当前值存储在与度量同名的变量中。

  • <Measure>_<Column Group>_ALL − 这将得出同一行中列组中所有条目的总计。

  • <Measure>_<Row Group>_ALL −这将得出同一列中行组中所有条目的总数。

  • <Measure>_<Row Group>_<Column Group>_ALL − 这将得出行组和列组中所有条目对应的总和。

示例

为了演示交叉表,让我们编写一个新的报告模板 (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 由 <crosstab> 元素定义。

  • <rowGroup> 元素定义一个组,将数据拆分为行。在这里,每行将显示不同名称的数据。

  • <bucket> 和 <bucketExpression> 元素定义要使用哪个报表表达式作为 <rowGroup> 的组分隔符。在这里,我们使用名称字段作为分隔符,以便按名称拆分行。

  • <crosstabRowHeader> 元素定义要用作行标题的表达式。它包含一个子元素,即 <cellContents>,其作用类似于交叉表内的内部带。我们没有在 <crosstabRowHeader> 中为文本字段定义变量名称,而是将名称分配给 <rowGroup>(通过其 name 属性),因此它创建了一个隐式变量。<crosstabRowHeader> 元素定义整行标题单元格的内容。它将单个 <cellContents> 元素作为其唯一子元素。

  • <columnGroup> 元素及其子元素类似于 <rowGroup> 元素,只是它影响的是列而不是行。

  • <measure> 元素定义要跨行和列执行的计算。calculation 属性设置为 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();
      }
   }
}

POJO文件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;
   }
}

报告生成

接下来,让我们使用常规 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 = ".">
               <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 窗口,如下图所示 −

Jasper 报告交叉表示例

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