报表变量

报表变量是在报表表达式之上构建的特殊对象。

报表变量简化了以下任务：

报表表达式在整个报表模板中被大量使用。这些表达式可以通过使用报表变量只声明一次。
报表变量可以根据相应的表达式值执行各种计算，例如计数、求和、平均值、最小值、最大值、方差等。

如果在报表设计中定义了变量，则可以在表达式中通过新变量引用这些变量。因此，在报表设计中声明变量的顺序很重要。

变量声明

变量声明如下：

<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 https://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 窗口，如下面的屏幕所示：

在这里，我们看到每个记录都添加了前缀计数。

打印页面