Berichtsparameter

Die wichtigsten Eingaben zum Ausfüllen eines Berichts sind: Berichtsvorlage, Parameter und Datenquellen. In diesem Kapitel werden die Parameter beschrieben und im nächsten Kapitel werden die Datenquellen erläutert.

Parameter sind die Objektreferenzen, die während der Berichtsfüllvorgänge an die Berichtsengine übergeben werden. Die Daten, die nicht durch die Datenquelle übertragen werden können, können mithilfe von Parametern übergeben werden. Daten wie Autorenname, Titel des Berichts usw. können über Parameter übergeben werden. Eine JasperReports-Vorlage oder eine JRXML-Vorlage kann null oder mehr Parameterelemente enthalten.

Parameterdeklaration

Parameterdeklaration wie folgt -

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

Das Namensattribut

Das name- Attribut des <parameter> -Elements ist obligatorisch. Es verweist auf den Parameter in Berichtsausdrücken nach Namen. Der Parametername sollte ein einzelnes Wort sein. Es sollte keine Sonderzeichen wie Punkt oder Komma enthalten.

Das Klassenattribut

Das Klassenattribut ist ebenfalls obligatorisch und gibt den Klassennamen für die Parameterwerte an. Der Standardwert ist java.lang.String . Dies kann in jede zur Laufzeit verfügbare Klasse geändert werden. Unabhängig vom Typ eines Berichtsparameters kümmert sich die Engine um das Umwandeln der Berichtsausdrücke, in denen das Token $ P {} verwendet wird, sodass das manuelle Umsetzen nicht erforderlich ist.

Die Berichtsparameterwerte werden immer in ein java.util.Map-Objekt gepackt, dessen Schlüssel der Parametername ist. Berichtsparameter können in der Abfragezeichenfolge des Berichts verwendet werden, um den aus der Datenbank abgerufenen Datensatz weiter anzupassen. Diese wirken wie dynamische Filter in der Abfrage, die Daten für den Bericht liefert.

Eingebaute Parameter

Im Folgenden sind die vordefinierten Berichtsparameter aufgeführt, die in den Ausdrücken verwendet werden können.

S.NO.	Parametername und Beschreibung
1	REPORT_PARAMETERS_MAP Enthält eine Karte mit allen benutzerdefinierten und integrierten Parametern.
2	REPORT_CONNECTION Dies verweist auf die vom Benutzer angegebene Klasse java.sql.Connection, die für JDBC-Datenquellen verwendet wird.
3	REPORT_DATA_SOURCE Dies ist eine vom Benutzer bereitgestellte Instanz von JRDataSource, die entweder einen der integrierten oder einen benutzerdefinierten Datenquellentyp darstellt.
4	REPORT_MAX_COUNT Dies ist ein java.lang.Integer- Wert, mit dem die Benutzer die Datensätze aus der Datenquelle einschränken können.
5	REPORT_SCRIPTLET Dies zeigt auf net.sf.jasperreports.engine.JRAbstractScriptlet und enthält eine Instanz des vom Benutzer bereitgestellten Berichtsskriptlets.
6	REPORT_LOCALE Dies ist eine java.util.Locale- Instanz, die das gewünschte Gebietsschema des Ressourcenpakets enthält.
7	REPORT_RESOURCE_BUNDLE Dies zeigt auf das Objekt java.util.ResourceBundle und enthält lokalisierte Nachrichten.
8	REPORT_TIME_ZONE Dies ist eine java.util.TimeZone- Instanz, die für die Datumsformatierung verwendet wird.
9	REPORT_VIRTUALIZER Dies ist eine Instanz des Objekts net.sf.jasperreports.engine.JRVirtualizer , die für die Seitenvirtualisierung verwendet wird (Speicherverbrauch optimieren).
10	REPORT_CLASS_LOADER Dies ist eine java.lang.ClassLoader- Instanz, die während des Berichtsfüllprozesses zum Laden von Ressourcen wie Bildern, Schriftarten und Unterberichtsvorlagen verwendet wird
11	IS_IGNORE_PAGINATION Bei der Einstellung java.lang.Boolean.TRUE wird der Bericht auf einer langen Seite generiert und es kommt nicht zu einem Seitenumbruch.

Beispiel

Lassen Sie uns ReportTitle und Author an den Bericht übergeben (generiert von JasperReportFill.java). Überarbeitete DateiC:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\JasperReportFill.java ist wie folgt -

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

Der Inhalt der POJO-Datei C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\DataBean.java sind wie unten -

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

Der Inhalt der Datei C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\DataBeanList.java sind wie unten angegeben -

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

Fügen wir die Parameter <hinzuReportTitle> und <Author> zu unserer vorhandenen Berichtsvorlage (Kapitel Berichtsentwürfe ). Der Berichtstitel und der Autor werden am Anfang des Berichts angezeigt. Die überarbeitete Berichtsvorlage (jasper_report_template.jrxml) lautet wie folgt. Speichern Sie es im Verzeichnis 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>

Berichterstellung

Wir werden die obige Datei mit unserem regulären ANT-Erstellungsprozess kompilieren und ausführen. Der Inhalt der Datei build.xml (gespeichert im Verzeichnis C: \ tools \ jasperreports-5.0.1 \ test) ist wie folgt.

Die Importdatei - baseBuild.xml wird aus dem Kapitel Umgebungs-Setup ausgewählt und sollte im selben Verzeichnis wie die build.xml abgelegt werden.

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

Öffnen Sie als Nächstes das Befehlszeilenfenster und wechseln Sie in das Verzeichnis, in dem build.xml abgelegt ist. Führen Sie abschließend den Befehl ausant -Dmain-class=com.tutorialspoint.JasperReportFill (viewFullReport ist das Standardziel) wie folgt:

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

Als Ergebnis der obigen Kompilierung wird ein JasperViewer-Fenster geöffnet, wie im folgenden Bildschirm gezeigt -

Hier sehen wir, dass der ReportTitle "Liste der Kontakte" und der Autor "Prepared By Manisha" am Anfang des Berichts angezeigt werden.