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 - 這指示要在交叉表單元格值之間執行的計算。其值可以是以下任何一個 - 無、計數、不同計數、總和、平均值、最低、最高、標準差、方差和 第一個。預設值為無。
<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> 元素定義。
<rowGroup> 元素定義一個組以將資料拆分為行。在這裡，每一行將顯示不同名稱的資料。
<bucket> 和 <bucketExpression> 元素定義要使用哪個報表表示式作為 <rowGroup> 的組分隔符。在這裡，我們使用 name 欄位作為分隔符，以便按名稱拆分行。
<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 視窗，如下面的螢幕所示 -

在這裡，我們看到每個國家/地區和名稱都已製表。

列印頁面