JasperReports報表變數


報表變數是建立在報表表示式之上的特殊物件。報表變數簡化以下任務:

  • 報表,其中大量使用在整個報告模板表示式。這些表示式可以通過使用報表變數只能宣告一次。

  • 計數,求和,平均,最低,最高,方差等:報表變數可以基於像對應的表示式的值執行各種計算

如果變數是在報表設計定義,那麼這些可以通過在表示式中的新變數參照。因此,在該變數是在報表設計中宣告的順序是非常重要的。

變數宣告

變數宣告如下:

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

如上面所看到的,<variable>元素包含屬性的數量。這些屬性總結如下:

name屬性

類似的引數和欄位,</variable>元素的name屬性是強制性的。它允許參照由它的宣告的名稱在報表表示式中的變數。

class屬性

class屬性也是強制性的,它指定了變數值的類名。它的預設值是java.lang.String。這是可以改變的,在classpath可用的任何類無論是在報表編譯時間和報告充填時間。無論報告值的型別,引擎採用該$V {}標記是用來報告表達,從而不必要手動投射。

計算方法

這個屬性決定的變數填充報表時要執行什麼計算。下面的小節描述所有的<variable>元素的計算屬性的可能值。

  • Average: 變數的值是變數表示式的每一個非空值的平均值。有效期僅為數值變數。

  • Count: 該變數的值是變數表示式非空範例的數量。

  • First: 變數的值是變數表示式的第一個範例的值。隨後的值將被忽略。

  • Highest: 變數的值是變數表示式的最高值。

  • Lowest: 該變數的值是變數表示式在報表中的最低值。

  • Nothing: 不進行計算的變數。

  • StandardDeviation: 該變數的值是所有非空值匹配報表表示式的標準偏差。有效期僅為數值變數。

  • Sum: 該變數的值是由報表表示式返回所有非空值的總和。

  • System: 該變數的值是一個自定義計算(計算該變數自己的值,使用JasperReports小指令碼功能)

  • Variance: 該變數的值是一個報表變數的表示式求值返回的所有非空值的方差。

增量FACTORYCLASS

此屬性確定填充報表上的當前記錄時,用於計算變數的值的類。預設值是任何類實現net.sf.jasperreports.engine.fill.JRIncrementerFactory。工廠類將被用於由發動機來範例化物件的增量在執行時根據該變數中設定的計算屬性。

INCREMENTTYPE

這個決定何時重新計算變數的值。此屬性使用的值,如下:

  • Column: 該變數的值重新計算各列的結尾

  • Group: 當指定incrementGroup改變該組的變數值重新計算。

  • None: 該變數的值重新計算每個記錄。

  • Page: 該變數的值被重新計算在每一頁的末尾。

  • Report: 該變數的值被重新計算一次,在報表的末尾。

INCREMENTGROUP

這決定了該變數的值被重新計算,當incrementType是組的名稱。這需要在JRXML報表模板中宣告的任何組的名稱。

RESETTYPE

這決定了當一個變數的值被復位。此屬性使用的值,如下:

  • Column: 該變數的值複位在每一列的開頭。

  • Group: 該變數的值是當指定incrementGroup修改組復位。

  • None: 該變數的值不會被重置。

  • Page: 該變數的值複位在每一頁的開頭。

  • Report: 該變數的值復位只有一次,在報表的開頭。

RESETGROUP

這決定了該變數的值復位,當resetType是組的名稱。該屬性的值是在JRXML報表模板中宣告的任何組的名稱。

內建報表變數

有一些內建的系統變數,準備在表示式中使用,如下所示:

Variable Name 描述
PAGE_NUMBER 這個變數的值是它的當前頁碼。它可以被用來同時顯示當前頁面的數量和使用JasperReports文字欄位的元素,evaluationTime屬性的一種特殊的功能的總頁數。
COLUMN_NUMBER 這個變數包含了當前的列號
REPORT_COUNT 此報表變數包含的處理記錄的總數。
PAGE_COUNT 這個變數包含了生成當前頁面時所處理的記錄數。
COLUMN_COUNT 這個變數包含了生成當前列時所處理的記錄數。
GroupName_COUNT 這個變數的名稱是從它所對應的組,字尾為_COUNT序列的名稱派生的。這個變數包含的記錄在當前組的數量。

例子

讓一個變數(countNumber)加入到現有的報表模板(第報表設計)。我們將字首數到每個記錄。修訂後的報告模板(jasper_report_template.jrxml)如下。將其儲存到C: oolsjasperreports-5.0.1 est 目錄:

<?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: oolsjasperreports-5.0.1 estsrccomyiibaiJasperReportFill.java內容如下:

package com.yiibai;

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: oolsjasperreports-5.0.1 estsrccomyiibaiDataBean.java的內容如下:

package com.yiibai;

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: oolsjasperreports-5.0.1 estsrccomyiibaiDataBeanList.java 的內容如下:

package com.yiibai;

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: oolsjasperreports-5.0.1 est)如下。 

<?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.yiibai.JasperReportFill (viewFullReport預設的目標),如下所示:

C:	oolsjasperreports-5.0.1	est>ant -Dmain-class=com.yiibai.JasperReportFill
Buildfile: C:	oolsjasperreports-5.0.1	estuild.xml

clean-sample:
   [delete] Deleting directory C:	oolsjasperreports-5.0.1	estclasses
   [delete] Deleting: C:	oolsjasperreports-5.0.1	estjasper_report_template.jasper
   [delete] Deleting: C:	oolsjasperreports-5.0.1	estjasper_report_template.jrprint

compile:
    [mkdir] Created dir: C:	oolsjasperreports-5.0.1	estclasses
    [javac] C:	oolsjasperreports-5.0.1	estaseBuild.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:	oolsjasperreports-5.0.1	estclasses

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.htmll#noconfig
      for more info.
      [jrc] File : C:	oolsjasperreports-5.0.1	estjasper_report_template.jrxml ... OK.

run:
     [echo] Runnin class : com.yiibai.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視窗開啟如下面的螢幕:

Jasper Report Viewer

在這裡,我們看到,計數字首為每個記錄。