JasperReports - Tavole incrociate

I report a campi incrociati (cross-tabulation) sono report contenenti tabelle che dispongono i dati in righe e colonne in un formato tabulare. L'oggetto tabella a campi incrociati viene utilizzato per inserire un report a campi incrociati nel report principale. I campi incrociati possono essere utilizzati con qualsiasi livello di dati (nominale, ordinale, intervallo o rapporto) e in genere visualizzano i dati riepilogati, contenuti nelle variabili del report, sotto forma di tabella dinamica. Le variabili vengono utilizzate per visualizzare dati aggregati come somme, conteggi, valori medi.

Proprietà tabella a campi incrociati

Elemento JRXML <crosstab> viene utilizzato per inserire una tabella a campi incrociati in un report.

Attributo

Di seguito è riportato un elenco di attributi di un <crosstab> elemento -

  • isRepeatColumnHeaders- Indica se le intestazioni di colonna devono essere ristampate dopo un'interruzione di pagina. Il valore predefinito è vero .

  • isRepeatRowHeaders- Indica se le intestazioni di riga devono essere ristampate dopo un'interruzione di colonna della tabella a campi incrociati. Il valore predefinito è vero .

  • columnBreakOffset- Quando si verifica un'interruzione di colonna, indica la quantità di spazio verticale, misurata in pixel, prima della successiva parte della tabella a campi incrociati da posizionare sotto quella precedente sulla stessa pagina. Il valore predefinito è 10.

  • runDirection- Indica se i dati della tabella a campi incrociati devono essere compilati da sinistra a destra (LTR) o da destra a sinistra (RTL). Il valore predefinito è LTR.

  • ignoreWidth- Indica se la tabella a campi incrociati si estenderà oltre il limite di larghezza iniziale della tabella a campi incrociati e non genererà interruzioni di colonna. Altrimenti interromperà il rendering delle colonne entro il limite di larghezza della tabella a campi incrociati e continuerà con le colonne rimanenti solo dopo che il rendering di tutte le righe avrà iniziato. Il valore predefinito è false .

Elementi secondari

Un elemento <crosstab> ha i seguenti elementi secondari:

  • <reportElement>- Questo elemento definisce la posizione, la larghezza e l'altezza della tabella a campi incrociati all'interno del suo contenitore. Gli attributi per questo elemento includono tutti gli attributi <reportElement> standard.

  • <crosstabParameter>- Questo elemento viene utilizzato per accedere alle variabili e ai parametri del report dall'interno della tabella a campi incrociati. Gli attributi per questo elemento includono:

    • nome : definisce il nome del parametro.

    • class : indica la classe del parametro.

  • <parametersMapExpression>- Questo elemento viene utilizzato per passare una variabile o un parametro del report contenente un'istanza di java.util.Map , come insieme di parametri per la tabella a campi incrociati. Questo elemento non contiene attributi.

  • <crosstabDataset>- Questo elemento definisce il set di dati da utilizzare per popolare la tabella a campi incrociati (vedere la sezione successiva per una spiegazione dettagliata). Gli attributi per questo elemento includono:

    • isDataPreSorted : indica se i dati nel set di dati sono preordinati. Il valore predefinito è false .

  • <crosstabHeaderCell>- Questo elemento definisce il contenuto dell'area trovata nell'angolo superiore sinistro della tabella a campi incrociati dove si incontrano le intestazioni di colonna e le intestazioni di riga. La dimensione di questa cella viene calcolata automaticamente in base alle larghezze e altezze delle righe e delle colonne definite.

  • <rowGroup>- Questo elemento definisce un gruppo utilizzato per suddividere i dati in righe. Gli attributi per questo elemento includono:

    • nome : definisce il nome del gruppo di righe.

    • larghezza : definisce la larghezza del gruppo di righe.

    • headerPosition - Definisce la posizione del contenuto dell'intestazione (Top, Middle, Bottom, Stretch).

    • totalPosition : definisce la posizione dell'intera colonna (Start, End, None).

    Questo elemento contiene i seguenti elementi secondari:

    • <bucket>

    • <crosstabRowHeader>

    • <crosstabTotalRowHeader>

  • <columnGroup>- Questo elemento definisce un gruppo utilizzato per suddividere i dati in colonne. Gli attributi per questo elemento includono:

    • nome : definisce il nome del gruppo di colonne.

    • altezza : definisce l'altezza dell'intestazione del gruppo di colonne.

    • headerPosition - Definisce la posizione del contenuto dell'intestazione ( destra, sinistra, centro, allunga ).

    • totalPosition : definisce la posizione dell'intera colonna ( Start, End, None ).

    Questo elemento contiene i seguenti elementi secondari:

    • <bucket>

    • <crosstabColumnHeader>

    • <crosstabTotalColumnHeader>

  • <measure>- Questo elemento definisce il calcolo da eseguire su righe e colonne. Gli attributi per questo elemento includono:

    • nome : definisce il nome della misura.

    • class : indica la classe di misura.

    • calcolo : indica il calcolo da eseguire tra i valori delle celle della tabella a campi incrociati. I suoi valori potrebbero essere uno qualsiasi di questi: Nothing, Count, DistinctCount, Sum, Average, Lowest, Highest, StandardDeviation, Variance e First . Il valore predefinito èNothing.

  • <crosstabCell>- Questo elemento definisce come verranno disposti i dati nelle celle non di intestazione. Gli attributi per questo elemento includono:

    • columnTotalGroup : indica il gruppo da utilizzare per calcolare il totale della colonna.

    • altezza : definisce l'altezza della cella.

    • rowTotalGroup : indica il gruppo da utilizzare per calcolare il totale della riga.

    • larghezza : definisce la larghezza della cella.

  • <whenNoDataCell>- Questo elemento definisce cosa visualizzare in una cella vuota della tabella a campi incrociati. Questo elemento non contiene attributi.

Raggruppamento dei dati nella tabella a campi incrociati

Il motore di calcolo della tabella a campi incrociati aggrega i dati iterando attraverso i record del set di dati associati. Per aggregare i dati, è necessario prima raggrupparli. In una tabella a campi incrociati, righe e colonne si basano su elementi di gruppo specifici, denominatibuckets. Una definizione di bucket dovrebbe contenere:

  • bucketExpression : l'espressione da valutare per ottenere gli elementi del gruppo di dati.

  • comparatorExpression - Necessario nel caso in cui l'ordine naturale dei valori non sia la scelta migliore.

  • orderByExpression : indica il valore utilizzato per ordinare i dati.

I gruppi di righe e colonne (definiti sopra) in una tabella a campi incrociati si basano su buckets.

Variabili totali della tabella a campi incrociati incorporate

Di seguito è riportato un elenco del valore corrente della misura e dei totali dei diversi livelli corrispondenti alla cella è possibile accedere tramite variabili denominate secondo il seguente schema:

  • Il valore corrente di un calcolo di misura viene memorizzato in una variabile con lo stesso nome della misura.

  • <Measure> _ <Column Group> _ALL : restituisce il totale di tutte le voci nel gruppo di colonne dalla stessa riga.

  • <Misura> _ <Gruppo di righe> _ALL - Restituisce il totale per tutte le voci nel gruppo di righe dalla stessa colonna.

  • <Misura> _ <Gruppo di righe> _ <Gruppo di colonne> _ALL : restituisce il totale combinato corrispondente a tutte le voci in entrambi i gruppi di righe e di colonne.

Esempio

Per dimostrare le tabelle a campi incrociati, scriviamo un nuovo modello di report (jasper_report_template.jrxml). Qui aggiungeremo la tabella a campi incrociati alla sezione di riepilogo. Salvalo nella directoryC:\tools\jasperreports-5.0.1\test. I contenuti del file sono i seguenti:

<?xml version = "1.0" encoding = "UTF-8"?>

<!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" language = "groovy" pageWidth = "595"
   pageHeight = "842" columnWidth = "555" leftMargin = "20" rightMargin = "20"
   topMargin = "20" bottomMargin = "20">

   <parameter name = "ReportTitle" class = "java.lang.String"/>
   <parameter name = "Author" class = "java.lang.String"/>
   
   <field name = "name" class = "java.lang.String"/>
   <field name = "country" class = "java.lang.String"/>
   
   <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>
   
   <summary>
      <band height = "60">
      
      <crosstab>
         <reportElement width = "782" y = "0" x = "0" height = "60"/>
          
         <rowGroup name = "nameGroup" width = "100">
         
            <bucket>
               <bucketExpression class = "java.lang.String">
                  <![CDATA[$F{name}]]>
               </bucketExpression>
            </bucket>
            
            <crosstabRowHeader>
            
               <cellContents>
                  <box border = "Thin" borderColor = "black"/>
                  
                  <textField>
                     <reportElement width = "100" y = "0" x = "0" height = "20"/>
                     <textElement textAlignment = "Right" 
                        verticalAlignment = "Middle"/>
                     
                     <textFieldExpression>
                        <![CDATA[$V{nameGroup}]]>
                     </textFieldExpression>
                  </textField>
            
               </cellContents>
         
            </crosstabRowHeader>

         </rowGroup>
         
         <columnGroup name = "countryGroup" height = "20">
            <bucket>
               
               <bucketExpression class = "java.lang.String">
                  $F{country}
               </bucketExpression>
            </bucket>
            
            <crosstabColumnHeader>
               <cellContents>
                  <box border = "Thin" borderColor = "black"/>
                  <textField isStretchWithOverflow = "true">
                     <reportElement width = "60" y = "0" x = "0" height = "20"/>
                     <textElement verticalAlignment = "Bottom"/>
                     <textFieldExpression>
                        <![CDATA[$V{countryGroup}]]>
                     </textFieldExpression>
                  </textField>
               </cellContents>
            </crosstabColumnHeader>

         </columnGroup>
         
         <measure name = "tailNumCount" class = "java.lang.Integer"  
            calculation = "Count">
            <measureExpression>$F{country}</measureExpression>
         </measure>
         
         <crosstabCell height = "20" width = "60">
            <cellContents backcolor = "#FFFFFF">
               <box borderColor = "black" border = "Thin"/>
               <textField>
                  <reportElement x = "5" y = "0" width = "55" height = "20"/>
                  <textElement textAlignment = "Left" 
                     verticalAlignment = "Bottom"/>
                  <textFieldExpression class = "java.lang.Integer">
                      $V{tailNumCount}
                  </textFieldExpression>
               </textField>
            </cellContents>
         </crosstabCell>
      
      </crosstab>
      
      </band>
   </summary>
	
</jasperReport>

I dettagli del file sopra sono i seguenti:

  • La tabella incrociata è definita dall'elemento <crosstab>.

  • L'elemento <rowGroup> definisce un gruppo per suddividere i dati in righe. Qui, ogni riga mostrerà i dati per un nome diverso.

  • Gli elementi <bucket> e <bucketExpression> definiscono quale espressione di report utilizzare come delimitatore di gruppo per <rowGroup>. Qui, abbiamo utilizzato il campo del nome come delimitatore, al fine di dividere le righe per nome.

  • L'elemento <crosstabRowHeader> definisce l'espressione da utilizzare come intestazione di riga. Contiene un singolo sottoelemento, ovvero <cellContents>, che agisce come una banda interna all'interno della tabella a campi incrociati. Invece di definire il nome della variabile per il campo di testo all'interno di <crosstabRowHeader>, abbiamo assegnato il nome a <rowGroup> (tramite il suo attributo name), quindi crea una variabile implicita. L'elemento <crosstabRowHeader> definisce il contenuto della cella di intestazione per l'intera riga. Accetta un singolo elemento <cellContents> come unico sottoelemento.

  • L'elemento <columnGroup> così come i suoi sottoelementi è analogo all'elemento <rowGroup>, tranne per il fatto che influenza le colonne anziché le righe.

  • L'elemento <measure> definisce il calcolo da eseguire su righe e colonne. L' attributo di calcolo è impostato su Conteggio .

  • L'elemento <crosstabCell> definisce come saranno disposti i dati nelle celle non di intestazione. Questo elemento contiene anche un singolo elemento <crosstabCell> come unico sottoelemento.

I codici Java per la compilazione del report rimangono invariati. Il contenuto del fileC:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\JasperReportFill.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.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();
      }
   }
}

Il contenuto del file POJO C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\DataBean.java sono i seguenti -

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

Il contenuto del file C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\DataBeanList.java sono i seguenti -

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

Generazione di report

Successivamente, compiliamo ed eseguiamo i file sopra 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.JasperReportFill (viewFullReport è la destinazione predefinita) come segue:

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

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 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: 20 minutes 53 seconds

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

Qui, vediamo che ogni paese e nome sono tabulati.