Учебники

Создать подотчеты

Январь 7, 2019

Подотчеты являются одной из приятных особенностей JasperReports. Эта функция позволяет включать отчет в другой отчет, то есть один отчет может быть вложенным отчетом другого. Подотчеты помогают нам упростить дизайн отчетов, поскольку мы можем создавать множество простых отчетов и инкапсулировать их в основной отчет. Подотчеты составляются и заполняются как обычные отчеты. Любой шаблон отчета может быть использован в качестве вложенного отчета, когда включен в другой шаблон отчета, без каких-либо изменений внутри (шаблона отчета).

Вложенные отчеты похожи на обычные шаблоны отчетов. На самом деле это объекты net.sf.jasperreports.engine.JasperReport , которые получаются после компиляции объекта net.sf.jasperreports.engine.design.JasperDesign .

Элемент <subreport>

Элемент <subreport> используется при добавлении подотчетов в основные отчеты. Вот список подэлементов в элементе <subreport> JRXML.

  • <ReportElement>

  • <parametersMapExpression> — используется для передачи карты, содержащей параметры отчета, в подотчет. Карта обычно получается из параметра в основном отчете или с помощью встроенного параметра REPORTS_PARAMETERS_MAP для передачи параметров родительского отчета во вложенный отчет. Это выражение всегда должно возвращать объект java.util.Map, ключами которого являются имена параметров.

  • <subreportParameter> — этот элемент используется для передачи параметров в подотчет. У него есть имя атрибута, которое является обязательным.

  • <connectionExpression> — используется для передачи java.sql.Connection в подотчет. Он используется только тогда, когда шаблону подотчета требуется соединение с базой данных на этапе заполнения отчета.

  • <dataSourceExpression> — используется для передачи источника данных в подотчет. Этот источник данных обычно получают из параметра в главном отчете или с помощью встроенного параметра REPORT_DATA_SOURCE для передачи источника данных родительского отчета в подотчет.

  • Элементы ( connectionExpression и dataSourceExpression ) не могут присутствовать одновременно в объявлении элемента <subreport>. Это связано с тем, что мы не можем предоставить источник данных и соединение с вложенным отчетом. Мы должны определиться с одним из них и придерживаться его.

  • <returnValue> — используется для присвоения значения одной из переменных подотчета одной из переменных основного отчета. Этот подэлемент имеет следующие атрибуты:

    • subreportVariable — Этот атрибут указывает имя переменной подотчета, значение которой должно быть возвращено.

    • toVariable — этот атрибут задает имя родительской переменной отчета, значение которой нужно скопировать / увеличить со значением из подотчета.

    • Вычисление — Этот атрибут может принимать значения: Ничего, Подсчет, DistinctCount, Сумма, Среднее, Самое низкое, Самое высокое, Стандартное отклонение, Дисперсия. Значение по умолчанию для расчета атрибута — «Ничего».

    • incrementerFactoryClass — этот атрибут указывает класс фабрики для создания экземпляра инкремента.

  • <subreportExpression> — указывает, где найти шаблон скомпилированного отчета для вложенного отчета. Этот элемент имеет атрибут класса . Атрибут класса может принимать любое из следующих значений: java.lang.String, java.io.File, java.net.URL, java.io.InputStream, net.sf.jasperreports.engine.JasperReport. Значением по умолчанию является java.lang.String .

  • isUsingCache — это атрибут элемента <subreport>. Это логическое значение, при значении true механизм создания отчетов будет пытаться распознать ранее загруженные объекты шаблона подотчета, используя их указанный источник. Эта функция кэширования доступна только для элементов подотчета, в которых выражения, возвращающие объекты java.lang.String в качестве источника шаблона подотчета, представляют имена файлов, URL-адреса или ресурсы пути к классам.

<ReportElement>

<parametersMapExpression> — используется для передачи карты, содержащей параметры отчета, в подотчет. Карта обычно получается из параметра в основном отчете или с помощью встроенного параметра REPORTS_PARAMETERS_MAP для передачи параметров родительского отчета во вложенный отчет. Это выражение всегда должно возвращать объект java.util.Map, ключами которого являются имена параметров.

<subreportParameter> — этот элемент используется для передачи параметров в подотчет. У него есть имя атрибута, которое является обязательным.

<connectionExpression> — используется для передачи java.sql.Connection в подотчет. Он используется только тогда, когда шаблону подотчета требуется соединение с базой данных на этапе заполнения отчета.

<dataSourceExpression> — используется для передачи источника данных в подотчет. Этот источник данных обычно получают из параметра в главном отчете или с помощью встроенного параметра REPORT_DATA_SOURCE для передачи источника данных родительского отчета в подотчет.

Элементы ( connectionExpression и dataSourceExpression ) не могут присутствовать одновременно в объявлении элемента <subreport>. Это связано с тем, что мы не можем предоставить источник данных и соединение с вложенным отчетом. Мы должны определиться с одним из них и придерживаться его.

<returnValue> — используется для присвоения значения одной из переменных подотчета одной из переменных основного отчета. Этот подэлемент имеет следующие атрибуты:

subreportVariable — Этот атрибут указывает имя переменной подотчета, значение которой должно быть возвращено.

toVariable — этот атрибут задает имя родительской переменной отчета, значение которой нужно скопировать / увеличить со значением из подотчета.

Вычисление — Этот атрибут может принимать значения: Ничего, Подсчет, DistinctCount, Сумма, Среднее, Самое низкое, Самое высокое, Стандартное отклонение, Дисперсия. Значение по умолчанию для расчета атрибута — «Ничего».

incrementerFactoryClass — этот атрибут указывает класс фабрики для создания экземпляра инкремента.

<subreportExpression> — указывает, где найти шаблон скомпилированного отчета для вложенного отчета. Этот элемент имеет атрибут класса . Атрибут класса может принимать любое из следующих значений: java.lang.String, java.io.File, java.net.URL, java.io.InputStream, net.sf.jasperreports.engine.JasperReport. Значением по умолчанию является java.lang.String .

isUsingCache — это атрибут элемента <subreport>. Это логическое значение, при значении true механизм создания отчетов будет пытаться распознать ранее загруженные объекты шаблона подотчета, используя их указанный источник. Эта функция кэширования доступна только для элементов подотчета, в которых выражения, возвращающие объекты java.lang.String в качестве источника шаблона подотчета, представляют имена файлов, URL-адреса или ресурсы пути к классам.

пример

Давайте рассмотрим простой пример, демонстрирующий создание вложенных отчетов с использованием JRDataSource. Давайте сначала напишем два новых шаблона отчета, один из которых будет подчиненным, а другой — основным отчетом. Содержимое шаблона подотчета (address_report_template.jrxml) приведено ниже. Сохраните его в каталоге 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>

Поскольку мы используем источник данных, нам нужно написать соответствующий файл POJO SubReportBean.java, как показано ниже. Сохраните его в каталог 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;
   }
}

Здесь мы объявили два поля ‘city’ и ‘street’ и определили соответствующие методы getter и setter.

Теперь давайте обновим наш существующий файл DataBean . Мы добавим новое поле subReportBeanList , которое является java.util.List. Это поле будет содержать список объектов SubReportBean. Содержимое файла DataBean приведено ниже. Сохраните его в каталоге 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;
   }
}

Давайте теперь обновим файл C: \ tools \ jasperreports-5.0.1 \ test \ src \ com \ tutorialspoint \ DataBeanList.java . Содержимое этого файла как — 

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

В методе yield () в приведенном выше файле мы устанавливаем список SubReportBean.

Теперь давайте напишем новый шаблон основного отчета (jasper_report_template.jrxml). Сохраните этот файл в каталоге 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 = "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>

В приведенном выше шаблоне мы определили новый параметр «SUBREPORT_DIR», который определяет путь к подотчету. Мы определили поле subReportBeanList типа java.util.List, которое соответствует свойству в файле DataBean. Элемент <subreport> имеет вложенный элемент <dataSourceExpression>. Мы поместили список subReportBeanList в экземпляр JRBeanCollectionDataSource. В подэлементе <subreportExpression /> мы дали имя подотчета (AddressReport.jasper).

Теперь давайте напишем новый класс CreateReport для компиляции и выполнения нашего шаблона отчета. Содержимое файла C: \ tools \ jasperreports-5.0.1 \ test \ src \ com \ tutorialspoint \ CreateReport.java указано ниже — 

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

Здесь мы видим, что мы компилируем шаблоны основного и вложенного отчета и передаем файл основного отчета (.jasper) для заполнения отчета.

Генерация отчетов

Теперь все наши файлы готовы, давайте скомпилируем и выполним их, используя наш обычный процесс сборки ANT. Содержимое файла build.xml (сохраненного в каталоге C: \ tools \ jasperreports-5.0.1 \ test) приведено ниже.

Файл импорта — baseBuild.xml взят из главы « Настройка среды» и должен быть расположен в том же каталоге, что и 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.tutorialspoint.CreateReport (viewFullReport — цель по умолчанию) следующим образом: 

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

В результате вышеупомянутой компиляции открывается окно JasperViewer, как показано на приведенном ниже экране —

Jasper SubReport Пример

Здесь мы видим, что отображаются атрибуты Имя, Страна и Адрес.

91
Share: