Jasper-reports-jasper-report-fields

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

レポートフィールド

レポートフィールドは、データソースとレポートテンプレート間のデータのマッピングを表す要素です。 レポート式でフィールドを組み合わせて、目的の出力を取得できます。 レポートテンプレートには、0個以上の<field>要素を含めることができます。 レポートフィールドを宣言するとき、データソースはレポートテンプレートで定義されたすべてのフィールドに対応するデータを提供する必要があります。

フィールド宣言

フィールド宣言は以下に示すように行われます- 

<field name = "FieldName" class = "java.lang.String"/>

名前属性

<field>要素の_name_属性は必須です。 レポート式のフィールドを名前で参照します。

クラス属性

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

フィールドの説明

<fieldDesciption>要素はオプションの要素です。 これは、カスタムデータソースを実装するときに非常に便利です。 たとえば、実行時にカスタムデータソースからフィールドの値を取得できるキーまたは情報を保存できます。 フィールド名の代わりに<fieldDesciption>要素を使用することにより、データソースからフィールド値を取得するときに、フィールドの命名規則の制限を簡単に克服できます。

以下は、既存のJRXMLファイルからのコードの一部です（チャプターリンク：/jasper_reports/jasper_report_designs [Report Designs]）。 ここでは、 _ name ' 、 ' class_ 、および fieldDescription 要素の使用法を確認できます。 

<field name = "country" class = "java.lang.String">
   <fieldDescription><![CDATA[country]]></fieldDescription>
</field>

<field name = "name" class = "java.lang.String">
   <fieldDescription><![CDATA[name]]></fieldDescription>
</field>

フィールドを並べ替える

データの並べ替えが必要で、データソースの実装がそれをサポートしていないとき（例： CSVデータソース）、JasperReportsは、メモリ内のフィールドベースのデータソースソートをサポートしています。 並べ替えは、レポートテンプレートの1つ以上の<sortField>要素を使用して実行できます。

少なくとも1つの並べ替えフィールドが指定されている場合、レポート入力プロセス中に、データソースが_JRSortableDataSource_インスタンスに渡されます。 これにより、データソースからすべてのレコードがフェッチされ、指定されたフィールドに従ってメモリ内でソートが実行され、元のデータソースが置き換えられます。

ソートフィールド名は、レポートフィールド名と同一である必要があります。 ソートに使用されるフィールドには、java.util.Comparableを実装する型が必要です。 自然順序ソートは、タイプjava.lang.Stringのフィールドを除くすべてのフィールドに対して実行されます（ストリングタイプの場合、レポート入力ロケールに対応するコレーターが使用されます）。 複数の並べ替えフィールドを指定すると、フィールドはレポートテンプレートに表示される順序で並べ替えキーとしてフィールドを使用して実行されます。 次の例は、ソート機能を示しています。

ソートされたレポートの例

<* sortField *>要素を既存のレポートテンプレートに追加しましょう（チャプターリンク：/jasper_reports/jasper_report_designs [レポートデザイン]）。 フィールド_country_を降順でソートしましょう。 改訂されたレポートテンプレート（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}]]>
            </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;
   }
}
*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 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レポートフィールドの並べ替えの例

ここでは、国名がアルファベット順に降順で配置されていることがわかります。

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