Jasper-reports-jasper-report-parameters

提供：Dev Guides
移動先:案内、検索

レポートパラメータ

レポートを入力するための主な入力は、レポートテンプレート、パラメーター、およびデータソースです。 この章ではパラメータについて説明し、次の章ではデータソースについて説明します。

パラメータはオブジェクト参照であり、レポート入力操作中にレポートエンジンに渡されます。 データソースを介して渡すことができないデータは、パラメーターを使用して渡すことができます。 著者名、レポートのタイトルなどのデータ パラメータを介して渡すことができます。 JasperReportsテンプレートまたはJRXMLテンプレートには、0個以上のパラメーター要素を含めることができます。

パラメータ宣言

次のようなパラメータ宣言- 

<parameter name = "exampleParameter" class = "java.lang.String"/>

名前属性

<parameter>要素の_name_属性は必須です。 レポート式のパラメーターを名前で参照します。 パラメータ名は単一の単語である必要があります。 ドットやコンマなどの特殊文字を含めることはできません。

クラス属性

_class_属性も必須であり、パラメーター値のクラス名を指定します。 デフォルト値は_java.lang.String_です。 これは、実行時に使用可能な任意のクラスに変更できます。 レポートパラメーターのタイプに関係なく、エンジンは$ P \ {}トークンが使用されているレポート式のキャストを処理するため、手動キャストを行う必要はありません。

レポートパラメータ値は、常にパラメータ名をキーとして持つjava.util.Mapオブジェクトにパックされます。 データベースから取得したデータセットをさらにカスタマイズするために、レポートのクエリ文字列でレポートパラメーターを使用できます。 これらは、レポートのデータを提供するクエリの動的フィルターのように機能します。

組み込みパラメーター

以下は、式で使用する準備ができて、事前に定義されたレポートパラメータです-

S.NO Parameter Name and Description
1

REPORT_PARAMETERS_MAP

すべてのユーザー定義および組み込みパラメーターを含むマップが含まれています。

2

REPORT_CONNECTION

これは、JDBCデータソースに使用されるユーザー提供のクラスjava.sql.Connectionを指します。

3

REPORT_DATA_SOURCE

これは、組み込みのデータソースタイプの1つまたはユーザー定義の1つを表す、JRDataSourceのユーザー提供のインスタンスです。

4

REPORT_MAX_COUNT

これは_java.lang.Integer_値であり、ユーザーはデータソースからのレコードを制限できます。

5

REPORT_SCRIPTLET

これは_net.sf.jasperreports.engine.JRAbstractScriptlet_を指し、ユーザーが提供するレポートスクリプトレットのインスタンスが含まれます。

6

REPORT_LOCALE

これは、リソースバンドルの目的のロケールを含む_java.util.Locale_インスタンスです。

7

REPORT_RESOURCE_BUNDLE

これは_java.util.ResourceBundle_オブジェクトを指し、ローカライズされたメッセージが含まれます。

8

REPORT_TIME_ZONE

これは_java.util.TimeZone_インスタンスであり、日付のフォーマットに使用されます。

9

REPORT_VIRTUALIZER

これは_net.sf.jasperreports.engine.JRVirtualizer_オブジェクトのインスタンスであり、ページの仮想化に使用されます（メモリ消費を最適化します）。

10

REPORT_CLASS_LOADER

これは、画像、フォント、サブレポートテンプレートなどのリソースをロードするためのレポート入力プロセス中に使用される_java.lang.ClassLoader_インスタンスです

11

IS_IGNORE_PAGINATION

_java.lang.Boolean.TRUE_に設定すると、レポートは1つの長いページで生成され、改ページは発生しません。

例

_ReportTitle_と_Author_をレポート（JasperReportFill.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;
   }
}

<* ReportTitle >および< Author *>のパラメーターを既存のレポートテンプレートに追加しましょう（チャプターリンク：/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">

   <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>

   <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[$F{name}]]>
            </textFieldExpression>
         </textField>

      </band>
   </detail>

</jasperReport>

レポート生成

通常の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 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/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.

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レポートパラメーターの例

ここで、レポートの先頭にReportTitleの「連絡先のリスト」と作成者の「Manishaによって準備」が表示されていることがわかります。

「https://www.finddevguides.com/index.php?title=Jasper-reports-jasper-report-parameters&oldid=17850」から取得
Powered by MediaWiki