Wyrażenie raportu

Wyrażenia raportu to potężne funkcje JasperReports, które pozwalają nam wyświetlać obliczone dane w raporcie. Dane obliczeniowe to dane, które nie są danymi statycznymi i nie są przekazywane jako parametr raportu lub pole źródła danych. Wyrażenia raportu są tworzone z połączenia parametrów raportu, pól i danych statycznych. Język Java jest używany domyślnie do pisania wyrażeń raportów. Kompilatory JasperReports obsługują inne języki skryptowe dla wyrażeń raportów, takie jak język skryptowy Groovy, JavaScript lub skrypt BeanShell.

W tym rozdziale wyjaśniono - jak działają wyrażenia raportów, zakładając, że zostały napisane wyłącznie w języku Java. W szablonie raportu JRXML istnieje kilka elementów, które definiują wyrażenia jako -

• <variableExpression>
• <initialValueExpression>
• <groupExpression>
• <printWhenExpression>
• <imageExpression>
• <textFieldExpression>

Deklaracja wyrażenia

Zasadniczo wszystkie wyrażenia raportu są wyrażeniami Java, które mogą odwoływać się do pól raportu, zmiennych raportu i parametrów raportu.

Odniesienie do pola w wyrażeniu

Aby użyć odwołania do pola raportu w wyrażeniu, nazwę pola należy umieścić między $F{i} sekwencje znaków, jak pokazano poniżej -

<textfieldexpression>
   $F{Name}
</textfieldexpression>

Poniżej znajduje się fragment kodu z naszego istniejącego pliku JRXML (rozdział Projekty raportów) -

<textFieldExpression class = "java.lang.String">
   <![CDATA[$F{country}]]>
</textFieldExpression>

Odniesienie do zmiennej w wyrażeniu

Aby odwołać się do zmiennej w wyrażeniu, musimy umieścić nazwę zmiennej pomiędzy $V{i} jak pokazano na poniższym przykładzie -

<textfieldexpression>
   "Total height : " + $V{SumOfHeight} + " ft."
</textfieldexpression>

Odniesienie do parametru w wyrażeniu

Aby odwołać się do parametru w wyrażeniu, nazwę parametru należy umieścić pomiędzy $P{i} jak pokazano na poniższym przykładzie -

<textfieldexpression>
   "ReportTitle : " + $P{Title}
</textfieldexpression>

Poniżej znajduje się fragment kodu z naszego istniejącego pliku JRXML, który demonstruje odniesienie do parametru w wyrażeniu. (JRXML z rozdziału Projekty raportów ) -

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

Jak widzieliśmy powyżej, odwołania do parametrów, pól i zmiennych są w rzeczywistości rzeczywistymi obiektami Java. Znając ich klasę z parametru, pola lub deklaracji zmiennej w szablonie raportu, możemy nawet wywoływać metody na tych odwołaniach do obiektów w wyrażeniach.

Poniższy przykład pokazuje - jak wyodrębnić i wyświetlić pierwszą literę z pola raportu java.lang.String "Nazwa" -

<textFieldExpression>
   $F{Name}.substring(0, 1)
</textFieldExpression>

Odniesienie do pakietu zasobów w wyrażeniu

Aby odwołać się do zasobu w wyrażeniu, klucz należy umieścić między$R{i} jak pokazano na poniższym przykładzie -

<textfieldexpression>
   $R{report.title}
</textfieldexpression>

Na podstawie ustawień regionalnych dostarczonych przez środowisko wykonawcze i klucza report.title ładowany jest pakiet zasobów powiązany z szablonem raportu. W związku z tym tytuł raportu jest wyświetlany poprzez wyodrębnienie wartości String z pakunku zasobów. Więcej o internacjonalizacji można znaleźć w rozdziale Umiędzynarodowienie .

Kalkulator

Kalkulator to jednostka w JasperReports, która ocenia wyrażenia i zwiększa zmienne lub zestawy danych w czasie wypełniania raportu. Podczas procesu kompilacji informacje są tworzone i przechowywane w raporcie kompilacji przez kompilator. Informacje te są wykorzystywane w czasie wypełniania raportu do tworzenia instancji klasy net.sf.jasperreports.engine.fill.JRCalculator.

Plik źródłowy Java jest generowany i kompilowany w locie przez oparte na Javie kompilatory raportów. Ta wygenerowana klasa jest podklasą JRCalculator, a kod bajtowy utworzony przez jej kompilację jest przechowywany w obiekcie JasperReport. Ten kod bajtowy jest ładowany w czasie wypełniania raportu, a wynikowa klasa jest tworzona w celu uzyskania obiektu kalkulatora potrzebnego do oceny wyrażenia.

Wyrażenia warunkowe

JasperReports nie obsługuje instrukcji if-else podczas definiowania wyrażeń zmiennych. Zamiast tego możesz użyć operatorów trójskładnikowych{cond} ? {statement 1} : {statement 2}. Ten operator można zagnieżdżać w wyrażeniu Java, aby uzyskać żądane dane wyjściowe na podstawie wielu warunków.

Przykład wyrażenia warunkowego w raporcie

Zmodyfikujmy istniejący szablon raportu (Rozdział Projekty raportów ) i dodajmy wyrażenie warunkowe dla kraju pola. Zmieniony szablon raportu (jasper_report_template.jrxml) jest następujący. Zapisz go w katalogu 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>

Kody Java do wypełniania raportów są następujące. Zawartość plikuC:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\JasperReportFill.java są jak -

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

Zawartość pliku POJO C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\DataBean.java są jak -

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

Dodamy nowy rekord z pustym polem kraju na naszej liście Java bean. Zawartość plikuC:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\DataBeanList.java są jak -

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

Generowanie raportów

Skompilujemy i uruchomimy powyższy plik przy użyciu naszego zwykłego procesu budowania ANT. Poniżej podano zawartość pliku build.xml (zapisanego w katalogu C: \ tools \ jasperreports-5.0.1 \ test).

Plik importu - baseBuild.xml jest pobierany z rozdziału Konfiguracja środowiska i powinien być umieszczony w tym samym katalogu, co 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>

Następnie otwórzmy okno wiersza poleceń i przejdźmy do katalogu, w którym znajduje się plik build.xml. Na koniec wykonaj polecenieant -Dmain-class = com.tutorialspoint.JasperReportFill (domyślnym celem jest viewFullReport) jako -

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 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/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: 5 minutes 5 seconds

C:\tools\jasperreports-5.0.1\test>

W wyniku powyższej kompilacji otworzy się okno JasperViewer, jak pokazano na poniższym ekranie -

Tutaj widzimy, że dla ostatniego rekordu nie przekazaliśmy żadnych danych dla kraju pola, drukowany jest napis „NO COUNTRY”.