JasperReports 3.5 for Java Developers - David R Heffelfinger - E-Book

JasperReports 3.5 for Java Developers E-Book

David R. Heffelfinger

0,0
34,79 €

-100%
Sammeln Sie Punkte in unserem Gutscheinprogramm und kaufen Sie E-Books und Hörbücher mit bis zu 100% Rabatt.

Mehr erfahren.
Beschreibung

Do you want to create easily understood, professional, and powerful reports from disordered, scattered data using a free, open source Java class library? If your answer is yes, this book on JasperReports is what you are looking for. JasperReports is the world's most popular embeddable Java open source reporting library, providing Java developers with the power to easily create rich print and web reports.
The book has been fully updated to use JasperReports 3.5, the latest version of JasperReports. Previously accepted techniques that have now been deprecated have been replaced with their modern counterparts. All examples in the book have been updated to use XML schemas for report templates. Coverage of new data sources that JasperReports now supports has been added to the book. Additionally, JasperReports can now export reports to even more formats than before and exporting reports to these new formats is covered in this new edition of the book.
This book shows you exactly how to get started, and develop the skills to get the most from JasperReports. It introduces you to the latest version of JasperReports, and gets you creating complex and elegant reports.
The book steers you through each point of report setup, to creating, designing, formatting, and exporting reports with data from a wide range of data sources, and integrating JasperReports with other Java frameworks.
Starting with the basics of adding reporting capabilities to your application and creating report templates, you will first see how to produce your reports through the use of JRXML files, custom ANT targets, and then preview them in both the web browser and the native browser of JasperReports.
Getting data into your reports is the next step, and you will see how to get data from a range of data sources, not only databases, but XML files, and Java Objects, among others.
You will create better looking reports with formatting and grouping, as well as adding graphical elements to your reports. You will export your reports to a range of different formats, including PDF and XML.
Creating reports will be made even easier with a walkthrough of the iReport Designer visual designing tool. To round things off, you will see how to integrate your reports with other Java frameworks, using Spring or Hibernate to get data for the report, and Java Server Faces or Struts for presenting the report.
All examples have been updated to use XML schemas. New export formats, such as OpenDocument Text, and new data sources now supported by JasperReports are now covered in this updated edition.

Das E-Book können Sie in Legimi-Apps oder einer beliebigen App lesen, die das folgende Format unterstützen:

EPUB

Seitenzahl: 304

Veröffentlichungsjahr: 2009

Bewertungen
0,0
0
0
0
0
0
Mehr Informationen
Mehr Informationen
Legimi prüft nicht, ob Rezensionen von Nutzern stammen, die den betreffenden Titel tatsächlich gekauft oder gelesen/gehört haben. Wir entfernen aber gefälschte Rezensionen.



Table of Contents

JasperReports 3.5 for Java Developers
Credits
About the Author
About the Reviewers
Preface
What this book covers
What you need for this book
Who this book is for
Conventions
Reader feedback
Customer support
Errata
Piracy
Questions
1. An Overview of JasperReports
A brief history of JasperReports
What exactly is JasperReports?
The features of JasperReports
Flexible report layout
Multiple ways to present data
Multiple ways to supply data
Multiple datasources
Watermarks
Subreports
Exporting capabilities
Class library dependencies
Typical workflow
Where to get help
Summary
2. Adding Reporting Capabilities to our Java Applications
Downloading JasperReports
Setting up our environment
JasperReports class library
Required libraries for report compilation
Apache Commons
Apache Commons Digester
Apache Commons Collections
Apache Commons Logging
Apache Commons BeanUtils
Optional libraries and tools
Apache ANT
JDT compiler
JDBC driver
iText
JFreeChart
JExcelApi
Summary
3. Creating your First Report
Creating a JRXML report template
Previewing the XML report template
Creating a binary report template
Compiling a JRXML template programmatically
Previewing the compiled report template
Compiling a JRXML template through ANT
Generating the report
Viewing the report
Displaying reports in a web browser
Elements of a JRXML report template
<property>
<import>
<template>
<style>
<subDataset>
<parameter>
<queryString>
<field>
<sortField>
<variable>
<filterExpression>
<group>
<background>
<title>
<pageHeader>
<columnHeader>
<detail>
<columnFooter>
<pageFooter>
<lastPageFooter>
<summary>
<noData>
Summary
4. Creating Dynamic Reports from Databases
Database for our reports
Generating database reports
Embedding SQL queries into a report template
Generating the report
Modifying a report query through report parameters
Database reporting through a datasource
A comparison of database report methods
Summary
5. Working with Other Datasources
Empty datasources
Map datasources
Java objects as datasources
TableModels as datasources
XML datasources
CSV datasources
Custom datasources
Writing a custom JRDataSource implementation
Using the custom JRDataSource implementation
Summary
6. Report Layout and Design
Controlling report-wide layout properties
Setting text properties
Styles
Reusing styles through style templates
Setting text style for individual report elements
Using markup to style text
Styled text
HTML
Rich Text Format
Setting a report's background
Report expressions
Adding multiple columns to a report
Final notes about report columns
Grouping report data
Report variables
Built-in report variables
Stretching text fields to accommodate data
Laying out report elements
Setting the size and position of a report element
Setting common element properties
Hiding repeated values
Subreports
Summary
7. Adding Charts and Graphics to Reports
Adding geometrical shapes to a report
Adding lines to a report
Adding rectangles to a report
Adding ellipses to a report
Adding images to a report
Attributes of the <image> element
evaluationTime
evaluationGroup
hAlign
vAlign
IsLazy
isUsingCache
onErrorType
Adding charts to a report
Attributes of the <chart> element
customizerClass
evaluationGroup
evaluationTime
isShowLegend
Chart customization
Chart datasets
Attributes of the <dataset> element
incrementType
incrementGroup
resetType
resetGroup
Plotting charts
Attributes of the <plot> element
backcolor
backgroundAlpha
foregroundAlpha
orientation
Pie charts
Bar charts
XY line charts
Other types of charts
Summary
8. Other JasperReports Features
Report localization
Scriptlets
Crosstabs
Crosstab subelements
<columnGroup>
<crosstabCell>
<crosstabDataset>
<crosstabParameter>
<measure>
<parametersMapExpression>
<reportElement>
<rowGroup>
<whenNoDataCell>
Subdatasets
Adding hyperlinks and anchors to reports
Turning chart items into hyperlinks
Bookmarks
Handling very large reports
Summary
9. Exporting to Other Formats
Exporting overview
Exporting to PDF
Exporting to RTF
Exporting to ODT
Exporting to Excel
Exporting to HTML
Exporting to XML
Exporting to CSV
Exporting to plain text
Directing HTML reports to a browser
Summary
10. Graphical Report Design with iReport
Obtaining iReport
Setting up iReport
Creating a database report in record time
Tweaking the generated report
Creating a report from scratch
Creating more elaborate reports
Adding images to a report
Adding multiple columns to a report
Grouping report data
Adding charts to a report
Help and support
Summary
11. Integrating JasperReportswith Other Frameworks
Integrating JasperReports with Hibernate
Integrating JasperReports with JPA
Integrating JasperReports with Spring
Integrating JasperReports with JSF
Integrating JasperReports with Struts
Summary
Index

JasperReports 3.5 for Java Developers

David Heffelfinger

JasperReports 3.5 for Java Developers

Copyright © 2009 Packt Publishing

All rights reserved. No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews.

Every effort has been made in the preparation of this book to ensure the accuracy of the information presented. However, the information contained in this book is sold without warranty, either express or implied. Neither the author, nor Packt Publishing, and its dealers and distributors will be held liable for any damages caused or alleged to be caused directly or indirectly by this book.

Packt Publishing has endeavored to provide trademark information about all of the companies and products mentioned in this book by the appropriate use of capitals. However, Packt Publishing cannot guarantee the accuracy of this information.

First published: August 2009

Production Reference: 1050809

Published by Packt Publishing Ltd.

32 Lincoln Road

Olton

Birmingham, B27 6PA, UK.

ISBN 978-1-847198-08-2

www.packtpub.com

Cover Image by Parag Kadam (<[email protected]>)

Credits

Author

David R. Heffelfinger

Reviewers

Allan Bond

BalaKishore G. Pamarti

T. David Hoppmann, Jr

Thomas M. Ose

Acquisition Editor

Douglas Paterson

Development Editor

Amey Kanse

Technical Editor

Ishita Dhabalia

Copy Editor

Sanchari Mukherjee

Editorial Team Leader

Gagandeep Singh

Project Team Leader

Priya Mukherji

Project Coordinators

Ashwin Shetty

Neelkanth Mehta

Indexer

Hemangini Bari

Proofreaders

Jade Schuler

Laura Booth

Production Coordinator

Adline Swetha Jesuthas

Cover Work

Adline Swetha Jesuthas

About the Author

David Heffelfinger is the Chief Technology Officer of Ensode Technology, LLC, a software consulting firm based in the greater Washington DC area. He has been professionally designing and developing software since 1995. David has been using Java as his primary programming language since 1996, and has worked on many large scale projects for several government and commercial clients, including IBM, Verizon, the US Department of Homeland Security, Freddie Mac, Fannie Mae, and the US Department of Defense.

David is the author of JavaEE 5 Development Using GlassFish Application Server and Java EE 5 with NetBeans 6 and JasperReports For Java Developers, both by Packt Publishing.

David has a Masters degree in Software Engineering from Southern Methodist University. David is the Editor in Chief of Ensode.net (http://www.ensode.net), a web site about Java, Linux, and other technology topics.

I would like to thank everyone who has helped to make this book a reality. I would like to thank the Development Editor, Amey Kanse; the Project Coordinators, Ashwin Shetty and Neelkanth Mehta; the Technical Editor, Ishita Dhabalia; the Acquisition Editor, Douglas Paterson, and everyone else at Packt Publishing for giving me the opportunity to update this book.

I would also like to thank the Technical Reviewers Allan Bond, BalaKishore G. Pamarti, David Hoppmann, and Thomas M. Ose for their insightful comments and suggestions.

Additionally, I would like to thank Teodor Danciu, JasperSoft, and all the JasperReports contributors for creating an outstanding reporting library.

Finally, I would like to thank my wife and daughter for putting up with the long hours of work that kept me away from the family.

About the Reviewers

Allan Bond is a software developer who has been active in the IT industry for 10 years. His primary focus is the development of both frontend and backend systems using Java and related technologies. He has worked and consulted for a variety of organizations ranging from small businesses to Fortune 500 companies, and government agencies. Allan holds a Masters degree in Information Systems Management from Brigham Young University.

BalaKishore G. Pamarti is working in St. Jude Children's Research Hospital's Clinical Informatics Department as a Programmer Analyst for the past five years. It's a non-profit organization supporting all the software systems in the patient care area. Before joining St. Jude, BalaKishore did his Masters in Engineering Technology at the University of Memphis and a Bachelors from the JNTU College of Engineering, Hyderabad in Civil Engineering.

He lives with his wife and they both love hiking and exploring new places!

T. David Hoppmann, Jr is the DBA and lead report developer for Monolith Software Solutions, an open source business intelligence and data warehousing solution for restaurateurs. He graduated from the College of Charleston in his hometown of Charleston, SC with degrees in Computer Science and Computer Information Systems. He is also an active member of the Charleston, SC Linux Users Group (CSCLUG).

Thomas M. Ose has been actively involved in computer and Information Technologies for the past 30 years. He has seen computer and software trends and technology mature over various industries including manufacturing, office automation, and communication sectors. Over the years, Thomas has been a programmer, consultant, and manager for various industries, and has become proficient in many languages and disciplines including C, C++, C#, PHP, JAVA, XML, and UML. He prides himself at always learning something new and developing applications and solutions at the cutting edge of technology and the industry. Thomas is currently the President of his own consulting company, Ose Micro Solutions, Inc. specializing in electronic B2B, G2B system for the Uniform Commercial Code and Business Registration systems for state and local governments. For his solutions, he utilizes PHP, JAVA, and C# to provide web service and browser-based solutions using XML to file regulatory documents at state and local governments. He has developed many national standards in this area and spoken at numerous trade conventions.

Preface

If you want to create easily understood, professional, and powerful reports from disordered, scattered data using a free, open source Java class library, this book on JasperReports is what you are looking for. JasperReports is the world's most popular embeddable Java open source reporting library, providing Java developers with the power to create rich print and web reports easily.

JasperReports allows you to create better looking reports with formatting and grouping, as well as adding graphical elements to your reports. You can also export your reports to a range of different formats, including PDF and XML. Creating reports becomes easier with the iReport Designer visual designing tool. To round things off, you can integrate your reports with other Java frameworks, using Spring or Hibernate to get data for the report, and Java Server Faces or Struts for presenting the report.

This book shows you how to get started and develop the skills to get the most from JasperReports. The book has been fully updated to use JasperReports 3.5, the latest version of JasperReports. The previously accepted techniques that have now been deprecated have been replaced with their modern counterparts in this latest version. All the examples in this book have been updated to use XML schemas for report templates. Coverage of new datasources that JasperReports now supports has been added to the book. Additionally, JasperReports can now export reports to even more formats than before, and exporting reports to these new formats is covered in this new edition of the book.

The book steers you through each point of report setup, to creating, designing, formatting, and exporting reports with data from a wide range of datasources, and integrating JasperReports with other Java frameworks.

What this book covers

Chapter 1, An Overview of JasperReports, introduces you to JasperReports and how it came to be. It gives you an insight to JasperReports' capabilities and features, and also an overview of the steps involved in generating reports using JasperReports.

Chapter 2, Adding Reporting Capabilities to Java Applications, teaches you how to add reporting capabilities to your Java applications. You will have your development and execution environment set up to successfully add reporting capabilities to your Java applications by the end of this chapter.

Chapter 3, Creating Your First Report, shows you how to create, compile, and preview your first report in both JasperReports' native format and web browser. It also briefs you about the JRXML elements corresponding to different report sections.

Chapter 4, Creating Dynamic Reports from Databases, continues with report creation, exploring how to create a report from the data obtained from a database. It also teaches you to generate reports that are displayed in your web browser in the PDF format.

Chapter 5, Working with Other Datasources, uses datasources other than databases, such as empty datasources, arrays or collections of Java objects, Maps, TableModels, XML, CSV files, and custom datasources to create reports, enabling you to create your own datasources as well.

Chapter 6, Report Layout and Design, gets you creating elaborate layouts, by controlling report-wide layout properties and styles, dividing the report data into logical groups, adding images, background text, and dynamic data to the reports, conditionally printing the report data, and creating subreports.

Chapter 7, Adding Charts and Graphics to Reports, takes you to more appealing reports by showing how to take advantage of JasperReports' graphical features and create reports with graphical data like geometric shapes, images, and 2D and 3D charts.

Chapter 8, Other JasperReports Features, discusses the JasperReports features that lets you create elaborate reports, such as displaying report text in different languages, executing Java code snippets using scriptlets, creating crosstab reports, running a query with the results of a different query, adding anchors, hyperlinks, and bookmarks to the reports.

Chapter 9, Exporting to Other Formats, demonstrates how to export reports to the formats supported by JasperReports, such as PDF, RTF, ODT, Excel, HTML, CSV, XML, and plain text and how to direct the exported reports to a browser.

Chapter 10, Graphical Report Design with iReport, helps you get your hands on a graphical report designer called iReport, so that you can design reports graphically, and also, using iReport's graphical user interface.

Chapter 11, Integrating JasperReports with Other Frameworks, explains how to integrate JasperReports with several popular web application frameworks and ORM tools, such as Hibernate, JPA, Spring, JSF, and Struts.

What you need for this book

To use this book, you will of course need JasperReports. This is freely downloadable from http://www.sourceforge.net/projects/jasperreports.

JasperReports has its own requirements for proper and successful functioning: Java Development Kit (JDK) 1.4 or newer (http://java.sun.com/javase/downloads/index.jsp), a recent version of ANT (http://ant.apache.org/), and iReport (to visually design reports) (http://jasperforge.org/plugins/project/project_home.php?projectname=ireport). Any operating system supporting Java can be used (any modern version of Microsoft Windows, Mac OS X, Linux, or Solaris).

Who this book is for

If you are a Java developer who wants to create rich reports for either the Web or print, and you want to get started quickly with JasperReports, this book is for you. No knowledge of JasperReports is presumed.

Conventions

In this book, you will find a number of styles of text that distinguish between different kinds of information. Here are some examples of these styles, and an explanation of their meaning.

Code words in text are shown as follows: "The <queryString> element is used to embed a database query into the report template."

A block of code is set as follows:

<path id="classpath"> <pathelement location="./" /> <pathelement location="${classes.dir}" /> <fileset dir="${lib.dir}"> <include name="**/*.jar" /> </fileset> </path>

When we wish to draw your attention to a particular part of a code block, the relevant lines or items are set in bold:

<band height="20"> <staticText> <reportElement x="20" y="0" width="200" height="20"/> <text> <[!CDATA[If you don't see this, it didn't work]]> </text> </staticText> </band>

Any command-line input or output is written as follows:

$ antBuildfile: previewReportDesignXML.xmlviewDesignXML:

New terms and important words are shown in bold. Words that you see on the screen, in menus or dialog boxes for example, appear in the text like this: "clicking the Next button moves you to the next screen."

Note

Warnings or important notes appear in a box like this.

Tip

Tips and tricks appear like this.

Reader feedback

Feedback from our readers is always welcome. Let us know what you think about this book—what you liked or may have disliked. Reader feedback is important for us to develop titles that you really get the most out of.

To send us general feedback, simply send an email to <[email protected]>, and mention the book title via the subject of your message.

If there is a book that you need and would like to see us publish, please send us a note in the SUGGEST A TITLE form on www.packtpub.com or email <[email protected]>.

If there is a topic that you have expertise in and you are interested in either writing or contributing to a book on, see our author guide on www.packtpub.com/authors.

Customer support

Now that you are the proud owner of a Packt book, we have a number of things to help you to get the most from your purchase.

Tip

Downloading the example code for the book

Visit http://www.packtpub.com/files/code/8082_Code.zip to directly download the example code.

The downloadable files contain instructions on how to use them.

Errata

Although we have taken every care to ensure the accuracy of our content, mistakes do happen. If you find a mistake in one of our books—maybe a mistake in the text or the code—we would be grateful if you would report this to us. By doing so, you can save other readers from frustration, and help us to improve subsequent versions of this book. If you find any errata, please report them by visiting http://www.packtpub.com/support, selecting your book, clicking on the let us know link, and entering the details of your errata. Once your errata are verified, your submission will be accepted and the errata added to any list of existing errata. Any existing errata can be viewed by selecting your title from http://www.packtpub.com/support.

Piracy

Piracy of copyright material on the Internet is an ongoing problem across all media. At Packt, we take the protection of our copyright and licenses very seriously. If you come across any illegal copies of our works, in any form, on the Internet, please provide us with the location address or web site name immediately so that we can pursue a remedy.

Please contact us at <[email protected]> with a link to the suspected pirated material.

We appreciate your help in protecting our authors, and our ability to bring you valuable content.

Questions

You can contact us at <[email protected]> if you are having a problem with any aspect of the book, and we will do our best to address it.

Chapter 1. An Overview of JasperReports

In this chapter, along with an overview of JasperReports, we explain its capabilities and features. Here is a brief outline of the topics we will cover in this chapter:

A brief history of JasperReportsWhat JasperReports is and what it can do for usThe JasperReports open source licenseThe features of JasperReportsJasperReports' class library dependenciesThe steps required to generate reports with JasperReportsWhere to get support for JasperReports

A brief history of JasperReports

JasperReports was started in 2001 by Teodor Danciu when he was faced with the task of evaluating reporting tools for a project he was working on. The existing solutions, he found, were too expensive for his project's budget; therefore, he decided to write his own reporting engine. The project for which he was evaluating reporting tools got canceled, but nevertheless, he started to work on JasperReports in his spare time. He registered the project on SourceForge.net in September 2001. Shortly after, he started getting emails from interested potential users, even though he had not yet released any code. JasperReports version 0.1.5 was released in November 2001. Since then, JasperReports has become immensely popular; it is currently one of the most popular Java reporting tools available.

At first, JasperReports was basically a one-man project, with Teodor working on it in his spare time. Then, in April 2005, a company called JasperSoft was formally launched at the MySQL User Conference in California. JasperSoft now sponsors JasperReports' development, allowing Teodor and other JasperSoft developers to work full-time on JasperReports. JasperSoft also provides commercial support and services for JasperReports and related products, including the iReport visual designer for JasperReports. In addition to providing support for JasperReports and iReport, JasperSoft sells commercial applications incorporating JasperReports. JasperSoft has raised over 8 million dollars in venture capital funding, no small feat in these post dot-com days. This investment is a clear indication that venture capitalists have confidence in the success of JasperSoft and, by extension, in the success of JasperReports.

What exactly is JasperReports?

JasperReports is an open source Java library designed to aid developers with the task of adding reporting capabilities to Java applications. It is not a standalone tool and therefore it cannot be installed on its own. Instead, it is embedded into Java applications by including its library in the application's CLASSPATH. Being a Java library, JasperReports is not meant for end users. Rather, it is targeted towards Java developers who need to add reporting capabilities to their applications.

JasperReports is licensed under the Lesser GNU Public Library (LGPL). This license was chosen for JasperReports because, unlike the GPL, it allows JasperReports to be used in both open source and closed source applications. Applications linking to the JasperReports Java class library do not need to be open source. However, if you are considering making modifications to the existing JasperReports source code, then your modifications will have to be released under the LGPL. Refer to http://www.gnu.org/copyleft/lesser.html for the complete license.

Although JasperReports is primarily used to add reporting capabilities to web-based applications using the servlet API, it has absolutely no dependencies on the servlet API or any other Java EE library. It is, therefore, by no means limited to web applications. There is nothing that stops us from creating standalone desktop or command-line Java applications to generate reports with JasperReports. After all, JasperReports is nothing but a Java class library providing an API to facilitate the ability to generate reports from any kind of Java application.

JasperReports requires a Java Development Kit (JDK) 1.4 or newer in order to successfully compile applications incorporating the JasperReports Java class library and a Java Runtime Environment (JRE) 1.3 or newer to successfully execute these applications. The older versions of JasperReports required a JDK to successfully execute JasperReports applications (strictly speaking, JasperReports requires tools.jar to be in the CLASSPATH, and tools.jar is included in the JDK, not JRE). As of version 0.6.4, however, JasperReports is bundled with the EclipseJava Development Tools (JDT) compiler and no longer needs a JDK to execute deployed applications. Examples in this book were developed using JDK 1.6 but should compile and execute successfully with any JDK or JRE supported by JasperReports.

The features of JasperReports

JasperReports is capable of generating professional reports that include images, charts, and graphs, in addition to textual data. Some of the major JasperReports features include:

Flexible report layoutMultiple ways to present dataMultiple ways to supply dataCapability of accepting data from multiple datasourcesCapability of generating watermarksCapability of generating subreports

It is also capable of exporting reports in a variety of formats. Each of these features is briefly described in the next few sections.

Flexible report layout

JasperReports allows us to separate data into optional report sections. These sections include:

The report title, which will appear once at the top of the reportA page header, which will appear at the top of every pageA detail section, which typically contains the primary report dataA page footer, which will appear at the bottom of every pageA summary section, which will appear at the end of the report

All of these and other report sections are discussed in detail in Chapter 6, Report Layout and Design.

In addition to allowing us to define report sections, JasperReports allows the creation of elaborate dynamic layouts based on the contents of the report. For example, data can be hidden or displayed in a report, or it can even be grouped into logical sections, depending on the values of the respective report fields. Let's suppose that we are creating a report about cars. JasperReports allows us to group the data by make, model, year, or a combination of these or any other piece of data displayed on the report. Data grouping lets us control the layout of the report better. Data group definitions can also be used to calculate subtotal values based on a subset of the report data. Groups are also used to define datasets for charts and graphs. Data grouping is discussed in detail in Chapter 6, Report Layout and Design.

Multiple ways to present data

JasperReports provides the ability to display report data textually or graphically using charts. JasperReports allows us to use report expressions for generating reports that display dynamic data, that is, data that is not directly passed to the report or stored anywhere; instead, it is calculated from the data contained in the datasource and/or report parameters.

Multiple ways to supply data

JasperReports allows developers to pass data to a report through the report parameters. Report parameters can be instances of any Java class.

Data can also be passed to a report by using special classes called datasources. Report parameters and datasources can be combined for maximum flexibility.

Multiple datasources

JasperReports can generate reports using any relational database system supported by JDBC, but it is not limited to database reports. It can generate reports from a number of datasources including XML files, PlainOld Java Objects (POJOs), any class implementing the java.util.Map interface, and any class implementing the javax.swing.table.TableModel interface.

JasperReports also supports empty datasources, which are used for simple reports that have no dynamic data displayed. If we need to create a report from a datasource that is not directly supported by JasperReports, it also allows us to create our own custom datasources. JDBC datasources are discussed in detail in Chapter 4, Creating Dynamic Reports from Databases; other datasource types, including custom datasources, are discussed in detail in Chapter 5, Working with Other Datasources.

Watermarks

JasperReports is capable of generating background images or text on the reports it generates. These background images can serve as watermarks for the report. Watermarks can be used for branding reports and for security purposes, as they make it difficult to forge reports. As all report pages have the same watermark, reports can maintain a consistent look and feel.

Subreports

Another feature of JasperReports is its ability to create subreports, or reports within reports. Subreports simplify report design significantly by allowing us to extract complex report sections into a separate report and then incorporating that separate report into a master report.

Exporting capabilities

Reports generated with JasperReports can be exported to a number of formats, including PDF, Excel (XLS), and Rich Text Format (RTF). RTF is a format readable and editable by most word processors, such as Microsoft Word, OpenOffice.org Writer, StarOffice Writer, and WordPerfect. Reports created with JasperReports can also be exported to HTML, XML, CSV, plain text, and OpenDocument Format (ODF), the native file format of OpenOffice.org Writer. Exporting reports to these formats is discussed in detail in Chapter 9, Exporting to Other Formats.

The following screenshot demonstrates some of JasperReports' features, including data grouping, adding images and watermarks to a report, and exporting to PDF:

When creating this report, we took advantage of JasperReports' data grouping capabilities to create groups dividing the data by country, state, and city. This grouping allowed us to display the data in a logical, easy-to-follow way. We also took advantage of JasperReports' ability to display images, to add a watermark and a logo in the report heading. The report font in the header section was enlarged and made bold, and the text was laid out in an easy-to-follow format.

In the previous screenshot, the freely available Evince document viewer was used to display the PDF report. Of course, reports exported to PDF can be viewed with any PDF viewer, including Adobe Acrobat, Foxit, and Xpdf.

Class library dependencies

JasperReports leverages other open source Java libraries to implement some of its functionality. Some of the libraries JasperReports builds on include:

iText: A PDF generation and manipulation library. It has the ability of generating and manipulating RTF, XML, and HTML documents. JasperReports takes advantage of iText in order to export reports to PDF and RTF. More information about iText can be found at http://www.lowagie.com/iText/.JFreeChart: A Java library for producing various charts, including pie charts, bar charts, line charts, and area charts. JasperReports takes advantage of JFreeChart to implement its built-in charting functionality. More information about JFreeChart can be found at http://www.jfree.org/jfreechart. Apache POI: A Java class library to create and manipulate various Microsoft Office formats, such as Microsoft's OLE 2 Compound Document format. JasperReports takes advantage of POI to export reports to XLS (Microsoft Excel) format. More information about Apache POI can be found at http://poi.apache.org/.JAXP: Java API for parsing and transforming XML documents. JAXP is used by JasperReports to parse XML files. JAXP is included with Java SE 5.0 and it can be downloaded separately when using earlier versions of Java SE. More information about JAXP can be found at https://jaxp.dev.java.net/.Apache Commons: A collection of Java libraries providing a large number of reusable components. JasperReports takes advantage of the Commons Digester, BeanUtils, and Logging components ofApache Commons to complement JAXP for XML parsing. More information about Apache Commons can be found at http://commons.apache.org/.

Note

URLs provided here are for informational purposes only; the JasperReports class library already includes the required JAR files listed here. There is no need for us to download them to take advantage of their functionality within JasperReports.

Typical workflow

The following flow chart illustrates the typical workflow followed when creating reports with JasperReports.

When working with JasperReports, the first step is to create a report template as an XML file. XML report templates can be handcoded or generated by a graphical report designer. Even though JasperReports report templates are XML files, by convention template filenames are given an extension of .jrxml. JasperReports XML templates are commonly referred to as JRXML files, which is the term we will use in this book.

Let's take a look at what a typical JRXML file looks like:

<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE jasperReport PUBLIC "//JasperReports//DTD Report Design//EN""http://jasperreports.sourceforge.net/dtds/jasperreport.dtd"> <jasperReport name="simple_template"> <title> <band height="50"> </band> </title> <pageHeader> <band height="50"> </band> </pageHeader> <columnHeader> <band height="30"> </band> </columnHeader> <detail> <band height="100"> </band> </detail> <columnFooter> <band height="30"> </band> </columnFooter> <pageFooter> <band height="50"> </band> </pageFooter> <lastPageFooter> <band height="50"> </band> </lastPageFooter> <summary> <band height="50"> </band> </summary> </jasperReport>

This JRXML file illustrates the main elements of a JRXML file. All elements in the JRXML file are optional except for the root <jasperReport> element. This JRXML file, when compiled and filled, will generate an empty report, not very practical in its own right, but it can be used as a template for creating more useful templates. As can be seen in the example, each main element of the JRXML file contains a <band> element as its only child element. Bands contain the data that is displayed in the report. In the example, all the bands are empty. In real JRXML files, bands contain child elements used to position, format, and display the actual report data, both textual and graphical. There are commercial and open source visual design tools that can aid in the development of JRXML files. One such tool, iReport, the official JasperReports graphical report designer, is covered in detail in Chapter 10, Graphical Report Design with iReport.

JRXML files are "compiled" into a JasperReports native binary template either programmatically by calling the appropriate methods on the JasperReports class library, or by using a custom ANT task provided by JasperReports. The resulting compiled template is commonly known as the jasper file and is typically saved to disk with a .jasper extension. The jasper file is then used to generate the final report by providing it with its required data. This process is known as filling the report. A JRXML file has to be compiled only once, while the generated jasper file can be filled as many times as necessary to create and display reports.

The filled reports can be saved to disk in a JasperReports' native format. Reports saved in this format are known as JasperPrint files. The JasperPrint file names have a .jrprint extension. JasperPrint files can only be viewed with a JasperReports specific viewer. The JasperPrint files can be exported to other formats so that they can be opened with commonly available tools like PDF viewers and word processors. Exporting to other formats is discussed in detail in Chapter 9, Exporting to Other Formats.

Where to get help

JasperForge, the official JasperSoft online portal, is the best place to get help with JasperReports and other JasperSoft products. JasperForge can be found at http://jasperforge.org.

JasperForge has official online forums where questions about their products, including JasperReports, can be asked. The JasperReports online forums can be found at http://jasperforge.org/plugins/espforum/browse.php?group_id=102&forumid=103.

The JasperReports page at JasperForge contains tips, tricks, JavaDoc API documentation, and a quick reference for JRXML elements. We won't repeat that information in this book, as it is readily available online. Commercial support and the training is offered by JasperSoft and other third-party companies.

Summary

In this chapter, we were introduced to JasperReports. We discussed the evolution of JasperReports from a small, one-man project to a project backed and funded by a company that has raised millions of dollars in venture capital. We also had an overview of JasperReports, where we discussed that JasperReports is not a standalone reporting solution. Instead, it is a Java library that allows us to add reporting capabilities to our applications.

Next on the line was JasperReports' open source license (LGPL). The chapter provided us with a brief explanation of the features of JasperReports, including flexibility in report layout, the ability to display report data textually or graphically, and the ability to group report data. The JasperReports' class library dependencies were also discussed along with the typical workflow followed when designing reports. Finally, this chapter provided us with the official online forums where we can seek help.

Chapter 2. Adding Reporting Capabilities to our Java Applications

We can easily add reporting capabilities to our Java applications by taking advantage of the classes included in the JasperReports class library. JasperReports can be easily embedded into both client and server-side Java applications simply by adding the required libraries to our CLASSPATH and calling the appropriate methods in the JasperReports API.

At the end of this chapter, we will be able to:

Identify the purpose of the several downloads that can be found at the JasperReports web siteSet up our development and execution environment to successfully add reporting capabilities to our Java applicationsIdentify the required libraries for adding reporting capabilities to Java applicationsIdentify the optional libraries that can be used to enhance the reporting capabilities of our Java applications

Downloading JasperReports

JasperReports is distributed as a JAR file that needs to be added to the CLASSPATH of any application we wish to add reporting capabilities to. JasperReports can be downloaded from http://jasperforge.org/plugins/project/project_home.php?group_id=102.

Clicking on the Download link around the center of the page will take us to the JasperReports download page on SourceForge.net.

The specific version on your screen might be different; at the time of writing, the latest stable version of JasperReports is 3.5.2.

It is not always clear what exactly is downloaded by clicking on these links; thus, we will provide a brief explanation of what each link is for.

jasperreports-3.5.2-applet.jar:This first download link is for a JAR file containing a subset of the JasperReports functionality. Specifically, it contains classes that can be used to display JasperPrint files, which are reports in JasperReports' native format. This file is offered as a separate download as a convenience for developers; it can be used for applications or applets that don't need full reporting capabilities, yet need to display generated reports. Even though the filename has a suffix of "applet", there is nothing preventing us from using it with standalone applications, without the overhead that the missing JasperReports classes would add to the download. This file is approximately 346 KB in size.jasperreports-3.5.2.jar: