報表變數

報表變數是在報表表示式之上構建的特殊物件。

報表變數簡化了以下任務：

報表表示式在整個報表模板中被大量使用。這些表示式可以透過使用報表變數只宣告一次。
報表變數可以根據相應的表示式值執行各種計算，例如計數、求和、平均值、最小值、最大值、方差等。

如果在報表設計中定義了變數，則可以在表示式中透過新變數引用這些變數。因此，在報表設計中宣告變數的順序很重要。

變數宣告

變數宣告如下：

<variable name = "CityNumber" class = "java.lang.Integer" incrementType = "Group"
   incrementGroup = "CityGroup" calculation = "Count">
   <variableExpression>
      <![CDATA[Boolean.TRUE]]>
   </variableExpression>
</variable>

如上所示，<variable> 元素包含多個屬性。這些屬性總結如下：

名稱屬性

與引數和欄位類似，</variable> 元素的name 屬性是必須的。它允許在報表表示式中透過其宣告的名稱引用變數。

類屬性

class 屬性也是必須的，它指定變數值的類名。其預設值為java.lang.String。這可以更改為類路徑中可用的任何類，在報表編譯時和報表填充時都可以。引擎負責報表表示式中的型別轉換，其中使用 $V{} 令牌，因此不需要手動型別轉換。

計算

此屬性確定 - 填充報表時對變數執行什麼計算。以下小節描述了 <variable> 元素的 calculation 屬性的所有可能值。

Average - 變數值是每個非空變量表達式的平均值。僅適用於數字變數。
Count - 變數值是非空變量表達式例項的計數。
First - 變數值是變量表達式的第一個例項的值。後續值將被忽略。
Highest - 變數值是變量表達式的最高值。
Lowest - 變數值是報表中變量表達式的最低值。
Nothing - 對變數不執行任何計算。
StandardDeviation - 變數值是與報表表示式匹配的所有非空值的標準差。僅適用於數字變數。
Sum - 變數值是報表表示式返回的所有非空值的總和。
System - 變數值是自定義計算（使用 JasperReports 的指令碼功能自己計算該變數的值）。
Variance - 變數值是報表變量表達式求值返回的所有非空值的方差。

Incrementer FactoryClass

此屬性確定在填充報表上的當前記錄時用於計算變數值的類。預設值將是實現net.sf.jasperreports.engine.fill.JRIncrementerFactory的任何類。工廠類將由引擎在執行時根據為變數設定的calculation 屬性來例項化遞增器物件。

IncrementType

這決定了何時重新計算變數的值。此屬性使用以下值：

Column - 在每一列結束時重新計算變數值。
Group - 當由 incrementGroup 指定的分組更改時重新計算變數值。
None - 使用每條記錄重新計算變數值。
Page - 在每一頁結束時重新計算變數值。
Report - 重新計算變數值一次，在報表結束時。

IncrementGroup

當incrementType 為Group 時，這確定重新計算變數值的組的名稱。這需要 JRXML 報表模板中宣告的任何組的名稱。

ResetType

這決定了何時重置變數的值。此屬性使用以下值：

Column - 在每一列開始時重置變數值。
Group - 當由 incrementGroup 指定的分組更改時重置變數值。
None - 從不重置變數值。
Page - 在每一頁開始時重置變數值。
Report - 僅重置變數值一次，在報表開始時。

ResetGroup

當resetType 為Group 時，這確定重置變數值的組的名稱。此屬性的值將是 JRXML 報表模板中宣告的任何組的名稱。

內建報表變數

有一些內建系統變數，可以在表示式中使用，如下所示：

序號	變數名稱和描述
1	PAGE_NUMBER 此變數的值是其當前頁碼。它可以用來顯示當前頁碼和總頁碼，使用 JasperReports 文字欄位元素的一個特殊功能，即evaluationTime 屬性。
2	COLUMN_NUMBER 此變數包含當前列號。
3	REPORT_COUNT 此報表變數包含已處理的記錄總數。
4	PAGE_COUNT 此變數包含生成當前頁時已處理的記錄數。
5	COLUMN_COUNT 此變數包含生成當前列時已處理的記錄數。
6	GroupName_COUNT 此變數的名稱來源於它對應的組的名稱，字尾為 _COUNT 序列。此變數包含當前組中的記錄數。

示例

讓我們向現有的報表模板（第報表設計章）新增一個變數 (countNumber)。我們將為每個記錄新增字首計數。修改後的報表模板 (jasper_report_template.jrxml) 如下所示。將其儲存到 C:\tools\jasperreports-5.0.1\test 目錄：

<?xml version = "1.0"?>
<!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" pageWidth = "595"
   pageHeight = "842" columnWidth = "515"
   leftMargin = "40" rightMargin = "40" topMargin = "50" bottomMargin = "50">
	
   <parameter name = "ReportTitle" class = "java.lang.String"/>
   <parameter name = "Author" class = "java.lang.String"/>

   <queryString>
      <![CDATA[]]>
   </queryString>

   <field name = "country" class = "java.lang.String">
      <fieldDescription>
         <![CDATA[country]]>
      </fieldDescription>
   </field>

   <field name = "name" class = "java.lang.String">
      <fieldDescription>
         <![CDATA[name]]>
      </fieldDescription>
   </field>
   
   <variable name = "countNumber" class = "java.lang.Integer" calculation = "Count">
      <variableExpression>
         <![CDATA[Boolean.TRUE]]>
      </variableExpression>
   </variable>
   
   <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>

   <columnHeader>
      <band height = "23">
         
         <staticText>
            <reportElement mode = "Opaque" x = "0" y = "3" width = "535"	height = "15"
               backcolor = "#70A9A9" />
            
            <box>
               <bottomPen lineWidth = "1.0" lineColor = "#CCCCCC" />
            </box>
            
            <textElement />
				
            <text>
               <![CDATA[]]>
            </text>
         </staticText>
         
         <staticText>
            <reportElement x = "414" y = "3" width = "121" height = "15" />
            
            <textElement textAlignment = "Center" verticalAlignment = "Middle">
               <font isBold = "true" />
            </textElement>
            
            <text><![CDATA[Country]]></text>
         </staticText>
         
         <staticText>
            <reportElement x = "0" y = "3" width = "136" height = "15" />
            
            <textElement textAlignment = "Center" verticalAlignment = "Middle">
               <font isBold = "true" />
            </textElement>
            
            <text><![CDATA[Name]]></text>
         </staticText>
      
      </band>
   </columnHeader>

   <detail>
      <band height = "16">
         
         <staticText>
            <reportElement mode = "Opaque" x = "0" y = "0" width = "535" height = "14"
               backcolor = "#E5ECF9" />
            
            <box>
               <bottomPen lineWidth = "0.25" lineColor = "#CCCCCC" />
            </box>
				
            <textElement />
				
            <text>
               <![CDATA[]]>
            </text>
         </staticText>
         
         <textField>
            <reportElement x = "414" y = "0" width = "121" height = "15" />
            
            <textElement textAlignment = "Center" verticalAlignment = "Middle">
               <font size = "9" />
            </textElement>
            
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$F{country}]]>
            </textFieldExpression>
         </textField>
         
         <textField>
            <reportElement x = "0" y = "0" width = "136" height = "15" />
            <textElement textAlignment = "Center" verticalAlignment = "Middle" />
            
            <textFieldExpression class = "java.lang.String">
               <![CDATA["  " + String.valueOf($V{countNumber}) +"."+$F{name}]]>
            </textFieldExpression>
         </textField>
      
      </band>
   </detail>

</jasperReport>

報表填充的 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
   [delete] Deleting: C:\tools\jasperreports-5.0.1\test\jasper_report_template.jrprint

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 build.sysclasspath=last;
   set to false for repeatable builds
   [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.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: 18 seconds

上述編譯的結果是開啟一個 JasperViewer 視窗，如下面的螢幕所示：

在這裡，我們看到每個記錄都添加了字首計數。

列印頁面