レポートスクリプトレット

前の章で見たように、レポートに表示されるデータは通常、レポートパラメータとレポートフィールドからフェッチされます。このデータは、レポート変数とその式を使用して処理できます。レポート式や変数を使用して複雑な機能を簡単に実現できない場合があります。この例としては、複雑な文字列操作、マップの作成、メモリ内のオブジェクトのリスト、サードパーティのJavaAPIを使用した日付の操作などがあります。このような状況では、JasperReportsはこれを行うためのシンプルで強力な手段を提供しますScriptlets。

スクリプトレットは、レポートイベントが発生するたびに実行されるJavaコードのシーケンスです。レポート変数の値は、スクリプトレットを介して影響を受ける可能性があります。

スクリプトレット宣言

スクリプトレットは2つの方法で宣言できます-

• <を使用するscriptlet>要素。この要素には、name属性とclass属性があります。クラス属性が延びている、クラスの名前を指定する必要がありJRAbstractScriptletのクラスを。クラスは、レポートの入力時にクラスパスで使用可能である必要があり、エンジンがオンザフライでインスタンス化できるように、空のコンストラクターが必要です。

• 属性の使用 scriptletClass 要素の<jasperReport>、レポートテンプレート（JRXML）内。この属性をスクリプトレットの完全修飾名（パッケージ名全体を含む）で設定することにより、スクリプトレットを使用することを示します。この属性で作成されたスクリプトレットインスタンスは、スクリプトレットのリストの最初のスクリプトレットのように機能し、事前定義された名前REPORTを持ちます。

スクリプトレットクラス

スクリプトレットはJavaクラスであり、次のクラスのいずれかを拡張する必要があります-

• net.sf.jasperreports.engine.JRAbstractScriptlet−このクラスには、すべての実装でオーバーライドする必要のあるいくつかの抽象メソッドが含まれています。これらのメソッドは、適切なタイミングでJasperReportsによって自動的に呼び出されます。開発者は、すべての抽象メソッドを実装する必要があります。

• net.sf.jasperreports.engine.JRDefaultScriptlet−このクラスには、JRAbstractScriptletのすべてのメソッドのデフォルトの空の実装が含まれています。開発者は、自分のプロジェクトに必要なメソッドを実装するだけで済みます。

次の表に、上記のクラスのメソッドを示します。これらのメソッドは、レポートの入力フェーズ中の適切なタイミングでレポートエンジンによって呼び出されます。

S.NO	方法と説明
1	public void beforeReportInit() レポートの初期化の前に呼び出されます。
2	public void afterReportInit() レポートの初期化後に呼び出されます。
3	public void beforePageInit() 各ページが初期化される前に呼び出されます。
4	public void afterPageInit() 各ページが初期化された後に呼び出されます。
5	public void beforeColumnInit() 各列が初期化される前に呼び出されます。
6	public void afterColumnInit() 各列が初期化された後に呼び出されます。
7	public void beforeGroupInit(String groupName) パラメータで指定されたグループが初期化される前に呼び出されます。
8	public void afterGroupInit(String groupName) パラメータで指定されたグループが初期化された後に呼び出されます。
9	public void beforeDetailEval() レポートの詳細セクションの各レコードが評価される前に呼び出されます。
10	public void afterDetailEval() レポートの詳細セクションの各レコードが評価された後に呼び出されます。

レポートごとに任意の数のスクリプトレットを指定できます。レポートにスクリプトレットが指定されていない場合でも、エンジンは単一のJRDefaultScriptletインスタンスを作成し、組み込みのREPORT_SCRIPTLETパラメーターに登録します。

スクリプトレットに必要なメソッドを追加できます。レポートは、組み込みパラメーターREPORT_SCRIPTLETを使用してこれらのメソッドを呼び出すことができます。

グローバルスクリプトレット

スクリプトレットを別の方法でレポートに関連付けることができます。つまり、スクリプトレットをグローバルに宣言します。これにより、スクリプトレットは、特定のJasperReportsデプロイメントで入力されるすべてのレポートに適用されます。これは、スクリプトレットを拡張機能としてJasperReportsに追加できるため簡単になります。スクリプトレット拡張ポイントは、net.sf.jasperreports.engine.scriptlets.ScriptletFactoryインターフェイスで表されます。JasperReportsは、実行時に拡張機能を介して利用可能なすべてのスクリプトレットファクトリをロードします。次に、実行中の現在のレポートに適用するスクリプトレットインスタンスのリストを各自に要求します。スクリプトレットインスタンスのリストを要求すると、エンジンは、ファクトリが現在のレポートに実際に適用するスクリプトレットを決定するために使用できるコンテキスト情報を提供します。

レポートガバナー

ガバナーは、レポートを生成しながら、実行時にレポートエンジンが無限ループに入るという問題に取り組むことを可能にするグローバルスクリプトレットの単なる拡張です。ほとんどの場合、無限ループに入る条件は実行時にエンジンに供給される実際のデータに依存するため、無効なレポートテンプレートは設計時に検出できません。レポートガバナーは、特定のレポートが無限ループに入ったかどうかを判断するのに役立ち、それを停止できます。これにより、レポートを実行するマシンのリソースが枯渇するのを防ぎます。

JasperReportsには、指定された最大ページ数または指定されたタイムアウト間隔に基づいてレポートの実行を停止する2つの単純なレポートガバナーがあります。彼らは-

• net.sf.jasperreports.governors.MaxPagesGovernor−これは、現在実行中のレポートに適用するかどうかを決定するために2つの構成プロパティを探しているグローバルスクリプトレットです。構成プロパティは次のとおりです。

  • net.sf.jasperreports.governor.max.pages.enabled=[true|false]

  • net.sf.jasperreports.governor.max.pages=[integer]

• net.sf.jasperreports.governors.TimeoutGovernor−これもグローバルスクリプトレットであり、適用するかどうかを決定するために次の2つの構成プロパティを探します。

  構成プロパティは次のとおりです。

  • net.sf.jasperreports.governor.timeout.enabled=[true|false]

  • net.sf.jasperreports.governor.timeout=[milliseconds]

両方のガバナーのプロパティは、グローバルに、jasperreports.propertiesファイルで、またはレポートレベルでカスタムレポートプロパティとして設定できます。これは、レポートごとに推定サイズまたはタイムアウト制限が異なる可能性があるため、また、すべてのレポートでガバナーをオンにし、一部のレポートではオフにする、またはその逆の場合があるため、便利です。

例

スクリプトレットクラスを書いてみましょう（MyScriptlet）。ファイルC：\ tools \ jasperreports-5.0.1 \ test \ src \ com \ tutorialspoint \ MyScriptlet.javaの内容は次のとおりです-

package com.tutorialspoint;

import net.sf.jasperreports.engine.JRDefaultScriptlet;
import net.sf.jasperreports.engine.JRScriptletException;


public class MyScriptlet extends JRDefaultScriptlet {

   public void afterReportInit() throws JRScriptletException{
      System.out.println("call afterReportInit()");
      // this.setVariableValue("AllCountries", sbuffer.toString());
      this.setVariableValue("someVar", new String("This variable value 
         was modified by the scriptlet."));
   }

   public String hello() throws JRScriptletException {
      return "Hello! I'm the report's scriptlet object.";
   }

}

上記のスクリプトレットクラスの詳細は次のとおりです。

• でafterReportInitの方法は、我々は変数に値を設定します"someVar" this.setVariableValue（ "someVar"、new String（ "この変数値はスクリプトレットによって変更されました。"））。

• クラスの最後に、呼び出される追加のメソッド 'hello'定義されています。これは、変数を設定するのではなく、実際に値を返すスクリプトレットに追加できるメソッドの例です。

次に、既存のレポートテンプレート（Chapter Report Designs）にスクリプトレットクラス参照を追加します。改訂されたレポートテンプレート（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"
   scriptletClass = "com.tutorialspoint.MyScriptlet">
	
   <style name = "alternateStyle" fontName = "Arial" forecolor = "red">
      
      <conditionalStyle>
         <conditionExpression>
            <![CDATA[new Boolean($V{countNumber}.intValue() % 2 == 0)]]>
         </conditionExpression>
			
         <style forecolor = "blue" isBold = "true"/>
      </conditionalStyle>
   </style>
   
   <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>

   <variable name = "someVar" class = "java.lang.String">
      <initialValueExpression>
        <![CDATA["This is the initial variable value."]]>
      </initialValueExpression>
   </variable>

   <title>
      <band height = "100">
         
         <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>
         
         <textField isBlankWhenNull = "true">
            <reportElement  x = "0" y = "50" width = "515" 
               height = "30" forecolor = "#993300"/>
             
            <textElement textAlignment = "Center">
               <font size = "10"/>
            </textElement>
            
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$V{someVar}]]>
            </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 style = "alternateStyle" 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[$F{name}]]>
            </textFieldExpression>
         </textField>
      
      </band>
   </detail>
   
   <summary>
      <band height = "45">
            
         <textField isStretchWithOverflow = "true">
            <reportElement x = "0" y = "10" width = "515" height = "15" />
            <textElement textAlignment = "Center"/>
               
            <textFieldExpression class = "java.lang.String">
               <![CDATA["There are " + String.valueOf($V{REPORT_COUNT}) +
                  " records on this report."]]>
            </textFieldExpression>
         </textField>
         
         <textField isStretchWithOverflow = "true">
            <reportElement positionType = "Float" x = "0" y = "30" width = "515"
               height = "15" forecolor = "# 993300" />
               
            <textElement textAlignment = "Center">
               <font size = "10"/>
            </textElement>
               
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$P{REPORT_SCRIPTLET}.hello()]]>
            </textFieldExpression>
            
         </textField>
         
      </band>
   </summary>
	
</jasperReport>

改訂されたレポートテンプレートの詳細を以下に示します-

• 私たちは、属性にMyScriptletクラスを参照したscriptletClass <jasperReport>要素の。

• スクリプトレットは、レポートフィールドとパラメータにアクセスすることはできますが、変更することはできません。ただし、スクリプトレットはレポート変数値を変更できます。これは、setVariableValue（）メソッドを呼び出すことで実現できます。このメソッドは、JRAbstractScriptletクラスで定義されています。このクラスは、常にスクリプトレットの親クラスです。ここでは、変数someVarを定義しました。これは、MyScriptletによって変更され、値がこの値になります。この値は、スクリプトレットによって変更されました。

• 上記のレポートテンプレートには、（スクリプトレットで）新しいメソッドを記述してレポートテンプレートで使用する方法を示すSummaryバンドのメソッド呼び出しがあります。（（$P{REPORT_SCRIPTLET}.hello()）

レポート入力の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 bu
   [javac] Compiling 4 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.
   [java] call afterReportInit()
   [java] call afterReportInit()

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 minutes 49 seconds

上記のコンパイルの結果、以下の画面に示すようにJasperViewerウィンドウが開きます-

ここでは、MyScriptletクラスから2つのメッセージが表示されています-

• タイトルセクション-この変数値はスクリプトレットによって変更されました
• 一番下-こんにちは！私はレポートのスクリプトレットオブジェクトです。