サブレポートを作成する

サブレポートは、JasperReportsの優れた機能の1つです。この機能により、レポートを別のレポートに組み込むことができます。つまり、あるレポートを別のレポートのサブレポートにすることができます。サブレポートは、多くの単純なレポートを作成してマスターレポートにカプセル化できるため、レポートの設計を単純に保つのに役立ちます。サブレポートは、通常のレポートと同じようにコンパイルおよび入力されます。(レポートテンプレートの)内部で何も変更せずに、別のレポートテンプレートに組み込むと、任意のレポートテンプレートをサブレポートとして使用できます。

サブレポートは、通常のレポートテンプレートに似ています。これらは実際にはnet.sf.jasperreports.engine.JasperReportオブジェクトであり、net.sf.jasperreports.engine.design.JasperDesignオブジェクトをコンパイルした後に取得されます

<サブレポート>要素

<subreport>要素は、サブレポートをマスターレポートに導入するときに使用されます。<subreport> JRXML要素のサブ要素のリストは次のとおりです。

  • <reportElement>

  • <parametersMapExpression>-これは、レポートパラメータを含むマップをサブレポートに渡すために使用されます。マップは通常、マスターレポートのパラメーターから取得するか、組み込みのREPORTS_PARAMETERS_MAPパラメーターを使用して親レポートのパラメーターをサブレポートに渡します。この式は常に、キーがパラメーター名であるjava.util.Mapオブジェクトを返す必要があります。

  • <subreportParameter>-この要素は、パラメーターをサブレポートに渡すために使用されます。必須の属性があります。

  • <connectionExpression>-これは、java.sql.Connectionをサブレポートに渡すために使用されます。これは、サブレポートテンプレートがレポートの入力フェーズでデータベース接続を必要とする場合にのみ使用されます。

  • <dataSourceExpression>-これは、データソースをサブレポートに渡すために使用されます。このデータソースは通常、マスターレポートのパラメーターから取得するか、組み込みのREPORT_DATA_SOURCEパラメーターを使用して親レポートのデータソースをサブレポートに渡します。

  • 要素(connectionExpressionとdataSourceExpression)を<subreport>要素宣言に同時に存在させることはできません。これは、データソースとサブレポートへの接続の両方を提供できないためです。私たちはそれらの1つを決定し、それに固執する必要があります。

  • <returnValue>-これは、サブレポートの変数の1つの値をマスターレポートの変数の1つに割り当てるために使用されます。このサブ要素には次のような属性があります-

    • subreportVariable-この属性は、値が返されるサブレポート変数の名前を指定します。

    • toVariable-この属性は、値がサブレポートの値でコピー/インクリメントされる親レポート変数の名前を指定します。

    • 計算-この属性は、Nothing、Count、DistinctCount、Sum、Average、Lowest、Highest、StandardDeviation、Varianceの値を取ることができます。属性計算のデフォルト値は「なし」です。

    • インクリメントファクトリクラス-この属性は、インクリメントインスタンスを作成するためのファクトリクラスを指定します。

  • <subreportExpression>-これは、サブレポート用にコンパイルされたレポートテンプレートの場所を示します。この要素にはclass属性。クラスjava.lang.Stringで、java.io.Fileの、のjava.net.URL、java.io.InputStreamを、net.sf.jasperreports.engine.JasperReport:属性は、これらの値のいずれかを取ることができます。デフォルト値はjava.lang.Stringです。

  • isUsingCache-これは<subreport>要素の属性です。これはブール値です。trueに設定すると、レポートエンジンは、指定されたソースを使用して、以前にロードされたサブレポートテンプレートオブジェクトを認識しようとします。このキャッシュ機能は、ファイル名、URL、またはクラスパスリソースを表すサブレポートテンプレートソースとしてjava.lang.Stringオブジェクトを返す式を持つサブレポート要素でのみ使用できます。

JRDataSourceを使用したサブレポートの作成を示す簡単な例を取り上げましょう。まず、2つの新しいレポートテンプレートを作成しましょう。1つはサブレポートで、もう1つはマスターレポートです。サブレポート(address_report_template.jrxml)テンプレートの内容は次のとおりです。C:\ tools \ jasperreports-5.0.1 \ testディレクトリに保存します。

<?xml version = "1.0" encoding = "UTF-8"?>
<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 = "address_report_template" pageWidth = "175" pageHeight = "842" 
   columnWidth = "175" leftMargin = "0" rightMargin = "0" 
   topMargin = "0" bottomMargin = "0">

   <field name = "city" class = "java.lang.String"/>
   <field name = "street" class = "java.lang.String"/>
   
   <background>
      <band splitType = "Stretch"/>
   </background>
   
   <title>
      <band height = "20" splitType = "Stretch">
         
         <staticText>
            <reportElement x = "0" y = "0" width = "100" height = "20"/>
            
            <textElement>
               <font size = "14" isBold = "true"/>
            </textElement>
				
            <text><![CDATA[Addresses]]></text>
         </staticText>
      
      </band>
   </title>
   
   <pageHeader>
      <band height = "12" splitType = "Stretch"/>
   </pageHeader>
   
   <columnHeader>
      <band height = "12" splitType = "Stretch"/>
   </columnHeader>
   
   <detail>
      <band height = "27" splitType = "Stretch">
         
         <textField>
            <reportElement x = "0" y = "0" width = "120" height = "20"/>
            
            <textElement>
               <font size = "12" isBold = "true"/>
            </textElement>
            
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$F{city}+" Address:"]]>
            </textFieldExpression>
         </textField>
         
         <textField isStretchWithOverflow = "true">
            <reportElement x = "120" y = "0" width = "435" height = "20"/>
            
            <textElement>
               <font size = "12"/>
            </textElement>
            
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$F{street}]]>
            </textFieldExpression>
         </textField>
      
      </band>
   </detail>
   
   <columnFooter>
      <band height = "8" splitType = "Stretch"/>
   </columnFooter>
  
   <pageFooter>
      <band height = "11" splitType = "Stretch"/>
   </pageFooter>
   
   <summary>
      <band height = "9" splitType = "Stretch"/>
   </summary>

</jasperReport>

データソースを使用するため、対応するPOJOファイルを作成する必要があります SubReportBean.java 以下に示すように。ディレクトリC:\ tools \ jasperreports-5.0.1 \ test \ src \ com \ tutorialspointに保存します-

package com.tutorialspoint;

public class SubReportBean {
   private String city;
   private String street;

   public String getCity() {
      return city;
   }

   public void setCity(String city) {
      this.city = city;
   }

   public String getStreet() {
      return street;
   }

   public void setStreet(String street) {
      this.street = street;
   }
}

ここでは、「city」「street」の2つのフィールドを宣言し、それぞれのgetterメソッドとsetterメソッドを定義しています。

それでは、既存のものを更新しましょう DataBeanファイル。java.util.Listである新しいフィールドsubReportBeanListを追加します。このフィールドには、SubReportBeanオブジェクトのリストが保持されます。DataBeanファイルの内容は以下のとおりです。ディレクトリC:\ tools \ jasperreports-5.0.1 \ test \ src \ com \ tutorialspointに保存します。

package com.tutorialspoint;

import java.util.List;

public class DataBean {
   private String name;
   private String country;
   private List<SubReportBean> subReportBeanList;

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

   public List<SubReportBean> getSubReportBeanList() {
      return subReportBeanList;
   }

   public void setSubReportBeanList(List<SubReportBean> subReportBeanList) {
      this.subReportBeanList = subReportBeanList;
   }
}

ファイルC:\ tools \ jasperreports-5.0.1 \ test \ src \ com \ tutorialspoint \を更新しましょう。DataBeanList.java。このファイルの内容は次のとおりです。

package com.tutorialspoint;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

public class DataBeanList {
   public ArrayList<DataBean> getDataBeanList() {

      // Create sub report data
      SubReportBean subBean1 = new SubReportBean();
      subBean1.setCity("Mumbai");
      subBean1.setStreet("M.G.Road");
      SubReportBean subBean2 = new SubReportBean();
      subBean2.setCity("New York");
      subBean2.setStreet("Park Street");
      SubReportBean subBean3 = new SubReportBean();
      subBean3.setCity("San Fransisco");
      subBean3.setStreet("King Street");

      ArrayList<DataBean> dataBeanList = new ArrayList<DataBean>();

      // Create master report data
      dataBeanList.add(produce("Manisha", "India",
         Arrays.asList(subBean1)));
      dataBeanList.add(produce("Dennis Ritchie", "USA",
         Arrays.asList(subBean2)));
      dataBeanList.add(produce("V.Anand", "India",
         Arrays.asList(subBean1)));
      dataBeanList.add(produce("Shrinath", "California",
         Arrays.asList(subBean3)));

      return dataBeanList;
   }

   /*
    * This method returns a DataBean object,
    * with name, country and sub report
    * bean data set in it.
    */
   private DataBean produce(String name, String country,
      List<SubReportBean> subBean) {
      DataBean dataBean = new DataBean();

      dataBean.setName(name);
      dataBean.setCountry(country);
      dataBean.setSubReportBeanList(subBean);

      return dataBean;
   }
}

上記のファイルのメソッドproduce()で、SubReportBeanのリストを設定しています。

それでは、新しいマスターレポートテンプレート(jasper_report_template.jrxml)を作成しましょう。このファイルをディレクトリに保存しますC:\tools\jasperreports-5.0.1\test。このファイルの内容は以下のとおりです。

<?xml version = "1.0" encoding = "UTF-8"?>
<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" language = "groovy" pageWidth = "595"
   pageHeight = "842" columnWidth ="555" leftMargin = "20" rightMargin = "20"
   topMargin = "20" bottomMargin = "20">

   <parameter name = "SUBREPORT_DIR" class = "java.lang.String" isForPrompting = "false">
      <defaultValueExpression>
         <![CDATA["C:\\tools\\jasperreports-5.0.1\\test\\"]]>
      </defaultValueExpression>
   </parameter>
   
   <field name = "country" class = "java.lang.String"/>
   <field name = "name" class = "java.lang.String"/>
   <field name = "subReportBeanList" class = "java.util.List"/>
   
   <background>
      <band splitType = "Stretch"/>
   </background>
   
   <title>
      <band height = "35" splitType = "Stretch">
         
         <staticText>
            <reportElement x = "0" y = "0" width = "204" height = "34"/>
            
            <textElement>
               <font size = "26" isBold = "true"/>
            </textElement>
				
            <text><![CDATA[Contact Report]]></text>
         </staticText>
      
      </band>
   </title>
   
   <pageHeader>
      <band height = "17" splitType = "Stretch"/>
   </pageHeader>
   
   <columnHeader>
      <band height = "21" splitType = "Stretch"/>
   </columnHeader>
   
   <detail>
      <band height = "112" splitType = "Stretch">
            
         <staticText>
            <reportElement x = "0" y = "0" width = "100" height = "20"/>
            
            <textElement>
               <font size = "12" isBold = "true"/>
            </textElement>
				
            <text><![CDATA[Name:]]></text>
         </staticText>
         
         <staticText>
            <reportElement x = "0" y = "20" width = "100" height = "20"/>
            
            <textElement>
               <font size = "12" isBold = "true"/>
            </textElement>
				
            <text><![CDATA[Country:]]></text>
         </staticText>
         
         <textField>
            <reportElement x = "104" y = "0" width = "277" height = "20"/>
            
            <textElement>
               <font size = "12"/>
            </textElement>
            
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$F{name}]]>
            </textFieldExpression>
         </textField>
         
         <textField>
            <reportElement x = "104" y = "20" width = "277" height = "20"/>
            
            <textElement>
               <font size = "12"/>
            </textElement>
            
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$F{country}]]>
            </textFieldExpression>
         </textField>
         
         <subreport>
            <reportElement positionType = "Float" x = "335" y = "25" width = "175"
               height = "20" isRemoveLineWhenBlank = "true" backcolor = "#99ccff"/>

            <dataSourceExpression>
               new net.sf.jasperreports.engine.data.JRBeanCollectionDataSource
                  ($F{subReportBeanList})
            </dataSourceExpression>
            
            <subreportExpression class = "java.lang.String">
               <![CDATA[$P{SUBREPORT_DIR} + "address_report_template.jasper"]]>
            </subreportExpression>
         </subreport>
         
         <line>
            <reportElement x = "0" y = "50" width = "550" height = "1"/>
         </line>
      
      </band>
   </detail>
   
   <columnFooter>
      <band height = "19" splitType = "Stretch"/>
   </columnFooter>
   
   <pageFooter>
      <band height = "18" splitType = "Stretch"/>
   </pageFooter>
   
   <summary>
      <band height = "14" splitType = "Stretch"/>
   </summary>

</jasperReport>

上記のテンプレートでは、サブレポートのパスを定義する新しいパラメータ「SUBREPORT_DIR」を定義しました。DataBeanファイルのプロパティに対応するjava.util.ListタイプのフィールドsubReportBeanListを定義しました。要素<subreport>には、サブ要素<dataSourceExpression>があります。リストsubReportBeanListをJRBeanCollectionDataSourceのインスタンスに配置しました。サブ要素<subreportExpression />で、サブレポート名(AddressReport.jasper)を指定しました。

それでは、新しいクラスを書いてみましょう CreateReportレポートテンプレートをコンパイルして実行します。ファイルの内容C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\CreateReport.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.JasperCompileManager;
import net.sf.jasperreports.engine.JasperFillManager;
import net.sf.jasperreports.engine.JasperReport;
import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource;

public class CreateReport {

   public static void main(String[] args) {
      String masterReportFileName = "C://tools/jasperreports-5.0.1/test"
         + "/jasper_report_template.jrxml";
      String subReportFileName = "C://tools/jasperreports-5.0.1/test"
         + "/AddressReport.jrxml";
      String destFileName = "C://tools/jasperreports-5.0.1/test"
         + "/jasper_report_template.JRprint";
			
      DataBeanList DataBeanList = new DataBeanList();
      ArrayList<DataBean> dataList = DataBeanList.getDataBeanList();
      JRBeanCollectionDataSource beanColDataSource = new 
         JRBeanCollectionDataSource(dataList);

      try {
         /* Compile the master and sub report */
         JasperReport jasperMasterReport = JasperCompileManager
            .compileReport(masterReportFileName);
         JasperReport jasperSubReport = JasperCompileManager
            .compileReport(subReportFileName);

         Map<String, Object> parameters = new HashMap<String, Object>();
         parameters.put("subreportParameter", jasperSubReport);
         JasperFillManager.fillReportToFile(jasperMasterReport, 
            destFileName, parameters, beanColDataSource);

      } catch (JRException e) {

         e.printStackTrace();
      }
      System.out.println("Done filling!!! ...");
   }
}

ここでは、マスターレポートテンプレートとサブレポートテンプレートの両方をコンパイルし、レポート入力用にマスターレポート(.jasper)ファイルを渡していることがわかります。

レポートの生成

これですべてのファイルの準備ができました。通常の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.CreateReport (viewFullReportがデフォルトのターゲットです)次のように-

Buildfile: C:\tools\jasperreports-5.0.1\test\build.xml

clean-sample:
   [delete] Deleting directory C:\tools\jasperreports-5.0.1\test\classes

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
   [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.CreateReport
   [java] Compiling Report Design ...
   [java] log4j:WARN No appenders could be found for logger
   (net.sf.jasperreports.engine.xml.JRXmlDigesterFactory).
   [java] log4j:WARN Please initialize the log4j system properly.
   [java] Done filling!!! ...

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: 72 minutes 13 seconds

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

ここでは、属性Name、Country、およびAddressが表示されていることがわかります。