SILVIO COSTA MOREIRA UTILIZAÇÃO DAS FERRAMENTAS JASPERREPORTS E IREPORT PARA A GERAÇÃO DE RELATÓRIO EM APLICAÇÕES JAVA

Transcrição

1 SILVIO COSTA MOREIRA UTILIZAÇÃO DAS FERRAMENTAS JASPERREPORTS E IREPORT PARA A GERAÇÃO DE RELATÓRIO EM APLICAÇÕES JAVA Palmas 2005

2 i SILVIO COSTA MOREIRA UTILIZAÇÃO DAS FERRAMENTAS JASPERREPORTS E IREPORT PARA A GERAÇÃO DE RELATÓRIO EM APLICAÇÕES JAVA Monografia apresentada como requisito parcial para a obtenção de nota na disciplina de Estágio Supervisionado em Sistema de Informação do curso de Sistemas de Informação, orientado pelo Profº. Fernando Luiz de Oliveira. Palmas 2005

3 ii SILVIO COSTA MOREIRA UTILIZAÇÃO DAS FERRAMENTAS JASPERREPORTS E IREPORT PARA A GERAÇÃO DE RELATÓRIO EM APLICAÇÕES JAVA Monografia apresentada como requisito parcial para a obtenção de nota na disciplina de Estágio Supervisionado em Sistema de Informação do curso de Sistemas de Informação, orientado pelo Profº. Fernando Luiz de Oliveira. Aprovada em Dezembro de 2005 BANCA EXAMINADORA Profº. M.Sc. Fernando Luiz de Oliveira Centro Universitário Luterano de Palmas Profº. M.Sc. Fabiano Fagundes Centro Universitário Luterano de Palmas Profº. Ricardo Marx Costa de Jesus Centro Universitário Luterano de Palmas Palmas 2005

4 iii AGRADECIMENTOS À Deus por te me dado a vida a minha familia; Aos meus pais: Salomão Barbosa Moreira e Raimunda Ires costa Moreira por terem me dado oportunidade de chegar até aqui; Aos meus irmãos: Viviane Costa Moreira, Fabiane Costa Moreira, Saulo Costa Moreira, Alinne Costa Moreira e Lidianne Costa Moreira; Aos meus sobrinhos: Isabella, Samuel, Emanuel por terem me dado espiração para buscar novos horizontes; Aos meus tios, primos, cunhado. Aos professores que no decorrer deste curso me transmitem conhecimento, ao professor Fernando Luiz de Oliveira que me orientou na conclusão desse trabalho. Enfim, colegas de sala que se tornaram parte da minha vida, aos funcionarios e professores que trabalham na sala de produção de texto, aos funcionarios da biblioteca do CEULP/ULBRA-TO que me ajudaram a encotrar bibliografias necessarias para o desenvolvimento deste trabalho.

5 iv SUMÁRIO LISTA DE FIGURAS...V LISTA DE TABELAS... VI 1 INTRODUÇÃO REVISÃO DE LITERATURA GERAÇÃO DE RELATÓRIO Organização de um Relatório GERAÇÃO DE RELATÓRIOS UTILIZANDO A LINGUAGEM DE PROGRAMAÇÃO JAVA JASPERREPORTS Projeto do Relatório Origem dos Dados Campos Expressões Variáveis Seções do Relatório Parâmetros Principais Classes da Biblioteca JasperReports IREPORT Criação de Projetos de Relatórios com ireport Origem dos Dados com ireport Criação de Parâmetros com ireport Criação de Campos com ireport Criação de Variáveis com ireport Criando Expressões com ireport Seções com ireport Testando e Visualizando o Projeto do Relatório no ireport Código Gerado no IREPORT MATERIAIS E MÉTODOS LOCAL E PERÍODO MATERIAIS Fontes Bibliográficas Hardware Software Instalação e Configuração das Ferramentas Instalação e Configuração do J2SE Instalação e Configuração do IReport Instalação e Configuração do JasperReports METODOLOGIA RESULTADOS E DISCUSSÃO VISÃO GERAL DA APLICAÇÃO GERANDO RELATÓRIO CONSIDERAÇÕES FINAIS REFERÊNCIAS BIBLIOGRÁFICAS...62 ANEXOS...63

6 v LISTA DE FIGURAS Figura 1: Funcionamento da biblioteca JasperReports. (JASPERREPORTS, 2005)...17 Figura 2: Exemplo de um projeto do relatório. (JASPERREPORTS, 2005)...18 Figura 3: Passagem de um objeto resultset para o relatório, através de uma classe Java...19 Figura 4: Código de criação de um campo. (JASPERREPORTS, 2005)...20 Figura 5: Código de criação de uma expressão. (JASPERREPORTS, 2005)...20 Figura 6: Código de criação de uma variável. (JASPERREPORTS, 2005)...21 Figura 7: Código de criação de uma seção. (JASPERREPORTS, 2005)...23 Figura 8: Código de criação de um parâmetro. (JASPERREPORTS, 2005)...24 Figura 9: Tela principal do ireport - Menu Arquivo...26 Figura 10: Tela de configuração inicial do projeto do relatório...27 Figura 11: Tela principal, menu fonte de dados...27 Figura 12: Telas de criação e configuração e teste de uma fonte de dados...28 Figura 13: Tela principal do ireport, menu visualizar...29 Figura 14: Telas de criação e configuração de parâmetros...29 Figura 15: Tela principal, menu Visualizar, Campos do Relatório...30 Figura 16: Telas de criação e configuração de campo do projeto...31 Figura 17: Tela principal, menu Visualizar, Variáveis do Relatório...31 Figura 18: Telas de criação e configuração de variável...32 Figura 19: Tela de criação e configuração de uma variável...33 Figura 20: Tela principal, página do projeto dividas em seções...34 Figura 21: Tela principal, menu Criar (build), Executa relatório (usando uma conexão ativa)...35 Figura 22: Visualização do relatório na interface JasperViewer...35 Figura 23: Tele de propriedades do sistema Windows Figura 24: Tele de criação e configuração das variáveis de ambiente Figura 25: Tela de criação de uma variável de ambiente do usuário...41 Figura 26: Tela de criação da variável de ambiente do usuário...42 Figura 27: Tela de criação da variável de ambiente do usuário...43 Figura 28: Tela de configuração...44 Figura 29: Tela de adição de bibliotecas ao CLASSPATH...45 Figura 30: Tela de criação e configuração iniciais do projeto...48 Figura 31 : Tela de criação e configuração da fonte de dados...49 Figura 32: Tela de ativação da fonte de dados do projeto...50 Figura 33: Tela de criação e configuração de parâmetro para o projeto do relatório...51 Figura 34: Barra de ferramentas do ireport...51 Figura 35: Inserção de um parâmetro dentro da seção title...52 Figura 36: Inserção dos campos dentro da seção deitel da pagina do relatório...53 Figura 37: Tela de configuração de um campo dentro da seção deitel da página do relatório...54 Figura 38: Tela de criação de variável...55 Figura 39: Inserção de uma variável na seção totalfooter...56 Figura 40: Visualização do relatório através da interface gráfica JasperVierwer...57 Figura 41: Executando o relatório na aplicação...59

7 vi LISTA DE TABELAS Tabela 1: Cronograma das atividades...46

8 vii RESUMO A geração de relatórios corresponde a uma das tarefas mais comuns e necessárias em sistemas de informação. Assim, por menor que seja o sistema, a geração de relatórios será um de seus requisitos. Por ser um requisito necessário, as ferramentas tendem a agregar funcionalidades que facilitem o trabalho dos desenvolvedores. Por exemplo, para a linguagem de programação Java existem ferramentas que auxiliam este trabalho, tal como a biblioteca de classe Java chamada JasperReports, que com o auxílio da ferramenta ireport proporciona o desenvolvimento de relatórios para aplicações Java. O presente trabalho tem a finalidade de expor conceitos envolvendo a geração de relatório em aplicações Java, utilizando o JasperReports e ireport, bem como apresentar, na prática, sua utilização através da geração de relatório para uma determinada aplicação desenvolvida em Java. Palavras-chaves: Desenvolvimento de Sistemas, JasperReports e ireport

9 viii ABSTRACT The generation of reports corresponds to one of the most common and necessary tasks in information systems. Thus, despite the size of the system, the generation of reports will be one of its requirements. As for being a necessary requirement, the tools tend to add functionalities that facilitate the work of the developers. For example, for the Java programming language there are tools that help this work, such as the library of class called Java JasperReports, with the help of the proportional tool ireport the report development for Java applications. The present work has the purpose to display concepts involving the generation of report in Java applications, using the JasperReports and ireport, as well presenting, in practical, its use through the generation of report for one determined application developed in Java. Keywords: Development of Systems, JasperReports e ireport

10 11 1 INTRODUÇÃO A geração de relatórios corresponde a uma das tarefas mais comuns e necessárias em sistemas de informação. Assim, por menor que seja o sistema, a geração de relatórios será um de seus requisitos, sendo que, basicamente, relatórios são compostos pelo design e pelo mapeamento dos dados para os campos existentes em seu layout. Geralmente as linguagens de programação dão suporte a essa tarefa, através do desenvolvimento de ferramentas que auxiliam na construção de relatório para a apresentação de dados. Isto é necessário porque criar relatórios sem estas ferramentas não é uma tarefa simples e requer um grande esforço durante a fase de implementação da aplicação. Para a linguagem de programação Java existem várias ferramentas que facilitam a construção de relatórios para a apresentação de dados. Durante anos a ferramenta Cristal Reports dominou o mercado. Porém, nos últimos anos, novas ferramentas foram desenvolvidas, oferecendo o mesmo pacote de recursos, mas com a vantagem de serem gratuitas, pois a ferramenta citada acima não é. Dentre essas ferramentas, merecem destaque o JasperReports e ireport, pois, além de serem gratuitas, oferecem uma grande quantidade de recursos para o desenvolvimento de relatórios, bem como são facilmente utilizadas dentro do contexto da linguagem de programação Java. O JasperReports é uma biblioteca de classe Java que tem como finalidade a geração de relatórios em aplicações Java. As classes pertencentes a essa biblioteca vêm com um conjunto de métodos que dão suporte ao desenvolvimento do relatório, ficando a cargo do programador desenvolver o projeto do relatório e buscar os dados para o seu preenchimento. Já o ireport é uma ferramenta que tem como finalidade auxiliar a criação do projeto de relatório que será utilizado pela biblioteca JasperReports. O projeto de relatório consiste em um arquivo XML, no qual é definido o design do relatório, assim como a definição do mapeamento dos dados para os campos dentro do layout definido. Esta ferramenta tem uma interface gráfica que torna o desenvolvimento do projeto de

11 12 relatório uma tarefa simples e rápida. Com a utilização da biblioteca JasperReports e da ferramenta ireport é possível, em pouco tempo, desenvolver relatório com qualidade para aplicações Java. O presente trabalho tem a finalidade de expor os conceitos envolvendo a geração de relatório em aplicações Java, utilizando as ferramentas JasperReports e ireport, assim como apresentar os recursos oferecidos por essas duas ferramentas, demonstrando sua utilização através do desenvolvimento de um relatório para uma determinada aplicação desenvolvida na linguagem de programação Java. Para tanto, este trabalho está estruturado da seguinte forma: no capítulo 2 são apresentados os conceitos referentes às ferramentas JasperReports e ireport. No capítulo 3 são apresentados os materiais e métodos utilizados nos estudos das ferramentas e os recursos de hardware e software utilizados para desenvolver esse trabalho. O capítulo 4 apresenta os resultados obtidos com o estudo, assim como a utilização dessas ferramentas. E, por fim, no capítulo 5 são apresentadas as considerações finais acerca deste trabalho.

12 13 2 REVISÃO DE LITERATURA Para que os propósitos desse trabalho fossem atingidos, foram realizados pesquisas e estudos envolvendo conceitos e ferramentas referentes á geração de relatório em aplicações Java. Parte destes estudos foi retirada dos tutoriais disponíveis em (JASPERREPORTS, 2005) e (IREPORT, 2005) e serão apresentados no decorrer dessa seção. Estes estudos são necessários para fornecer uma fundamentação teórica para uma melhor compreensão do objetivo desse trabalho, no que se refere à geração de relatório em aplicações Java, com JasperReports e ireport. 2.1 Geração de Relatório A geração de relatórios em um sistema de informação consiste basicamente na visualização e impressão dos dados manipulados pelo sistema. Esta é a forma que o usuário tem para visualizar os dados armazenados, sejam eles na tela do computador ou em papel impresso. Os relatórios em geral são impressos pelo sistema em formulários contínuos. Este formulário é formado por folhas de papel que estão ligadas entre si. (VILLAS, 1988). No entanto, nem todo relatório será impresso, pois, em muitas situações, somente são utilizados para consulta no próprio sistema de computador. Os dados que são apresentados nos relatórios podem vir de várias origens, sendo mais comum que os dados sejam proveniente de um Sistema de Gerenciamento de Banco de Dados (SGBD). Como exemplos de relatórios podem ser citados: relatório de contas a pagar, relatório de vendas, folha de pagamento de funcionários e vários outros de acordo com o sistema desenvolvido.

13 Organização de um Relatório Um relatório é organizado em três níveis de controle (VILLAS, 1988): nível de relatório, nível de página e nível de campo, sendo que cada nível de controle está dividido em três partes denominadas por: cabeçalho, corpo e rodapé (VILLAS, 1988). Estes níveis serão detalhados abaixo: Nível de Relatório: neste nível são tratadas as informações gerais sobre o relatório gerado. É dividido em três partes: cabeçalho, corpo e rodapé (VILLAS, 1988). cabeçalho: o cabeçalho do nível de relatório corresponde à identificação do sistema, ou seja, o nome do sistema que gerou o relatório: o titulo do relatório. corpo: o corpo deste nível corresponde às páginas do relatório. rodapé: o rodapé deste nível indica a área onde são inseridos os totais gerais de todos os dados apresentados no relatório, e também as informações gerais. Nível de Página: neste nível são tratadas as informações que compõem uma página do relatório. São divididos em três partes: cabeçalho, corpo e rodapé (VILLAS, 1988). cabeçalho: o cabeçalho deste nível é a primeira informação que compõe uma página. Como exemplo de cabeçalho pode-ser citado o título da página. corpo: o corpo deste nível refere-se à área reservada para a apresentação das informações que estão dentro dos campos. Esta área e conhecida como detail (detalhe). rodapé: o rodapé deste nível corresponde à área reservada onde deverão ser inseridos os totais gerais de todos os dados apresentados na página do relatório, e também informações gerais sobre a página. Nível de Campo: cada informação exibida em uma página do relatório é chamada de campo. Um campo pode conter informação de vários tipos de dados, e também são divididos em três partes: cabeçalho, corpo e rodapé (VILLAS, 1988). cabeçalho: o cabeçalho do nível de campo corresponde ao nome do campo. corpo: o corpo do nível de campo corresponde às informações que compõem o campo e que devem ser impressas na página.

14 15 rodapé: o rodapé do nível de campo é a área reservada para apresentação dos totais gerais das informações apresentadas nos campos. 2.2 Geração de Relatórios Utilizando a Linguagem de Programação Java A geração de relatórios está presente na maioria dos sistemas de informação que processam dados. Geralmente as linguagens de programação dão suporte a esta funcionalidade, desenvolvendo ferramentas que auxiliam os programadores na realização desta tarefa. Para a linguagem de programação Java existem ferramentas comerciais como Cristal Reports, que, com o passar do tempo, tornou-se cada vez mais robusto no que diz respeito a novas funcionalidades, com o suporte a diferentes tipos de fontes de dados (PAIXÃO, 2005). Existem também ferramentas e bibliotecas de classes gratuitas, como, por exemplo, JasperReports, que com o auxílio da ferramenta ireport facilitam a criação de relatórios para aplicações Java. As classes da biblioteca JasperReports oferecem um conjunto de métodos que já estão implementadas para criar os relatórios, exigindo do programador apenas a definição do design do relatório, que pode ser criado através do ireport, e a definição dos dados que serão exibidos. A linguagem de programação Java oferece aos programadores a reutilização de classes que já tenham sido implementadas e testadas, ou seja, pode-se construir uma nova classe Java a partir de outras classes. Além das bibliotecas disponibilizadas no J2SDK 1 (kit de desenvolvimento Java), existe uma variedade de classes Java desenvolvidas em vários paises, as quais são disponibilizadas em bibliotecas de classes, organizadas em pacotes. Essas bibliotecas são criadas e utilizadas em aplicações específicas e têm como objetivo ajudar os programadores Java nas tarefas de programação, como, por exemplo: gerar relatório, manipulação de datas e várias outras finalidades. As bibliotecas de classes são fornecidas principalmente por fornecedores de compiladores, mas muitas bibliotecas de classes são fornecidas por fornecedores independes de software (ISV-independent software vendor). Da mesma Forma, muitas bibliotecas de classes estão disponíveis a partir da Internet e da World Wide Web como freeware ou shareware. (DEITEL, 2003). 1 Possui as ferramentas necessárias para o desenvolvimento de aplicações Java. Disponível para download em:

15 16 A reutilização dessas classes é uma prática nova em programação, chamada de desenvolvimento baseado em componentes, que agiliza o processo de desenvolvimento e desta forma, a complexidade no desenvolvimento é reduzida, assim como os custos, através de reutilização de componentes exaustivamente testados (GABRIEL, 2005). Atualmente, JasperReports e ireport vêm se destacando no mercado como ferramentas que geram relatórios para aplicações Java por dois motivos: primeiro, elas dão suporte à geração de relatório de uma forma simples e rápida; segundo, por serem gratuitas. Estas ferramentas serão descritas nas seções seguintes. 2.3 JasperReports O JasperReports 2 é uma biblioteca Java, ou seja, é um conjunto de pacotes compostos por classes Java, desenvolvido por um fornecedor independente chamado JasperSoft 3. Esta biblioteca tem como finalidade à geração de relatório em aplicações Java. A geração de relatório consiste na apresentação de dados armazenados e manipulados por um sistema de informação. JasperReports permite a apresentação desses dados, sejam eles provenientes de um SGBD, collections ou de um arrays de objeto. Para criar um relatório utilizando esta biblioteca é necessária a existência de um projeto de relatório, onde são inseridos e configurados todos os elementos que comporão o relatório: seções, campos, variáveis, parâmetros, expressões, base de dados, imagens e figuras geométricas, gráficos, entre outros. O projeto é definido através de um arquivo desenvolvido segundo os conceitos da extensible Markup Language (XML), através da especificação de tags XML e expressões Java. Para gerar um relatório utilizando essa biblioteca é necessário passar pelos seguintes processos: processo de compilação, preenchimento e visualização em um formato definido. Todos estes processos são realizados por classes pertencentes à própria biblioteca JasperReports. O processo de compilação consiste na verificação das tags XML e das expressões Java contidas no projeto do relatório. É realizado pela classe net.sf.jasperreports.engine.jaspermanag, disponível na biblioteca JasperReports, 2 Disponível para download em: 3 Mais informação sobre o jaspesorft é encontrado em:

16 17 através do método compilerepor, que retorna um objeto.jasper que pode ser salvo em disco com a extensão.jasper. O objeto jasper é o relatório propriamente dito, pronto para receber os dados e parâmetros. O processo de preenchimento consiste na alimentação do relatório com os dados recuperados de uma origem. A função de preenchimento é realizada pela classe sf.jasperreportss.engine.jaspermanager, através do método JasperFillManager.fillReport, que recebe: o objeto gerado no processo de compilação jasper, parâmetros, conexão com banco de dados ou resultset. Este último corresponde a um objeto gerado a partir da execução de métodos de conexão e recuperação de dados próprios da linguagem utilizada que, no caso da linguagem de programação Java, utiliza o à biblioteca de classe java.sql.*, para fazer conexões com banco de dados. Após passar por todos esses processos, o relatório estará pronto para ser visualizado na tela do computador, salvo em disco, impresso ou ser exportado para vários formatos: pdf, html, xsl, csv, xml. O relatório é apresentado em uma interface gráfica, o JasperViewer, que é uma classe da biblioteca JasperReports, ou em outros formatos suportado pela biblioteca. A Figura 1 ilustra o funcionamento da biblioteca JasperReports, os processos necessários para a criação, preenchimento e apresentação do relatório. Figura 1: Funcionamento da biblioteca JasperReports. (JASPERREPORTS, 2005).

17 Projeto do Relatório O projeto do relatório é definido por um arquivo XML, onde será especificado o design do relatório, assim como será definido o mapeamento dos dados para os campos dentro do layout do relatório. Neste arquivo são inseridas as seções, a localização dos campos, variáveis, a base de dados, linhas, imagens, figuras geométricas, dentro de uma seção. O projeto de relatórios é definido em um arquivo XML através de tags XML que obedecem a uma estrutura, vocabulário e restrições declarados em um Document Type Definition (DTD), denominado JasperReports.dtd (JASPERREPORTS, 2005). Esse arquivo passa por um processo de compilação dando origem a um objeto jasper que pode ser salvo em disco com a extensão.jasper. A Figura 2 apresenta o código para um exemplo de projeto de relatório. 1. <?xml version="1.0"?> 2. <!DOCTYPE jasperreport PUBLIC "-//JasperReports//DTD Report Design//EN" " 3. <jasperreport name="relatorio"... > </jasperreport> Figura 2: Exemplo de um projeto do relatório. (JASPERREPORTS, 2005). Na linha 1 (da Figura 2) é definido o cabeçalho XML, especificando a versão utilizada no arquivo. A linha 2 é indicado o DTD que estrutura o arquivo XML (JasperReports.dtd) da biblioteca JasperReports e na linha 3 apresenta a tag de abertura do relatório e na linha 4 a tag de fechamento correspondente.

18 Origem dos Dados Para a construção de um relatório é necessária a existência de uma origem de dados para que o relatório possa ser preenchido com os dados provenientes desta origem. A biblioteca JasperReports dá sustentação a vários tipos de origem de dados e usa uma relação chamada JRDataSource, que é uma representação abstrata de uma origem dos dados de JasperReports (JASPERREPORTS, 2005). Os dados podem ser provenientes de um SGBD, collections ou de um arrays de objetos. O mais comum é que os dados do relatório sejam provenientes de um SGBD, podendo ser passados para o relatório através de uma conexão ou um Resultset, que é um objeto gerado pela execução de uma instrução SQL, e contém dados extraídos de uma fonte de dados. A Figura 3 apresenta o código para um exemplo de passagem de um objeto resultset para operação de preenchimento do relatório através de uma classe Java. 1.JRResultSetDataSource jrrs = new JRResultSetDataSource(result); 2.JasperPrint impressao = JasperFillManager.fillReport(layoutJarper,parametros,jrRS ); Figura 3: Passagem de um objeto resultset para o relatório, através de uma classe Java. Na linha 1 (da Figura 3), é realizada a conversão de um objeto resultset, gerado por uma instrução SQL, para um formato entendido pela biblioteca através da classe JRResultSetDataSorce. Já na linha 2 é realizada a operação de preenchimento, que deve conter o projeto compilado, parâmetros e o resultset convertido Campos Somente por meio dos campos definidos dentro do layout do relatório é que se pode apresentar os dados provenientes de uma determinada origem. Se a origem dos dados for

19 20 um resultset, os campos do relatório devem relacionar as colunas correspondentes ao objeto resultset, ou seja, devem ter o mesmo nome e o mesmo tipo que as colunas do objeto. A Figura 4 apresenta o código para um exemplo de campo dentro do projeto do relatório. 1. <field name="codigo" class="java.lang.integer"/> 2. <field name="nome_cidade" class="java.lang.string"/> 3. <field name="data" class="java.util.date"/> Figura 4: Código de criação de um campo. (JASPERREPORTS, 2005). Na linha 1 (da Figura 4) é definida a tag de criação de um campo dentro do projeto do relatório, contendo as seguintes configurações: name = código e o tipo de dados que este campo suporta, ou seja, do tipo Integer. Da mesma forma, a linha 2 e 3 definem outros campos a serem apresentados neste relatório de exemplo Expressões As expressões permitem a utilização de elemento da linguagem Java dentro do projeto de relatório. São utilizadas para especificar o conteúdo de campos de texto, na realização de cálculos freqüentes, por exemplo. Todas elas são expressões Java que podem conter em sua sintaxe: campos, parâmetros e variáveis de relatório (PAIXÃO, 2005). A Figura 5 apresenta o código para um exemplo de criação de uma expressão dentro do projeto. 1. <textfieldexpression> 2. Sr.(a) + $F{Cliente} + " realizou um total de compras no valor de " + $V{ValorTotalCompraSum} + " no dia " + (new SimpleDateFormat("dd/MM/yyyy")).format($F{DataCompra}) + "." 3. </textfieldexpression> Figura 5: Código de criação de uma expressão. (JASPERREPORTS, 2005).

20 21 Na linha 1 (da Figura 5) é definida a tag de abertura de uma expressão dentro de um campo do projeto do relatório. Já na linha 2 é criada a expressão com os campos: Cliente, DataCompra e uma variável ValorTotalCompraSum. A linha 3 é apresenta a tag de fechamento da expressão Variáveis As variáveis podem ser usadas para simplificar o projeto do relatório. Através de uma variável é possível declarar somente uma expressão, que pode ser usada durante todo o projeto do relatório para armazenar o resultado de cálculos, tais como: contagem, soma, menor, maior e vários outros. Uma variável deve conter uma expressão para executar cálculos, assim como um campo ou um conjunto de campos do relatório sobre os quais os cálculos serão realizados. A Figura 6 apresenta o código para um exemplo de criação de uma variável dentro do projeto. 1. <variable name="quantitysum" class="java.lang.double" resettype="page" calculation="sum"> 2. <variableexpression>$f{quantity}</variableexpression> 3. <initialvalueexpression>new Double(0) 4. </initialvalueexpression> 5. </variable> Figura 6: Código de criação de uma variável. (JASPERREPORTS, 2005) Na linha 1 (da Figura 6) é definida a tag de abertura para a definição de uma variável dentro do projeto do relatório contendo as seguintes configurações: name = QuantitySum nome da variável, class = Java.lang.Double indica que a variável conterá dados do tipo Double, resetype = Page nível que é executada a operação de cálculo, ou seja, calcula os valores contidos em cada página separadamente, e o tipo de cálculo definido por calculation = Sum, significa que será executada uma soma com os valores do campo QuantitySum. A linha 2 é mostrada a tag de abertura da expressão dae

21 22 uma variável, que contém o campo que será calculado. Já na linha 3 é especificada a tag de abertura do valor de inicialização da expressão. Na linha 4 é apresentada a tag de fechamento da inicialização da expressão e, na linha 5, por sua vez, a tag de fechamento da variável Seções do Relatório Um relatório é composto por páginas que recebem os dados a serem apresentados. As páginas são divididas em seções, tais como: background: esta seção é usada para definir uma cor de fundo para as páginas do relatório. title: esta seção corresponde ao cabeçalho do relatório. É impresso somente uma vez e na primeira página do relatório. pageheader: esta seção corresponde ao cabeçalho de uma página. É impresso em cada página. columnheader: esta seção corresponde ao cabeçalho da coluna de uma página. É impresso em cada página que contém uma seção detail. Se uma página for dividida em uma ou mais colunas, esta seção será impressa em cada coluna da página. detail: esta seção corresponde ao corpo de uma página; nela são impressos os dados recuperados de uma fonte de dados através dos campos. columnfooter: esta seção corresponde ao rodapé da coluna de uma página. É impresso em cada página que contém uma seção detail. Se uma página for dividida em uma ou mais colunas, esta seção é impressa em cada coluna da página. pagefooter: esta seção corresponde ao rodapé de uma página E é impressa em cada página do relatório. summary: esta seção corresponde ao rodapé do relatório. É impressa somente uma vez, no fim do relatório, podendo ser impressa em uma página separada. As seções são parte de uma página do relatório que tem uma altura e uma largura especificadas, e pode conter objetos do relatório como linhas, retângulos, imagens, campos

22 23 de texto, variáveis entre outros. A Figura 7 apresenta o código exemplo para a criação de uma seção dentro do projeto, assim como suas configurações e objetos inseridos. 1. <pageheader> 2. <band height="30"> 3. <statictext> 4. <reportelement x="0" y="0" width="555" height="25"/> 5. <textelement textalignment="center"> 6. <font fontname="helvetica" size="18"/> 7. </textelement> 8. <text>texto do elemento de texto</text> 9. </statictext> 10. </band> 11. </pageheader> Figura 7: Código de criação de uma seção. (JASPERREPORTS, 2005) Na linha 1 (da Figura 7) é definida a tag de criação de uma seção pageheader. A linha 2 é apresenta a tag que configura o tamanho de uma seção dentro da página. Já na linha 3 é especificada a tag para a criação de um elemento de texto dentro de uma seção. Na linha 4 é definida a tag que especifica a posição e o tamanho do elemento de texto dentro da seção. A linha 5 apresenta a tag de configuração do elemento de texto dentro da seção. Já na linha 6 é definida a tag de configuração da fonte do elemento de texto da seção e na linha 7 e fechada a tag de configurações do elemento de texto. A linha 8 apresenta a tag de abertura e inserção do texto, assim como a tag de fechamento do texto do elemento de texto. Na linha 9 o elemento de texto tem sua tag fechada. Nas linhas 10 e 11 é apresentada a tags de fechamento da configuração do tamanho que a seção ocupará na página e do fechamento da seção dentro do projeto do relatório Parâmetros Os paramentos são referências passadas ao relatório nas operações de preenchimento. Com isso o relatório torna-se dinâmico, pois é possível passar dados que não estão presentes na origem de dados para o relatório. Uma forma de utilização dos parâmetros é usá-los para mudar dinamicamente uma instrução SQL, em tempo de execução do relatório, como, por exemplo: select * from funcionário where nome = $P!{nome} (PAIXÃO, 2005).

23 24 Também podem ser usadas para a passagem de títulos, imagens e outras. A Figura 8 apresenta o código exemplo para a criação de um parâmetro dentro do projeto do relatório. 1. <parameter name="titulo" class="java.lang.string"/> 2. <parameter name="codigo" class="java.lang.integer"/> 3. <parameter name="imagem" class="java.awt.image"/> Figura 8: Código de criação de um parâmetro. (JASPERREPORTS, 2005) Na linha 1 (da Figura 8) é definida a tag de criação de um parâmetro dentro do projeto, contendo as seguintes configurações: name = Titulo, define o nome do parâmetro, classe = Java.lang.String, define o tipo de dados que este campo suporta no caso String. Da mesma forma, as linhas 2 e 3 definem outros campos a serem apresentados neste relatório Principais Classes da Biblioteca JasperReports Um relatório é gerado através de classes pertencentes a bibliotecas JasperReports, tendo como base o projeto do relatório e cada classe tem uma função específica. As principais classes da biblioteca JasperReports, assim como suas funções, serão descritas a seguir: net.sf.jasperreports.engine.jaspermanager: responsável por fazer a compilação do projeto, que consiste na verificação das tags XML e expressões Java nele contidas que obedecem as regras e restrições do jasperreports.dtd da biblioteca. net.sf.jasperreports.engine.design.jasperdesign: responsável pela construção do design do relatório, com base no que foi definido no projeto. net.sf.jasperreports.engine.jasperreports: representa o design do relatório com seus objetos: campos, variáveis, parâmetros, imagens, figuras geométricas e outras, deixando assim o relatório pronto para preenchimento das informações a partir da base de dados.

24 25 net.sf.jasperreports.engine.jasperprint: esta classe permite ver o preenchimento completo do relatório nos mais diferentes formatos: pdf, html, xsl, csv, xml, conforme for definido. net.sf.jasperreports.view.jasperviewer: responsável pela exibição do relatório preenchido em uma interface gráfica chamada JasperViewer. Contém uma interface para a exibição dos dados do relatório na tela do computador com a opção de importar o relatório preenchido para os formatos suportados pelo JasperReports. 2.4 ireport Desenvolver projetos de relatório para a biblioteca JasperReports é uma tarefa que exige conhecimento em XML, assim como das regras e tags definidas no DTD (JasperReports.dtd) da biblioteca JasperReports que estrutura o documento XML e que representa o projeto do relatório. Esse foi um dos problemas que, no início, tornava inviável a utilização da biblioteca JasperReports, pois para um programador desenvolver um projeto de relatório utilizando a biblioteca, era necessário o conhecimento da linguagem XML e das regras contida no DTD da biblioteca JasperReports (JasperReports.dtd) (PAIXÃO, 2005). Para resolver esse problema foram criadas ferramentas GUI (Interface Gráfica com Usuário) para o desenvolvimento do projeto do relatório e suas configurações. Existem várias ferramentas que oferecem uma interface gráfica para o desenvolvimento do projeto de relatório para a biblioteca JasperReports, sendo que o ireport é uma dessas. O ireport 4 é um programa desenvolvido totalmente em Java, e tem como finalidade desenvolver projetos de relatórios de uma forma simples e rápida, através de uma interface gráfica. Assim, sem ter nenhum conhecimento em XML e das regras definidas em seu DTD, o usuário pode criar projetos de relatório utilizando a interface gráfica do ireport, além de criar os projetos de relatórios. Também é permitida a visualização do relatório e realização de testes antes de utilizá-lo em uma aplicação. O que diferencia o ireport de outras ferramentas, que têm como finalidade oferecer uma interface gráfica para a construção do projeto de relatório para a biblioteca JasperReports, é que o ireport é de fácil utilização e, além de tudo, é gratuito.

25 Criação de Projetos de Relatórios com ireport Para criar um projeto de relatório com o ireport é necessário executá-lo através do ireport.bat, acionar o menu Arquivo, novo documento, que um novo projeto será criado, pronto para ser configurado e inseridos os elementos que compõem um relatório. A Figura 9 apresenta a tela principal do ireport, (menu Arquivo, Novo Documento ). Figura 9: Tela principal do ireport - Menu Arquivo Ao acionar o menu Arquivo, novo documento, será exibida uma tela de criação e configurações iniciais do projeto de relatório, com: nome do relatório, tamanho das páginas do relatório e outras. A Figura 10 apresenta a tela de criação de um projeto do relatório com as configurações iniciais. 4 Disponível para download em:

26 27 Figura 10: Tela de configuração inicial do projeto do relatório Origem dos Dados com ireport Para criar um relatório é necessária a definição de uma origem de dados para o seu preenchimento. A Figura 11 apresenta a tela onde se pode configurar a origem dos dados no ireport (menu Fonte de Dados, Conexão / Fonte de Dados ). Figura 11: Tela principal, menu fonte de dados

27 28 Ao acionar o menu Fontes de Dados, Conexão / Fonte de Dados, serão abertas as telas de criação e configuração da origem de dados do projeto de relatório, onde é possível escolher o tipo de origem e a fonte de dado do relatório. Nesta mesma área é possibilitado realizar o teste da conexão criada. A Figura 12 apresenta as telas de criação e configuração de uma fonte de dados no ireport. Figura 12: Telas de criação e configuração e teste de uma fonte de dados Criação de Parâmetros com ireport Os parâmetros são usados para passagem de valores ao relatório que não estão presentes na origem dos dados, isso atribui ao relatório uma maior dinamicidade. A Figura 13 apresenta a tela principal do ireport, (menu Visualizar, Parâmetros do Relatório ).

28 29 Figura 13: Tela principal do ireport, menu visualizar Ao acionar o menu Visualizar, Parâmetros do Relatório, serão exibidas as telas de criação de parâmetros. Cada parâmetro possui um nome e um tipo de dados que ele suporta, assim como um valor opcional de inicialização. A Figura 14 apresenta as telas de criação de parâmetros com ireport. Figura 14: Telas de criação e configuração de parâmetros

29 Criação de Campos com ireport Somente através da definição dos campos é que se pode relacionar os dados de uma fonte para o layout do relatório. Para um campo receber os valores de uma coluna de uma tabela, ele deve ter o mesmo nome e o mesmo tipo de dados da coluna. A Figura 15 apresenta a tela principal do ireport, (menu Visualizar, Campos do Relatório ). Figura 15: Tela principal, menu Visualizar, Campos do Relatório Ao acionar o menu Visualizar, Campos do Relatório, serão apresentadas as telas de criação e configuração de campo dentro do projeto, onde cada campo terá um nome e um tipo de dados que ele suporta e a seção em que ele está localizado. A Figura 16 apresenta as telas de criação e configuração dos campos com ireport.

30 31 Figura 16: Telas de criação e configuração de campo do projeto Criação de Variáveis com ireport As variáveis são usadas para simplificar o projeto de relatório, possibilitando a efetuação de cálculos em um campo, onde o resultado desse cálculo é armazenado na mesma variável, com o auxilio de uma expressão. A Figura 17 tela principal do ireport, (menu Visualizar, Variáveis do Relatório ). Figura 17: Tela principal, menu Visualizar, Variáveis do Relatório

31 32 Ao acionar o menu Visualizar, Variáveis do Relatório, serão apresentadas as telas de criação e configuração das variáveis no ireport, onde será definido um nome, um tipo de dados e, uma expressão para a variável criada. A Figura 18 apresenta as telas de criação e configuração de uma variável com ireport. Figura 18: Telas de criação e configuração de variável Criando Expressões com ireport As expressões podem ser criadas em um campo, em um parâmetro, em uma variável ou em campos estáticos do relatório. A Figura 19 apresenta a criação de uma expressão dentro de uma variável no ireport.

32 33 Figura 19: Tela de criação e configuração de uma variável. Uma expressão é criada dentro de uma variável através do campo = variable expression do formulário de criação da variável Seções com ireport Um relatório é composto por páginas, uma página é dividida em seções, ou seja, uma seção é parte de uma página e possui altura e largura especificada e pode conter elementos do relatório como: linhas, retângulos, imagens ou campos do texto, variáveis, parâmetros e outros. Uma página de relatório pode conter as seguintes seções: backgroun, title, pageheader, columnheader, detail, groupfooter, columnfoter, pagefooter, summary. A Figura 20 apresenta uma página do relatório dividida em seções no ireport.

33 34 Figura 20: Tela principal, página do projeto dividas em seções Testando e Visualizando o Projeto de Relatório com ireport Após ter criado o projeto do relatório com ireport, é possível testar e visualizar o relatório antes de usá-lo em uma aplicação. Para testar e visualizar o relatório gerado, é preciso compilar e executar o projeto do relatório, onde é possível visualizar o relatório preenchido com os dados e também obter o arquivo com extensão.jasper que será salvo em disco. A Figura 21 apresenta a tela principal do ireport, (menu Criar (build)), (Executar relatório (usar uma conexão ativa) ).

34 35 Figura 21: Tela principal Ao acionar o menu Criar (build), Executa relatório (usando uma conexão ativa), o projeto será compilado, executado e visualizado no formato definido. A Figura 22 apresenta a visualização do relatório na interface gráfica JasperViewer da biblioteca JasperReports, com ireport. Figura 22: Visualização do relatório na interface JasperViewer

35 Código Gerado com IREPORT Quando o projeto do relatório é salvo no disco é gerado um arquivo com extensão.jrxml, que corresponde ao projeto do relatório, ou seja, o arquivo XML que obedece as regras e às restrições do (JasperReports.dtd). O projeto pode ser também compilado, a fim de gerar o arquivo com extensão.jasper, que será salvo no disco e estará proto para receber parâmetros e dados na operação de preenchimento do relatório.

36 37 3 MATERIAIS E MÉTODOS Para o desenvolvimento desse trabalho foram utilizados diversos recursos bibliográficos, além de hardware e software, que aliados às orientações permitiram a finalização do mesmo. 3.1 Local e Período Este trabalho foi desenvolvido durante o segundo semestre de 2005, como parte da disciplina: Estágio Supervisionado em Sistema de Informação. Os locais utilizados para sua elaboração foram os laboratórios de informática do curso de Sistemas de Informação, sendo que os mais utilizados foram os Laboratórios de Informática (Labin I) e (Labin III) do Centro Universitário Luterano de Palmas. 3.2 Materiais Os recursos utilizados para o desenvolvimento do trabalho foram disponibilizados pelo próprio curso, Sistemas de Informação do CEULP/ULBRA em seus laboratórios, tais como hardware e software licenciados. As demais ferramentas free foram adquiridas via Internet Fontes Bibliográficas Publicações Científicas; Artigos; Site do JASPERREPORTS (JASPERREPORTS, 2005); Site do IREPORT (IREPORT, 2005); Sites diversos.

37 Hardware Pentium III, 750 Mhz e 128 Mb de RAM (Disponível no laboratório); Pentium IV, 2.4 Ghz e 256 Mb de RAM (Disponível no laboratório); Software Microsoft Windows 2000 Professional; Microsoft Office 2000 Professional; Internet Explorer 6.0; Acrobat Reader 7.0; IREPORT 0.5.0; JASPERREPORTS 0.6.0; JCreatorV3 LE Instalação e Configuração das Ferramentas Esta seção visa auxiliar os desenvolvedores Java que queiram utilizar a biblioteca JasperReports e a ferramenta ireport para a geração de relatório em suas aplicações. Para tanto, as instruções de instalação e configurações das ferramentas: J2SE 1.5.0, ireport e JasperReports são descritas, passa a passo, com ilustrações Instalação e Configuração do J2SE Para programar em Java é preciso fazer o download do J2SE (Java 2 Platform Standard Edition 1.5.0) 5, ou outras versões. O J2SE corresponde à plataforma de desenvolvimento Java e vem com dois ambientes: 5 Disponível para download em:

38 39 J2SDK 1.5.0: é o kit de desenvolvimento Java que contém as ferramentas necessárias para programar na linguagem Java, contendo: compilador (javac), interpretador (java), documentação (javadoc), bibliotecas de classes Java e outras ferramentas. J2RE 1.5.0: possui ferramentas para tornar possível a execução de programas Java em um computador. Para configurar o J2SE em um sistema operacional é necessário criar variáveis de ambiente: JAVA_HOME, CLASSPATH, PATH. Essas variáveis são necessárias para a utilização de todos os recursos do J2SE 1.5.0, como: javac (compilador Java), javadoc (gerador de documentação das classes Java), java (interpretador dos batycody Java) e vários outros. Para criar variável de ambiente no sistema operacional Windows 2000 é necessário seguir os seguintes passos: Meu computador, Propriedades, Avançado, Variáveis de ambiente. A Figura 23 apresenta a tela Propriedades do Sistema Operacional Windows Figura 23: Tele de propriedades do sistema Windows 2000.

39 40 Ao ser acionando o botão variáveis de ambiente serão apresentadas as telas de criação e configuração das variáveis de ambiente no Windows A Figura 24 apresenta a tela de criação e configuração destas variáveis. Figura 24: Tele de criação e configuração das variáveis de ambiente. Para criar variável de ambiente do usuário, é preciso acionar o botão Nova, que será apresentada a tela de criação das variáveis do usuário, onde são atribuídos um nome e um valor para a variável. A variável JAVA_HOME deve conter os seguintes valores: nome = JAVA_HOME e valor = C:\j2sdk A Figura 25 ilustra a criação da variável de ambiente do usuário JAVA_HOME no Windows 2000.

40 41 Figura 25: Tela de criação de uma variável de ambiente do usuário. A variável de ambiente do usuário CLASSPATH deve conter os seguintes valores: nome = CLASSPATH e valor =.:JAVA_HOME. A Figura 26 ilustra a criação da variável de ambiente do usuário CLASSPATH e seus respectivos valores.

41 42 Figura 26: Tela de criação da variável de ambiente do usuário O próximo passo é definir a variável de ambiente do usuário PATH, que deve conter os seguintes valores: nome = PATH e valor = C:\j2sdk1.5.0\bin. A Figura 27 ilustra a criação da variável de ambiente PATH e seus respectivos valores.

42 43 Figura 27: Tela de criação da variável de ambiente do usuário Instalação e Configuração do IReport O ireport é uma ferramenta que possibilita a criação do projeto de relatório para a biblioteca JasperReports, através de uma interface gráfica. Sua instalação consiste na descompactação dos arquivos adquiridos na página web do ireport em uma determinada pasta. Necessita que o J2SE esteja instalado no computador onde ele será executado. Para configurar o ireport é necessário executá-lo através do ireport.bat no Windows e ireport.sh no LINUX, acionar o menu tool, opções, onde será exibida a tela de configuração. Na aba External Programs deve-se configurar da mesma forma que está configurado na figura abaixo. A Figura 28 ilustra a configuração do ireport.