Jasper-reports-jasper-report-expression
レポート表現
レポート式はJasperReportsの強力な機能であり、計算されたデータをレポートに表示できます。 計算データは、静的データではなく、レポートパラメーターまたはデータソースフィールドとして明確に渡されないデータです。 レポート式は、レポートパラメーター、フィールド、および静的データを組み合わせて構築されます。 Java言語は、デフォルトでレポート式を作成するために使用されます。 Groovyスクリプト言語、JavaScript、BeanShellスクリプトなど、レポート式用の他のスクリプト言語は、JasperReportsコンパイラーでサポートされています。
この章では、レポート式がJava言語のみを使用して記述されていることを前提に、レポート式がどのように機能するかを説明します。 JRXMLレポートテンプレートには、式を定義する要素がいくつかあります-
- <変数式>
- <initialValueExpression>
- <groupExpression>
- <printWhenExpression>
- <imageExpression>
- <textFieldExpression>
式の宣言
基本的に、すべてのレポート式はJava式であり、レポートフィールド、レポート変数、およびレポートパラメーターを参照できます。
式のフィールド参照
式でレポートフィールド参照を使用するには、以下に示すように、フィールドの名前を** $ F \ {* and } *文字シーケンスの間に配置する必要があります-
<textfieldexpression>
$F{Name}
</textfieldexpression>
以下は、既存のJRXMLファイルからのコードの一部です(チャプターリンク:/jasper_reports/jasper_report_designs [Report Designs)]-
<textFieldExpression class = "java.lang.String">
<![CDATA[$F{country}]]>
</textFieldExpression>
式の変数参照
式で変数を参照するには、以下の例に示すように、* $ V \ { and } *の間に変数の名前を入れる必要があります-
<textfieldexpression>
"Total height : " + $V{SumOfHeight} + " ft."
</textfieldexpression>
式のパラメーターリファレンス
式でパラメータを参照するには、以下の例に示すように、パラメータの名前を** $ P \ {* and } *の間に配置する必要があります-
<textfieldexpression>
"ReportTitle : " + $P{Title}
</textfieldexpression>
次に、既存のJRXMLファイルのコードを示します。これは、式内のパラメーターの参照を示しています。 (チャプターリンクからのJRXML:/jasper_reports/jasper_report_designs [レポートデザイン])-
<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>
上で見たように、パラメーター、フィールド、および変数の参照は実際には実際のJavaオブジェクトです。 レポートテンプレートで作成されたパラメーター、フィールド、または変数の宣言からクラスを知ると、式のオブジェクト参照でメソッドを呼び出すこともできます。
次の例は、java.lang.Stringレポートフィールド「Name」から最初の文字を抽出して表示する方法を示しています-
<textFieldExpression>
$F{Name}.substring(0, 1)
</textFieldExpression>
式のリソースバンドルリファレンス
式でリソースを参照するには、以下の例に示すように、_ $ _を** $ R \ {* and } *の間に配置する必要があります-
<textfieldexpression>
$R{report.title}
</textfieldexpression>
ランタイム提供のロケールと_report.title_キーに基づいて、レポートテンプレートに関連付けられたリソースバンドルがロードされます。 したがって、リソースバンドルから文字列値を抽出することにより、レポートのタイトルが表示されます。 国際化の詳細については、章のリンク:/jasper_reports/jasper_Internationalization [Internationalization]を参照してください。
電卓
計算機はJasperReportsのエンティティであり、レポート入力時に式を評価し、変数またはデータセットをインクリメントします。 コンパイルプロセス中に、コンパイラによって情報が生成され、コンパイルレポートに保存されます。 この情報は、レポート入力時にnet.sf.jasperreports.engine.fill.JRCalculatorクラスのインスタンスを構築するために使用されます。
Javaソースファイルは、Javaベースのレポートコンパイラによってオンザフライで生成およびコンパイルされます。 この生成されたクラスはJRCalculatorのサブクラスであり、それをコンパイルして生成されたバイトコードはJasperReportオブジェクト内に保存されます。 このbytcodeは、レポートの入力時にロードされ、結果のクラスがインスタンス化されて、式の評価に必要な計算機オブジェクトが取得されます。
条件式
JasperReportsは、変数式を定義するときにif-elseステートメントをサポートしません。 代わりに、三項演算子 \ {cond}を使用できますか? \ {ステートメント1}:\ {ステートメント2} 。 この演算子をJava式内にネストして、複数の条件に基づいて目的の出力を取得できます。
レポートの条件式の例
既存のレポートテンプレート(チャプターリンク:/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>
<sortField name = "country" order = "Descending"/>
<sortField name = "name"/>
<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}.isEmpty() ? "NO COUNTRY" : $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>
レポート入力の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;
}
}
Java Beanリストに、国フィールドが空の新しいレコードを追加します。 ファイル 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"));
dataBeanList.add(produce("Tanmay", ""));
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 build.sysclasspath=last;
set to false for repeatable builds
[javac] Compiling 3 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: 5 minutes 5 seconds
C:\tools\jasperreports-5.0.1\test>
上記のコンパイルの結果、JasperViewerウィンドウが開き、以下の画面に表示されます-
ここでは、最後のレコードについて、フィールドcountryのデータを渡さなかったことがわかります。「NO COUNTRY」が印刷されています。