Переменные отчета

Переменные отчета — это специальные объекты, построенные поверх выражения отчета.

Переменные отчета упрощают следующие задачи —

• Выражения отчета, которые интенсивно используются в шаблоне отчета. Эти выражения могут быть объявлены только один раз с помощью переменных отчета.

• Переменные отчета могут выполнять различные вычисления на основе соответствующих значений выражений, таких как число, сумма, среднее, самое низкое, наибольшее, дисперсия и т. Д.

Выражения отчета, которые интенсивно используются в шаблоне отчета. Эти выражения могут быть объявлены только один раз с помощью переменных отчета.

Переменные отчета могут выполнять различные вычисления на основе соответствующих значений выражений, таких как число, сумма, среднее, самое низкое, наибольшее, дисперсия и т. Д.

Если переменные определены в дизайне отчета, то на них могут ссылаться новые переменные в выражениях. Следовательно, порядок, в котором переменные объявляются в дизайне отчета, важен.

Объявление переменной

Объявление переменной выглядит следующим образом:

<variable name = "CityNumber" class = "java.lang.Integer" incrementType = "Group"
   incrementGroup = "CityGroup" calculation = "Count">
   <variableExpression>
      <![CDATA[Boolean.TRUE]]>
   </variableExpression>
</variable>

Как видно выше, элемент <variable> содержит количество атрибутов. Эти атрибуты приведены ниже —

Атрибут имени

Подобно параметрам и полям , атрибут name элемента </ variable> является обязательным. Это позволяет ссылаться на переменную по объявленному имени в выражениях отчета.

Атрибут класса

Атрибут class также является обязательным, который указывает имя класса для значений переменной. Значением по умолчанию является java.lang.String . Это можно изменить на любой класс, доступный в пути к классам, как во время составления отчета, так и во время заполнения отчета. Движок заботится о приведении типов в выражениях отчетов, которые использует токен $ V {}, поэтому приведение типов вручную не требуется.

расчет

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

• Среднее — значение переменной является средним значением каждого ненулевого значения выражения переменной. Действительно только для числовых переменных.

• Count — значение переменной является количеством ненулевых экземпляров выражения переменной.

• Первый — значение переменной — это значение первого экземпляра выражения переменной. Последующие значения игнорируются.

• Highest — значение переменной является наибольшим значением для выражения переменной.

• Наименьшее — значение переменной является наименьшим значением для выражения переменной в отчете.

• Ничего — расчет переменной не производится.

• StandardDeviation — значение переменной — это стандартное отклонение всех ненулевых значений, соответствующих выражению отчета. Действительно только для числовых переменных.

• Sum — значение переменной является суммой всех ненулевых значений, возвращаемых выражением отчета.

• Система — значение переменной представляет собой пользовательский расчет (вычисление значения для этой переменной самостоятельно с использованием функциональности скриптлетов JasperReports).

• Дисперсия — значение переменной — это дисперсия всех ненулевых значений, возвращаемых вычислением выражения переменной отчета.

Среднее — значение переменной является средним значением каждого ненулевого значения выражения переменной. Действительно только для числовых переменных.

Count — значение переменной является количеством ненулевых экземпляров выражения переменной.

Первый — значение переменной — это значение первого экземпляра выражения переменной. Последующие значения игнорируются.

Highest — значение переменной является наибольшим значением для выражения переменной.

Наименьшее — значение переменной является наименьшим значением для выражения переменной в отчете.

Ничего — расчет переменной не производится.

StandardDeviation — значение переменной — это стандартное отклонение всех ненулевых значений, соответствующих выражению отчета. Действительно только для числовых переменных.

Sum — значение переменной является суммой всех ненулевых значений, возвращаемых выражением отчета.

Система — значение переменной представляет собой пользовательский расчет (вычисление значения для этой переменной самостоятельно с использованием функциональности скриптлетов JasperReports).

Дисперсия — значение переменной — это дисперсия всех ненулевых значений, возвращаемых вычислением выражения переменной отчета.

Инкремент FactoryClass

Этот атрибут определяет класс, используемый для вычисления значения переменной при заполнении текущей записи в отчете. Значением по умолчанию будет любой класс, реализующий net.sf.jasperreports.engine.fill.JRIncrementerFactory . Класс фабрики будет использоваться механизмом для создания экземпляров инкрементных объектов во время выполнения в зависимости от атрибута вычисления, установленного для переменной.

IncrementType

Это определяет, когда пересчитать значение переменной. Этот атрибут использует значения, как показано ниже:

• Столбец — значение переменной пересчитывается в конце каждого столбца.

• Группа — значение переменной пересчитывается при изменении группы, указанной в incrementGroup.

• Нет — значение переменной пересчитывается с каждой записью.

• Страница — значение переменной пересчитывается в конце каждой страницы.

• Отчет — значение переменной пересчитывается один раз, в конце отчета.

Столбец — значение переменной пересчитывается в конце каждого столбца.

Группа — значение переменной пересчитывается при изменении группы, указанной в incrementGroup.

Нет — значение переменной пересчитывается с каждой записью.

Страница — значение переменной пересчитывается в конце каждой страницы.

Отчет — значение переменной пересчитывается один раз, в конце отчета.

IncrementGroup

Это определяет имя группы, в которой значение переменной пересчитывается, когда incrementType имеет значение Group . Это берет имя любой группы, объявленной в шаблоне отчета JRXML.

ResetType

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

• Столбец — значение переменной сбрасывается в начале каждого столбца.

• Группа — значение переменной сбрасывается при изменении группы, указанной в incrementGroup.

• None — значение переменной никогда не сбрасывается.

• Страница — значение переменной сбрасывается в начале каждой страницы.

• Отчет — значение переменной сбрасывается только один раз, в начале отчета.

Столбец — значение переменной сбрасывается в начале каждого столбца.

Группа — значение переменной сбрасывается при изменении группы, указанной в incrementGroup.

None — значение переменной никогда не сбрасывается.

Страница — значение переменной сбрасывается в начале каждой страницы.

Отчет — значение переменной сбрасывается только один раз, в начале отчета.

ResetGroup

Это определяет имя группы, в которой значение переменной сбрасывается, когда resetType имеет значение Group . Значения для этого атрибута будут именем любой группы, объявленной в шаблоне отчета JRXML.

Встроенные переменные отчета

Есть несколько встроенных системных переменных, готовых к использованию в выражениях, а именно:

НОМЕР СТРАНИЦЫ

Значением этой переменной является номер текущей страницы. Его можно использовать для отображения как номера текущей страницы, так и общего количества страниц, используя специальную функцию элементов текстового поля JasperReports, атрибутvaluationTime.

COLUMN_NUMBER

Эта переменная содержит текущий номер столбца.

REPORT_COUNT

Эта переменная отчета содержит общее количество обработанных записей.

КОЛИЧЕСТВО СТРАНИЦ

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

COLUMN_COUNT

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

GroupName_COUNT

Имя этой переменной происходит от имени группы, которой она соответствует, с суффиксом последовательности _COUNT. Эта переменная содержит количество записей в текущей группе.

пример

Давайте добавим переменную ( countNumber ) к существующему шаблону отчета (глава « Конструкции отчета» ). Мы будем добавлять префикс к каждой записи. Пересмотренный шаблон отчета (jasper_report_template.jrxml) выглядит следующим образом. Сохраните его в каталоге 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>
   
   <variable name = "countNumber" class = "java.lang.Integer" calculation = "Count">
      <variableExpression>
         <![CDATA[Boolean.TRUE]]>
      </variableExpression>
   </variable>
   
   <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["  " + String.valueOf($V{countNumber}) +"."+$F{name}]]>
            </textFieldExpression>
         </textField>
      
      </band>
   </detail>

</jasperReport>

Java-коды для заполнения отчетов остаются без изменений. Содержимое файла C: \ tools \ jasperreports-5.0.1 \ test \ src \ com \ tutorialspoint \ JasperReportFill.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.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();
      }
   }
}

Содержимое файла POJO C: \ tools \ jasperreports-5.0.1 \ test \ src \ com \ tutorialspoint \ DataBean.java указано ниже —

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

Содержимое файла C: \ tools \ jasperreports-5.0.1 \ test \ src \ com \ tutorialspoint \ DataBeanList.java указано ниже —

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

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

Мы скомпилируем и выполним вышеуказанный файл, используя наш обычный процесс сборки 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.JasperReportFill (viewFullReport является целью по умолчанию) как —

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

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

Здесь мы видим, что счетчик имеет префикс для каждой записи.