How to Use Jasper Report

JasperReports is a popular open-source reporting tool that allows developers to create sophisticated and dynamic reports. These reports can be rendered in various formats, including PDF, HTML, Excel, and more. Here's a guide to get you started with JasperReports, including setting up a simple report in a Java application.

Step 1: Set Up JasperReports

Download JasperReports Library:

You can download the latest JasperReports library from the Jaspersoft Community.

Add JasperReports to Your Project:

If you're using Maven, add the following dependencies to your pom.xml:

xml

<groupId>net.sf.jasperreports</groupId>

<artifactId>jasperreports</artifactId>

</dependency>

Step 2: Create a Simple Report Template

Design the Report:

You can design your report using Jaspersoft Studio, a free Eclipse-based report designer for JasperReports.

Create a Report Template (JRXML):

Create a simple report template (JRXML file) using Jaspersoft Studio. For example, create a file named sample_report.jrxml with the following content:

xml

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE jasperReport PUBLIC "-//JasperReports//DTD Report Design//EN" "http://jasperreports.sourceforge.net/dtds/jasperreport.dtd">

<![CDATA[SELECT * FROM your_table]]>

</queryString>

<title>

</textElement>

</textField>

</band>

</title>

</textField>

</textField>

</band>

</detail>

</jasperReport>

Step 3: Generate the Report in Java

Load and Compile the Report Template:

Use JasperReports API to load and compile the JRXML file.

Fill the Report with Data:

Use a data source to fill the report with data. This can be a database connection or a collection of Java objects.

Export the Report:

Export the filled report to the desired format (PDF, HTML, etc.).

Here is an example Java code to generate a PDF report:

java

import net.sf.jasperreports.engine.*;

import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource;

import java.util.*;

public class JasperReportExample {

public static void main(String[] args) {

try {

// Compile the JRXML file

JasperReport jasperReport = JasperCompileManager.compileReport("path/to/sample_report.jrxml");

// Create a data source (for example, a list of Java objects)

List<Map<String, Object>> dataSource = new ArrayList<>();

Map<String, Object> data1 = new HashMap<>();

data1.put("id", 1);

data1.put("name", "John Doe");

dataSource.add(data1);

Map<String, Object> data2 = new HashMap<>();

data2.put("id", 2);

data2.put("name", "Jane Doe");

dataSource.add(data2);

JRBeanCollectionDataSource beanCollectionDataSource = new JRBeanCollectionDataSource(dataSource);

// Fill the report with data

Map<String, Object> parameters = new HashMap<>();

JasperPrint jasperPrint = JasperFillManager.fillReport(jasperReport, parameters, beanCollectionDataSource);

// Export the report to a PDF file

JasperExportManager.exportReportToPdfFile(jasperPrint, "path/to/sample_report.pdf");

System.out.println("Report generated successfully!");

} catch (JRException e) {

e.printStackTrace();

}

Explanation

Compile the JRXML File:

The JasperCompileManager.compileReport method compiles the JRXML file into a JasperReport object.

Create a Data Source:

The JRBeanCollectionDataSource is used to create a data source from a list of Java objects. You can use other data sources like JDBC or custom data sources as well.

Fill the Report with Data:

The JasperFillManager.fillReport method fills the compiled report with data from the data source.

Export the Report:

The JasperExportManager.exportReportToPdfFile method exports the filled report to a PDF file.

Conclusion

JasperReports is a flexible and powerful reporting tool that integrates well with Java applications. By following the steps above, you can create, design, and generate reports in various formats. For more advanced reporting features, refer to the official JasperReports documentation and explore the capabilities of Jaspersoft Studio.