レポート変数

レポート変数は、レポート式の上に構築された特別なオブジェクトです。

レポート変数は、次のタスクを簡素化します-

• レポートテンプレート全体で頻繁に使用されるレポート式。これらの式は、レポート変数を使用して1回だけ宣言できます。

• レポート変数は、カウント、合計、平均、最低、最高、分散などの対応する式の値に基づいてさまざまな計算を実行できます。

変数がレポートデザインで定義されている場合、これらは式の新しい変数によって参照できます。したがって、レポートデザインで変数が宣言される順序は重要です。

変数宣言

変数宣言は次のとおりです-

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

上記のように、<variable>要素にはいくつかの属性が含まれています。これらの属性を以下に要約します-

名前属性

同様にパラメータやフィールド、名前</ variable>要素の属性は必須です。これにより、レポート式で宣言された名前で変数を参照できます。

クラス属性

クラス属性は、変数値のクラス名を指定することも必須です。デフォルト値はjava.lang.Stringです。これは、レポートのコンパイル時とレポートの入力時の両方で、クラスパスで使用可能な任意のクラスに変更できます。エンジンは、$ V {}トークンが使用されるレポート式の型キャストを処理するため、手動で型キャストする必要はありません。

計算

この属性は、レポートに入力するときに変数に対して実行する計算を決定します。次のサブセクションでは、<variable>要素の計算属性に使用できるすべての値について説明します。

• 平均-変数値は、変数式のnull以外のすべての値の平均です。数値変数にのみ有効です。

• カウント-変数値は、変数式のnull以外のインスタンスのカウントです。

• First-変数値は、変数式の最初のインスタンスの値です。後続の値は無視されます。

• 最高-変数値は、変数式の最高値です。

• 最小-変数値は、レポート内の変数式の最小値です。

• なし-変数に対して計算は実行されません。

• StandardDeviation-変数値は、レポート式に一致するすべてのnull以外の値の標準偏差です。数値変数にのみ有効です。

• Sum-変数値は、レポート式によって返されるすべてのnull以外の値の合計です。

• システム-変数値はカスタム計算です（JasperReportsのスクリプトレット機能を使用して、その変数の値を自分で計算します）。

• 分散-変数値は、レポート変数の式の評価によって返されるすべてのnull以外の値の分散です。

インクリメンターFactoryClass

この属性は、レポートの現在のレコードに入力するときに変数の値を計算するために使用されるクラスを決定します。デフォルト値は、実装する任意のクラスになりますnet.sf.jasperreports.engine.fill.JRIncrementerFactory。ファクトリクラスは、変数に設定された計算属性に応じて、実行時にインクリメントオブジェクトをインスタンス化するためにエンジンによって使用されます。

IncrementType

これにより、変数の値をいつ再計算するかが決まります。この属性は、以下のような値を使用します-

• 列-変数値は、各列の最後で再計算されます。

• グループ-incrementGroupで指定されたグループが変更されると、変数値が再計算されます。

• なし-変数値はすべてのレコードで再計算されます。

• ページ-変数値は、すべてのページの終わりに再計算されます。

• レポート-変数値は、レポートの最後に1回再計算されます。

IncrementGroup

これにより、incrementTypeがGroupの場合に、変数値が再計算されるグループの名前が決まります。これは、JRXMLレポートテンプレートで宣言されたグループの名前を取ります。

ResetType

これにより、変数の値がいつリセットされるかが決まります。この属性は、以下のような値を使用します-

• 列-変数値は、各列の先頭でリセットされます。

• グループ-incrementGroupで指定されたグループが変更されると、変数値がリセットされます。

• なし-変数値がリセットされることはありません。

• ページ-変数値は、すべてのページの先頭でリセットされます。

• レポート-変数値は、レポートの開始時に1回だけリセットされます。

ResetGroup

これにより、resetTypeがGroupの場合に、変数値がリセットされるグループの名前が決まります。この属性の値は、JRXMLレポートテンプレートで宣言されたグループの名前になります。

組み込みのレポート変数

次のように、式ですぐに使用できる組み込みのシステム変数がいくつかあります。

S.NO	変数の名前と説明
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は、Environment Setupの章から選択され、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がデフォルトのターゲットです）as −

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ウィンドウが次の画面のように開きます-

ここでは、レコードごとにカウントの前に付けられていることがわかります。