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

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

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

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

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

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

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

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

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

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

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

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

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

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

Расчет

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

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

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

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

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

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

• Ничего - для переменной вычисления не производятся.

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

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

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

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

Инкрементатор FactoryClass

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

IncrementType

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

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

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

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

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

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

IncrementGroup

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

ResetType

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

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

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

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

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

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

ResetGroup

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

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

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

S.NO	Имя и описание переменной
1	PAGE_NUMBER Значение этой переменной - номер ее текущей страницы. Он может быть использован для отображения как номер текущей страницы и общее количество страниц с помощью специальной функции элементов поля JasperReports текста, в evaluationTime атрибута.
2	COLUMN_NUMBER Эта переменная содержит текущий номер столбца.
3	REPORT_COUNT Эта переменная отчета содержит общее количество обработанных записей.
4	PAGE_COUNT Эта переменная содержит количество записей, которые были обработаны при создании текущей страницы.
5	COLUMN_COUNT Эта переменная содержит количество записей, которые были обработаны при создании текущего столбца.
6	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, как на экране ниже -

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