Jasper-reports-jasper-report-scriptlets

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

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

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

スクリプトレット宣言

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

• <* scriptlet *>要素を使用します。 この要素には、_name_属性と_class_属性があります。 _class_属性は、_JRAbstractScriptlet_クラスを拡張するクラスの名前を指定する必要があります。 このクラスは、レポートの入力時にクラスパスで使用可能でなければならず、空のコンストラクターが必要です。これにより、エンジンがその場でインスタンス化できます。
• レポートテンプレート（JRXML）で、要素<* jasperReport >の属性 *scriptletClass を使用します。 スクリプトレットの完全修飾名（パッケージ名全体を含む）でこの属性を設定することにより、スクリプトレットを使用することを示します。 この属性で作成されたスクリプトレットインスタンスは、スクリプトレットのリストの最初のスクリプトレットのように機能し、 定義済みの名前REPORT。

スクリプトレットクラス

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

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

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

S.NO	Method and Description
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 = [整数]
• * net.sf.jasperreports.governors.TimeoutGovernor *-これは、次の2つの構成プロパティを探して適用するかどうかを決定するグローバルスクリプトレットでもあります。 +構成プロパティは-
• net.sf.jasperreports.governor.timeout.enabled = [true | false]
• net.sf.jasperreports.governor.timeout = [ミリ秒]

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

例

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

package com.finddevguides;

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' という追加のメソッドが定義されています。 これは、変数を設定するのではなく、実際に値を返すスクリプトレットに追加できるメソッドの例です。

次に、既存のレポートテンプレートにスクリプトレットクラスの参照を追加します（チャプターリンク：/jasper_reports/jasper_report_designs [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.finddevguides.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>

改訂されたレポートテンプレートの詳細は以下のとおりです-

• <jasperReport>要素の_scriptletClass_属性でMyScriptletクラスを参照しました。
• スクリプトレットはレポートフィールドとパラメータにのみアクセスできますが、変更はできません。 ただし、スクリプトレットはレポート変数値を変更できます。 これは、setVariableValue（）メソッドを呼び出すことで実現できます。 このメソッドは、常にスクリプトレットの親クラスであるJRAbstractScriptletクラスで定義されます。 ここでは、変数_someVar_を定義しました。この変数は、MyScriptletによって_This value was by scriptlet_の値に変更されます。
• 上記のレポートテンプレートには、（スクリプトレットで）新しいメソッドを記述し、それらをレポートテンプレートで使用する方法を示すメソッドコールが[概要]バンドにあります。 （* $ P \ {REPORT_SCRIPTLET} .hello（）*）

レポート入力のJavaコードは変更されていません。 ファイル C：\ tools \ jasperreports-5.0.1 \ test \ src \ com \ finddevguides \ JasperReportFill.java の内容は以下のとおりです-

package com.finddevguides;

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 \ finddevguides \ DataBean.java の内容は以下のとおりです-

package com.finddevguides;

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 \ finddevguides \ DataBeanList.java* ファイルの内容は以下のとおりです-

package com.finddevguides;

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は、チャプターリンク：/jasper_reports/jasper_environment_setup [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.finddevguides.JasperReportFill （viewFullReportがデフォルトのターゲットです）を-として実行します

C:\tools\jasperreports-5.0.1\test>ant -Dmain-class=com.finddevguides.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/faql#noconfig for more info.
   [jrc] File : C:\tools\jasperreports-5.0.1\test\jasper_report_template.jrxml ... OK.

run:
   [echo] Runnin class : com.finddevguides.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ウィンドウが開き、以下の画面に表示されます-

Jasperレポートスクリプレットの例

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

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