レポートパラメータ

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

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

パラメータ宣言

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

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

名前属性

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

クラス属性

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

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

組み込みパラメータ

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

S.NO	パラメータ名と説明
1	REPORT_PARAMETERS_MAP すべてのユーザー定義および組み込みパラメーターを含むマップが含まれています。
2	REPORT_CONNECTION これは、JDBCデータソースに使用されるユーザー指定のクラスjava.sql.Connectionを指します。
3	REPORT_DATA_SOURCE これは、組み込みデータソースタイプの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\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;
   }
}

パラメータを追加しましょう<ReportTitle>および<Author>既存のレポートテンプレート（チャプターレポートデザイン）に。レポートのタイトルと作成者は、レポートの先頭に表示されます。改訂されたレポートテンプレート（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は、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がデフォルトのターゲットです）次のように-

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ウィンドウが開きます-

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