建立子報表

子報表是 JasperReports 的一項不錯的功能。此功能允許在另一個報表中包含一個報表，也就是說，一個報表可以是另一個報表的子報表。子報表有助於我們保持報表設計的簡單性，因為我們可以建立許多簡單的報表並將它們封裝到主報表中。子報表的編譯和填充方式與普通報表相同。任何報表模板在包含到另一個報表模板中時都可以用作子報表，而無需在內部進行任何更改（報表模板）。

子報表就像普通的報表模板。實際上，它們是 net.sf.jasperreports.engine.JasperReport 物件，這些物件是在編譯 net.sf.jasperreports.engine.design.JasperDesign 物件 後獲得的。

<subreport> 元素

在將子報表引入主報表時，使用 <subreport> 元素。以下是 <subreport> JRXML 元素中的子元素列表。

<reportElement>
<parametersMapExpression> - 用於傳遞包含報表引數的對映到子報表。該對映通常從主報表中的引數獲取，或者使用內建的 REPORTS_PARAMETERS_MAP 引數將父報表的引數傳遞到子報表。此表示式應始終返回一個 java.util.Map 物件，其中鍵是引數名稱。
<subreportParameter> - 此元素用於將引數傳遞到子報表。它有一個屬性 name，這是必需的。
<connectionExpression > - 用於將 java.sql.Connection 傳遞到子報表。僅當子報表模板在報表填充階段需要資料庫連線時才使用它。
<dataSourceExpression> - 用於將資料來源傳遞到子報表。此資料來源通常從主報表中的引數獲取，或者使用內建的 REPORT_DATA_SOURCE 引數將父報表的引數傳遞到子報表。
元素（connectionExpression 和 dataSourceExpression）不能同時出現在 <subreport> 元素宣告中。這是因為我們不能同時為子報表提供資料來源和連線。我們必須選擇其中之一併堅持使用它。
<returnValue> - 用於將子報表變數之一的值分配給主報表變數之一。此子元素具有以下屬性 -
- subreportVariable - 此屬性指定要返回其值的子報表變數的名稱。
- toVariable - 此屬性指定要複製/遞增其值的父報表變數的名稱。
- calculation - 此屬性可以取值：Nothing、Count、DistinctCount、Sum、Average、Lowest、Highest、StandardDeviation、Variance。屬性 calculation 的預設值為“Nothing”。
- incrementerFactoryClass - 此屬性指定用於建立遞增器例項的工廠類。
<subreportExpression> - 指示在何處查詢子報表的已編譯報表模板。此元素具有一個 class 屬性。class 屬性可以取以下任何值：java.lang.String、java.io.File、java.net.URL、java.io.InputStream、net.sf.jasperreports.engine.JasperReport。預設值為 java.lang.String。
isUsingCache - 這是 <subreport> 元素的一個屬性。這是一個布林值，當設定為 true 時，報表引擎將嘗試識別以前載入的子報表模板物件，使用它們指定的源。此快取功能僅適用於表示式返回 java.lang.String 物件作為子報表模板源的子報表元素，表示檔名、URL 或類路徑資源。

示例

讓我們舉一個簡單的例子來演示使用 JRDataSource 建立子報表。讓我們首先編寫兩個新的報表模板，一個作為子報表，另一個作為主報表。子報表（address_report_template.jrxml）模板的內容如下所示。將其儲存到 C:\tools\jasperreports-5.0.1\test 目錄。

<?xml version = "1.0" encoding = "UTF-8"?>
<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 = "address_report_template" pageWidth = "175" pageHeight = "842" 
   columnWidth = "175" leftMargin = "0" rightMargin = "0" 
   topMargin = "0" bottomMargin = "0">

   <field name = "city" class = "java.lang.String"/>
   <field name = "street" class = "java.lang.String"/>
   
   <background>
      <band splitType = "Stretch"/>
   </background>
   
   <title>
      <band height = "20" splitType = "Stretch">
         
         <staticText>
            <reportElement x = "0" y = "0" width = "100" height = "20"/>
            
            <textElement>
               <font size = "14" isBold = "true"/>
            </textElement>
				
            <text><![CDATA[Addresses]]></text>
         </staticText>
      
      </band>
   </title>
   
   <pageHeader>
      <band height = "12" splitType = "Stretch"/>
   </pageHeader>
   
   <columnHeader>
      <band height = "12" splitType = "Stretch"/>
   </columnHeader>
   
   <detail>
      <band height = "27" splitType = "Stretch">
         
         <textField>
            <reportElement x = "0" y = "0" width = "120" height = "20"/>
            
            <textElement>
               <font size = "12" isBold = "true"/>
            </textElement>
            
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$F{city}+" Address:"]]>
            </textFieldExpression>
         </textField>
         
         <textField isStretchWithOverflow = "true">
            <reportElement x = "120" y = "0" width = "435" height = "20"/>
            
            <textElement>
               <font size = "12"/>
            </textElement>
            
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$F{street}]]>
            </textFieldExpression>
         </textField>
      
      </band>
   </detail>
   
   <columnFooter>
      <band height = "8" splitType = "Stretch"/>
   </columnFooter>
  
   <pageFooter>
      <band height = "11" splitType = "Stretch"/>
   </pageFooter>
   
   <summary>
      <band height = "9" splitType = "Stretch"/>
   </summary>

</jasperReport>

由於我們使用資料來源，因此我們需要編寫一個相應的 POJO 檔案 SubReportBean.java，如下所示。將其儲存到目錄 C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint -

package com.tutorialspoint;

public class SubReportBean {
   private String city;
   private String street;

   public String getCity() {
      return city;
   }

   public void setCity(String city) {
      this.city = city;
   }

   public String getStreet() {
      return street;
   }

   public void setStreet(String street) {
      this.street = street;
   }
}

在這裡，我們聲明瞭兩個欄位 'city' 和 'street'，並定義了相應的 getter 和 setter 方法。

現在，讓我們更新現有的 DataBean 檔案。我們將新增一個新欄位 subReportBeanList，它是一個 java.util.List。此欄位將儲存 SubReportBean 物件的列表。DataBean 檔案的內容如下所示。將其儲存到目錄 C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint。

package com.tutorialspoint;

import java.util.List;

public class DataBean {
   private String name;
   private String country;
   private List<SubReportBean> subReportBeanList;

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

   public List<SubReportBean> getSubReportBeanList() {
      return subReportBeanList;
   }

   public void setSubReportBeanList(List<SubReportBean> subReportBeanList) {
      this.subReportBeanList = subReportBeanList;
   }
}

現在，讓我們更新檔案 C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\DataBeanList.java。此檔案的內容如下 -

package com.tutorialspoint;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

public class DataBeanList {
   public ArrayList<DataBean> getDataBeanList() {

      // Create sub report data
      SubReportBean subBean1 = new SubReportBean();
      subBean1.setCity("Mumbai");
      subBean1.setStreet("M.G.Road");
      SubReportBean subBean2 = new SubReportBean();
      subBean2.setCity("New York");
      subBean2.setStreet("Park Street");
      SubReportBean subBean3 = new SubReportBean();
      subBean3.setCity("San Fransisco");
      subBean3.setStreet("King Street");

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

      // Create master report data
      dataBeanList.add(produce("Manisha", "India",
         Arrays.asList(subBean1)));
      dataBeanList.add(produce("Dennis Ritchie", "USA",
         Arrays.asList(subBean2)));
      dataBeanList.add(produce("V.Anand", "India",
         Arrays.asList(subBean1)));
      dataBeanList.add(produce("Shrinath", "California",
         Arrays.asList(subBean3)));

      return dataBeanList;
   }

   /*
    * This method returns a DataBean object,
    * with name, country and sub report
    * bean data set in it.
    */
   private DataBean produce(String name, String country,
      List<SubReportBean> subBean) {
      DataBean dataBean = new DataBean();

      dataBean.setName(name);
      dataBean.setCountry(country);
      dataBean.setSubReportBeanList(subBean);

      return dataBean;
   }
}

在上面的檔案中，我們在 produce() 方法中設定了 SubReportBean 的列表。

現在，讓我們編寫一個新的主報表模板 (jasper_report_template.jrxml)。將此檔案儲存到目錄 C:\tools\jasperreports-5.0.1\test。此檔案的內容如下 -

<?xml version = "1.0" encoding = "UTF-8"?>
<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 = "SUBREPORT_DIR" class = "java.lang.String" isForPrompting = "false">
      <defaultValueExpression>
         <![CDATA["C:\\tools\\jasperreports-5.0.1\\test\\"]]>
      </defaultValueExpression>
   </parameter>
   
   <field name = "country" class = "java.lang.String"/>
   <field name = "name" class = "java.lang.String"/>
   <field name = "subReportBeanList" class = "java.util.List"/>
   
   <background>
      <band splitType = "Stretch"/>
   </background>
   
   <title>
      <band height = "35" splitType = "Stretch">
         
         <staticText>
            <reportElement x = "0" y = "0" width = "204" height = "34"/>
            
            <textElement>
               <font size = "26" isBold = "true"/>
            </textElement>
				
            <text><![CDATA[Contact Report]]></text>
         </staticText>
      
      </band>
   </title>
   
   <pageHeader>
      <band height = "17" splitType = "Stretch"/>
   </pageHeader>
   
   <columnHeader>
      <band height = "21" splitType = "Stretch"/>
   </columnHeader>
   
   <detail>
      <band height = "112" splitType = "Stretch">
            
         <staticText>
            <reportElement x = "0" y = "0" width = "100" height = "20"/>
            
            <textElement>
               <font size = "12" isBold = "true"/>
            </textElement>
				
            <text><![CDATA[Name:]]></text>
         </staticText>
         
         <staticText>
            <reportElement x = "0" y = "20" width = "100" height = "20"/>
            
            <textElement>
               <font size = "12" isBold = "true"/>
            </textElement>
				
            <text><![CDATA[Country:]]></text>
         </staticText>
         
         <textField>
            <reportElement x = "104" y = "0" width = "277" height = "20"/>
            
            <textElement>
               <font size = "12"/>
            </textElement>
            
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$F{name}]]>
            </textFieldExpression>
         </textField>
         
         <textField>
            <reportElement x = "104" y = "20" width = "277" height = "20"/>
            
            <textElement>
               <font size = "12"/>
            </textElement>
            
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$F{country}]]>
            </textFieldExpression>
         </textField>
         
         <subreport>
            <reportElement positionType = "Float" x = "335" y = "25" width = "175"
               height = "20" isRemoveLineWhenBlank = "true" backcolor = "#99ccff"/>

            <dataSourceExpression>
               new net.sf.jasperreports.engine.data.JRBeanCollectionDataSource
                  ($F{subReportBeanList})
            </dataSourceExpression>
            
            <subreportExpression class = "java.lang.String">
               <![CDATA[$P{SUBREPORT_DIR} + "address_report_template.jasper"]]>
            </subreportExpression>
         </subreport>
         
         <line>
            <reportElement x = "0" y = "50" width = "550" height = "1"/>
         </line>
      
      </band>
   </detail>
   
   <columnFooter>
      <band height = "19" splitType = "Stretch"/>
   </columnFooter>
   
   <pageFooter>
      <band height = "18" splitType = "Stretch"/>
   </pageFooter>
   
   <summary>
      <band height = "14" splitType = "Stretch"/>
   </summary>

</jasperReport>

在上面的模板中，我們定義了一個新的引數“SUBREPORT_DIR”，它定義了子報表的路徑。我們定義了一個型別為 java.util.List 的欄位 subReportBeanList，它對應於 DataBean 檔案中的屬性。元素 <subreport> 具有子元素 <dataSourceExpression>。我們將列表 subReportBeanList 放入 JRBeanCollectionDataSource 的例項中。在子元素 <subreportExpression/> 中，我們給出了子報表名稱 (AddressReport.jasper)。

現在，讓我們編寫一個新類 CreateReport 來編譯和執行我們的報表模板。檔案 C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\CreateReport.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.JasperCompileManager;
import net.sf.jasperreports.engine.JasperFillManager;
import net.sf.jasperreports.engine.JasperReport;
import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource;

public class CreateReport {

   public static void main(String[] args) {
      String masterReportFileName = "C://tools/jasperreports-5.0.1/test"
         + "/jasper_report_template.jrxml";
      String subReportFileName = "C://tools/jasperreports-5.0.1/test"
         + "/AddressReport.jrxml";
      String destFileName = "C://tools/jasperreports-5.0.1/test"
         + "/jasper_report_template.JRprint";
			
      DataBeanList DataBeanList = new DataBeanList();
      ArrayList<DataBean> dataList = DataBeanList.getDataBeanList();
      JRBeanCollectionDataSource beanColDataSource = new 
         JRBeanCollectionDataSource(dataList);

      try {
         /* Compile the master and sub report */
         JasperReport jasperMasterReport = JasperCompileManager
            .compileReport(masterReportFileName);
         JasperReport jasperSubReport = JasperCompileManager
            .compileReport(subReportFileName);

         Map<String, Object> parameters = new HashMap<String, Object>();
         parameters.put("subreportParameter", jasperSubReport);
         JasperFillManager.fillReportToFile(jasperMasterReport, 
            destFileName, parameters, beanColDataSource);

      } catch (JRException e) {

         e.printStackTrace();
      }
      System.out.println("Done filling!!! ...");
   }
}

在這裡，我們看到我們正在編譯主報表和子報表模板，並將主報表 (.jasper) 檔案傳遞給報表填充。

報表生成

現在，我們所有的檔案都準備好了，讓我們使用我們常規的 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.CreateReport（viewFullReport 是預設目標）如下所示 -

Buildfile: C:\tools\jasperreports-5.0.1\test\build.xml

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

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 7 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.CreateReport
   [java] Compiling Report Design ...
   [java] log4j:WARN No appenders could be found for logger
   (net.sf.jasperreports.engine.xml.JRXmlDigesterFactory).
   [java] log4j:WARN Please initialize the log4j system properly.
   [java] Done filling!!! ...

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: 72 minutes 13 seconds

上述編譯的結果是彈出一個 JasperViewer 視窗，如下面的螢幕截圖所示 -

在這裡，我們可以看到 Name、Country 和 Address 屬性都顯示出來了。

列印頁面