Crea sottoreport

I sottoreport sono una delle caratteristiche interessanti di JasperReports. Questa funzione consente di incorporare un report all'interno di un altro report, ovvero un report può essere il sottoreport di un altro. I sottoreport ci aiutano a mantenere semplici le progettazioni dei report, poiché possiamo creare molti report semplici e incapsularli in un report principale. I sottoreport vengono compilati e compilati proprio come i normali report. Qualsiasi modello di rapporto può essere utilizzato come sottoreport quando incorporato in un altro modello di rapporto, senza che sia cambiato nulla all'interno (del modello di rapporto).

I sottoreport sono come normali modelli di report. Si tratta infatti di oggetti net.sf.jasperreports.engine.JasperReport , che si ottengono dopo aver compilato un oggetto net.sf.jasperreports.engine.design.JasperDesign .

Elemento <subreport>

Un elemento <subreport> viene utilizzato quando si introducono sottoreport nei report principali. Ecco l'elenco dei sottoelementi nell'elemento <subreport> JRXML.

• <reportElement>

• <parametersMapExpression>: viene utilizzato per passare una mappa contenente i parametri del report al sottoreport. La mappa viene solitamente ottenuta da un parametro nel report principale o utilizzando il parametro REPORTS_PARAMETERS_MAP incorporato per passare i parametri del report principale al sottoreport. Questa espressione dovrebbe sempre restituire un oggetto java.util.Map in cui le chiavi sono i nomi dei parametri.

• <subreportParameter>: questo elemento viene utilizzato per passare i parametri al sottoreport. Ha un nome di attributo , che è obbligatorio.

• <connectionExpression>: viene utilizzato per passare una connessione java.sql.Connection al sottoreport. Viene utilizzato solo quando il modello di sottoreport necessita di una connessione al database durante la fase di compilazione del report.

• <dataSourceExpression>: viene utilizzato per passare un'origine dati al sottoreport. Questa origine dati viene in genere ottenuta da un parametro nel report principale o utilizzando il parametro REPORT_DATA_SOURCE incorporato per passare l'origine dati del report padre al sottoreport.

• Gli elementi ( connectionExpression e dataSourceExpression ) non possono essere presenti contemporaneamente in una dichiarazione di elemento <subreport>. Questo perché non possiamo fornire sia un'origine dati che una connessione al sottoreport. Dobbiamo decidere su uno di loro e rispettarlo.

• <returnValue>: viene utilizzato per assegnare il valore di una delle variabili del sottoreport a una delle variabili del report principale. Questo elemento secondario ha attributi come segue:

  • subreportVariable : questo attributo specifica il nome della variabile del sottoreport il cui valore deve essere restituito.

  • toVariable - Questo attributo specifica il nome della variabile del report padre il cui valore deve essere copiato / incrementato con il valore del sottoreport.

  • calcolo : questo attributo può assumere valori: Nothing, Count, DistinctCount, Sum, Average, Lowest, Highest, StandardDeviation, Variance. Il valore predefinito per il calcolo degli attributi è "Nothing".

  • incrementerFactoryClass : questo attributo specifica la classe factory per la creazione dell'istanza di incrementer.

• <subreportExpression>: indica dove trovare il modello di report compilato per il sottoreport. Questo elemento ha un'estensioneclassattributo. L' attributo class può assumere uno qualsiasi di questi valori: java.lang.String, java.io.File, java.net.URL, java.io.InputStream, net.sf.jasperreports.engine.JasperReport. Il valore predefinito è java.lang.String .

• isUsingCache: questo è un attributo dell'elemento <subreport>. Si tratta di un valore booleano, se impostato su true , il motore di reporting tenterà di riconoscere gli oggetti del modello di sottoreport caricati in precedenza, utilizzando l'origine specificata. Questa funzionalità di memorizzazione nella cache è disponibile solo per gli elementi di sottoreport che contengono espressioni che restituiscono oggetti java.lang.String come origine del modello di sottoreport, che rappresentano nomi di file, URL o risorse del percorso di classe.

Esempio

Riprendiamo un semplice esempio per dimostrare la creazione di sottoreport utilizzando JRDataSource. Scriviamo prima due nuovi modelli di report, uno per il sottoreport e l'altro per il report principale. Il contenuto del modello del sottoreport (address_report_template.jrxml) è il seguente. Salvalo nella directory 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>

Poiché utilizziamo un'origine dati, dobbiamo scrivere un file POJO corrispondente SubReportBean.java come mostrato di seguito. Salvalo nella directory 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;
   }
}

Qui abbiamo dichiarato due campi "city" e "street" e sono definiti i rispettivi metodi getter e setter.

Ora, aggiorniamo il nostro esistente DataBeanfile. Aggiungeremo un nuovo campo subReportBeanList , che è java.util.List. Questo campo conterrà l'elenco degli oggetti SubReportBean. I contenuti del file DataBean sono i seguenti. Salvalo nella directory 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;
   }
}

Aggiorniamo ora il file C: \ tools \ jasperreports-5.0.1 \ test \ src \ com \ tutorialspoint \DataBeanList.java. I contenuti di questo file sono come:

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

Nel metodo produce () nel file sopra, stiamo impostando l'elenco di SubReportBean.

Ora, scriviamo un nuovo modello di report principale (jasper_report_template.jrxml). Salva questo file nella directoryC:\tools\jasperreports-5.0.1\test. I contenuti di questo file sono i seguenti:

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

Nel modello precedente, abbiamo definito un nuovo parametro "SUBREPORT_DIR", che definisce il percorso del sottoreport. Abbiamo definito un campo subReportBeanList di tipo java.util.List, che corrisponde alla proprietà nel file DataBean. L'elemento <subreport> ha il sottoelemento <dataSourceExpression>. Abbiamo inserito l'elenco subReportBeanList in un'istanza di JRBeanCollectionDataSource. Nel sottoelemento <subreportExpression />, abbiamo assegnato il nome del sottoreport (AddressReport.jasper).

Ora scriviamo una nuova classe CreateReportper compilare ed eseguire il nostro modello di report. Il contenuto del fileC:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\CreateReport.java sono come indicato di seguito -

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

Qui, vediamo che stiamo compilando i modelli di report principale e secondario e passando il file del report principale (.jasper) per il riempimento del report.

Generazione di report

Ora, tutti i nostri file sono pronti, compilarli ed eseguirli utilizzando il nostro normale processo di compilazione ANT. I contenuti del file build.xml (salvato nella directory C: \ tools \ jasperreports-5.0.1 \ test) sono i seguenti.

Il file di importazione - baseBuild.xml viene prelevato dal capitolo Configurazione dell'ambiente e dovrebbe essere posizionato nella stessa directory di 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>

Quindi, apriamo la finestra della riga di comando e andiamo alla directory in cui si trova build.xml. Infine, esegui il comandoant -Dmain-class=com.tutorialspoint.CreateReport (viewFullReport è la destinazione predefinita) come segue:

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

Come risultato della compilazione di cui sopra, si apre una finestra di JasperViewer come mostrato nella schermata sotto riportata -

Qui possiamo vedere che vengono visualizzati gli attributi Nome, Paese e Indirizzo.