Criar SubReports
Sub-relatórios são um dos recursos interessantes do JasperReports. Este recurso permite incorporar um relatório dentro de outro relatório, ou seja, um relatório pode ser um sub-relatório de outro. Os sub-relatórios nos ajudam a manter os designs de relatório simples, pois podemos criar muitos relatórios simples e encapsulá-los em um relatório mestre. Os sub-relatórios são compilados e preenchidos da mesma forma que os relatórios normais. Qualquer modelo de relatório pode ser usado como um sub-relatório quando incorporado em outro modelo de relatório, sem que nada seja alterado dentro (do modelo de relatório).
Os sub-relatórios são como modelos de relatório normais. Na verdade , eles são objetos net.sf.jasperreports.engine.JasperReport , que são obtidos após compilar um objeto net.sf.jasperreports.engine.design.JasperDesign .
Elemento <subreport>
Um elemento <subreport> é usado ao introduzir sub-relatórios nos relatórios principais. Aqui está a lista de subelementos no elemento <subreport> JRXML.
<reportElement>
<parametersMapExpression> - É usado para passar um mapa contendo parâmetros de relatório para o sub-relatório. O mapa geralmente é obtido de um parâmetro no relatório principal ou usando o parâmetro REPORTS_PARAMETERS_MAP integrado para passar os parâmetros do relatório pai para o sub-relatório. Esta expressão deve sempre retornar um objeto java.util.Map no qual as chaves são os nomes dos parâmetros.
<subreportParameter> - Este elemento é usado para passar parâmetros para o sub-relatório. Possui um nome de atributo , que é obrigatório.
<connectionExpression> - Isso é usado para passar um java.sql.Connection para o sub-relatório. É usado apenas quando o modelo de sub-relatório precisa de uma conexão com o banco de dados durante a fase de preenchimento do relatório.
<dataSourceExpression> - Isso é usado para passar uma fonte de dados para o sub-relatório. Essa fonte de dados geralmente é obtida de um parâmetro no relatório principal ou usando o parâmetro REPORT_DATA_SOURCE interno para passar a fonte de dados do relatório pai para o sub-relatório.
Os elementos ( connectionExpression e dataSourceExpression ) não podem estar presentes ao mesmo tempo em uma declaração de elemento <subreport>. Isso ocorre porque não podemos fornecer uma fonte de dados e uma conexão para o sub-relatório. Devemos decidir sobre um deles e segui-lo.
<returnValue> - É usado para atribuir o valor de uma das variáveis do sub-relatório a uma das variáveis do relatório mestre. Este subelemento possui os seguintes atributos -
subreportVariable - Este atributo especifica o nome da variável de sub-relatório cujo valor deve ser retornado.
toVariable - Este atributo especifica o nome da variável do relatório pai cujo valor deve ser copiado / incrementado com o valor do sub-relatório.
cálculo - Este atributo pode assumir os valores: Nothing, Count, DistinctCount, Sum, Average, Lower, Latest, StandardDeviation, Variance. O valor padrão para cálculo de atributo é "Nada".
incrementerFactoryClass - Este atributo especifica a classe de fábrica para criar a instância do incrementador.
<subreportExpression> - Isso indica onde encontrar o modelo de relatório compilado para o sub-relatório. Este elemento tem umclassatributo. O atributo class pode assumir qualquer um destes valores: java.lang.String, java.io.File, java.net.URL, java.io.InputStream, net.sf.jasperreports.engine.JasperReport. O valor padrão é java.lang.String .
isUsingCache - Este é um atributo do elemento <subreport>. Este é um booleano, quando definido como verdadeiro , o mecanismo de relatório tentará reconhecer objetos de modelo de sub-relatório carregados anteriormente, usando sua fonte especificada. Essa funcionalidade de armazenamento em cache está disponível apenas para elementos de sub-relatório que têm expressões que retornam objetos java.lang.String como a fonte do modelo de sub-relatório, representando nomes de arquivo, URLs ou recursos de caminho de classe.
Exemplo
Vamos pegar um exemplo simples para demonstrar a criação de sub-relatórios usando JRDataSource. Vamos primeiro escrever dois novos modelos de relatório, sendo um sub-relatório e outro relatório mestre. O conteúdo do modelo de sub-relatório (address_report_template.jrxml) é fornecido a seguir. Salve-o no diretório 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>
Como usamos uma fonte de dados, precisamos escrever um arquivo POJO correspondente SubReportBean.java como mostrado abaixo. Salve-o no diretório 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;
}
}
Aqui, declaramos dois campos 'cidade' e 'rua' e os respectivos métodos getter e setter são definidos.
Agora, vamos atualizar nosso DataBeanArquivo. Vamos adicionar um novo campo subReportBeanList , que é um java.util.List. Este campo conterá a lista de objetos SubReportBean. O conteúdo do arquivo DataBean é o seguinte. Salve-o no diretório 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;
}
}
Vamos agora atualizar o arquivo C: \ tools \ jasperreports-5.0.1 \ test \ src \ com \ tutorialspoint \DataBeanList.java. O conteúdo deste arquivo é como -
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;
}
}
No método produz () no arquivo acima, estamos definindo a lista de SubReportBean.
Agora, vamos escrever um novo modelo de relatório mestre (jasper_report_template.jrxml). Salve este arquivo no diretórioC:\tools\jasperreports-5.0.1\test. O conteúdo deste arquivo é o seguinte -
<?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>
No modelo acima, definimos um novo parâmetro "SUBREPORT_DIR", que define o caminho do sub-relatório. Definimos um campo subReportBeanList do tipo java.util.List, que corresponde à propriedade no arquivo DataBean. O elemento <subreport> possui o subelemento <dataSourceExpression>. Colocamos a lista subReportBeanList em uma instância de JRBeanCollectionDataSource. No subelemento <subreportExpression />, fornecemos o nome do sub-relatório (AddressReport.jasper).
Agora, vamos escrever uma nova classe CreateReportpara compilar e executar nosso modelo de relatório. O conteúdo do arquivoC:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\CreateReport.java são os dados abaixo -
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!!! ...");
}
}
Aqui, vemos que estamos compilando os modelos de relatório mestre e sub e passando o arquivo do relatório mestre (.jasper) para o preenchimento do relatório.
Geração de relatório
Agora, todos os nossos arquivos estão prontos, vamos compilá-los e executá-los usando nosso processo de construção ANT normal. O conteúdo do arquivo build.xml (salvo no diretório C: \ tools \ jasperreports-5.0.1 \ test) é fornecido a seguir.
O arquivo de importação - baseBuild.xml é obtido no capítulo Configuração do ambiente e deve ser colocado no mesmo diretório do 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>
A seguir, vamos abrir a janela da linha de comando e ir para o diretório onde build.xml está colocado. Finalmente, execute o comandoant -Dmain-class=com.tutorialspoint.CreateReport (viewFullReport é o destino padrão) da seguinte forma -
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
Como resultado da compilação acima, uma janela JasperViewer é aberta conforme mostrado na tela abaixo -
Aqui, podemos ver que os atributos Nome, País e Endereço são exibidos.