JasperReports is an open source Java reporting tool that can write to a variety of targets, such as: screen, a printer, into PDF, HTML, Microsoft Excel, RTF, ODT, Comma-separated values or XML files.

It can be used in Java-enabled applications, including Java EE or web applications, to generate dynamic content. It reads its instructions from an XML or .jasper file.

JasperReports reports are defined in an XML file format, called JRXML, which can be hand-coded, generated, or designed using tool Like IReport. The file format is defined by a Document Type Definition (DTD) or XML schema for newer versions, providing limited interoperability.

After compiling .jrxml file using JasperCompileManager class, .jasper file created.

IDE Integration

Many prominent Java IDEs provide instructions for users wishing to integrate JasperReports into a project.

NetBeans

iReport - a visual designer for JasperReports

Eclipse

Jaspersoft Studio - a re-write of iReport by the same team who originally developed iReport, backed

by Jaspersoft

JasperWave Report Designer - free Eclipse-based visual editor for JasperReports report engine

IBM Websphere Studio Application Developer

This are the jar file required for this project –

Required Jar

This is my project structure –

Folder Structure

These are the java files we create for this example project-

SR#	Name	Description
1	JasperReport.jrxml	JasperReport Template File.
2	report.jsp	View from where user can generate report.
3	JasperServlet.java	To handle request from JSP.
4	JasperData.java	To Get data from MySQL database.
5	JasperDataBean.java	Bean class to hold table data.
6	web.xml	Configuration file.

JasperReport.jrxml

This is jasper template; I used ireport to create it, the objective of this blog is to see how jasper report call from servlet, that is why we are not going deep in this report.

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

<jasperReport xmlns="http://jasperreports.sourceforge.net/jasperreports"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://jasperreports.sourceforge.net/jasperreports

http://jasperreports.sourceforge.net/xsd/jasperreport.xsd" name="test" pageWidth="595"

pageHeight="842" columnWidth="535"

leftMargin="20" rightMargin="20" topMargin="20"

bottomMargin="20" uuid="a6b5b17a-e37b-4890-9fc9-fcc7cb06169c">

<box>

</box>

</style>

<box>

</box>

</style>

<box>

</box>

</style>

<box>

</box>

</conditionalStyle>

</style>

<parameter name="paramLogFilePath" class="java.lang.String"/>

<![CDATA[]]>

</queryString>

<field name="addDate" class="java.lang.String"/>

<field name="name" class="java.lang.String"/>

<field name="email" class="java.lang.String"/>

<field name="website" class="java.lang.String"/>

<field name="subject" class="java.lang.String"/>

<field name="message" class="java.lang.String"/>

<field name="recordStatus" class="java.lang.String"/>

</background>

<title>

<image>

</image>

</staticText>

</staticText>

</band>

</title>

</pageHeader>

<band height="36" splitType

<line>

</graphicElement>

</line>

</textElement>

</staticText>

</textElement>

</staticText>

</textElement>

</staticText>

</textElement>

</staticText>

</textElement>

</staticText>

</band>

</columnHeader>

</textField>

</textField>

</textField>

</textField>

</textField>

</band>

</detail>

<line>

</graphicElement>

</line>

</band>

</columnFooter>

</textElement>

</textField>

</textElement>

</textField>

</textElement>

</textField>

</band>

</pageFooter>

</summary>

</jasperReport>

report.jsp

This JSP needed to call servlet.

<%@page contentType="text/html" pageEncoding="UTF-8"%>

<!DOCTYPE html>

<html>

<head>

<title>JasperReport Download Example</title>

</head>

<body>

<h1>

JasperReport Download Example

</h1>

Generate Report

</a>

<br>

</form>

</body>

</html>

JasperServlet.java

/**

* Servlet class to handle request from JSP and generate report.

package servlet;

import com.data.JasperData;

import com.data.JasperDataBean;

import java.io.*;

import java.util.*;

import java.util.logging.*;

import javax.servlet.ServletException;

import javax.servlet.http.*;

import net.sf.jasperreports.engine.*;

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

import net.sf.jasperreports.engine.design.JasperDesign;

import net.sf.jasperreports.engine.xml.JRXmlLoader;

/**

* @author Vikas Verma

public class JasperServlet extends HttpServlet {

/**

* Downloaded file name.

private String DOWNLOAD_FILE_NAME = "REPORT.pdf";

/**

* File type.

private String FILE_TYPE = "application/pdf";

/**

* Processes requests for both HTTP

* <code>GET</code> and

* <code>POST</code> methods.

* @param request servlet request

* @param response servlet response

* @throws ServletException if a servlet-specific error occurs

* @throws IOException if an I/O error occurs

protected void processRequest(HttpServletRequest request, HttpServletResponse response)

throws ServletException, IOException {

response.setContentType("text/html;charset=UTF-8");

try {

/**

* Generate and download pdf report.

generateReport(request, response);

} catch (Exception exp) {

exp.printStackTrace();

}

/**

* This method is used to Generate and download JasperReport in pdf format.

* @param HttpServletResponse object

private void generateReport(HttpServletRequest request,

HttpServletResponse response) {

/**

* Variable Declaration.

List<JasperDataBean> dataList;

String reportPath;

OutputStream outStream;

JasperReport jasperReport;

JasperDesign jasperDesign;

JRDataSource reportSource;

JasperData jasperData;

String logoFilePath;

Map reportParameters;

try {

/**

* Get report and logo file path.

reportPath = request.getServletContext().

getRealPath("reports") + "\\JasperReport.jrxml";

logoFilePath = request.getServletContext().

getRealPath("reports") + "\\leaf_banner_gray.png";

/**

* Set report parameters

reportParameters = new HashMap();

reportParameters.put("paramLogFilePath", logoFilePath);

/**

* Compile Jasper Report.

jasperDesign = JRXmlLoader.load(reportPath);

jasperReport = JasperCompileManager.compileReport(jasperDesign);

/**

* Get report DataSource.

jasperData = new JasperData();

dataList = jasperData.getData();

reportSource = new JRBeanCollectionDataSource(dataList);

/**

* Get byteStream for generated Stream.

byte[] byteStream;

byteStream = JasperRunManager.runReportToPdf(jasperReport,

reportParameters, reportSource);

/**

* Set output Stream in response.

outStream = response.getOutputStream();

response.setHeader("Content-Disposition", "inline, filename=" + DOWNLOAD_FILE_NAME);

response.setContentType(FILE_TYPE);

response.setContentLength(byteStream.length);

outStream.write(byteStream, 0, byteStream.length);

} catch (JRException ex) {

Logger.getLogger(JasperServlet.class.getName()).log(Level.SEVERE, null, ex);

} catch (Exception e) {

e.printStackTrace();

}

// <editor-fold defaultstate="collapsed" desc="HttpServlet methods. Click on the + sign on the left to edit the code.">

/**

* Handles the HTTP

* <code>GET</code> method.

* @param request servlet request

* @param response servlet response

* @throws ServletException if a servlet-specific error occurs

* @throws IOException if an I/O error occurs

@Override

protected void doGet(HttpServletRequest request, HttpServletResponse response)

throws ServletException, IOException {

processRequest(request, response);

}

/**

* Handles the HTTP

* <code>POST</code> method.

* @param request servlet request

* @param response servlet response

* @throws ServletException if a servlet-specific error occurs

* @throws IOException if an I/O error occurs

@Override

protected void doPost(HttpServletRequest request, HttpServletResponse response)

throws ServletException, IOException {

processRequest(request, response);

}

/**

* Returns a short description of the servlet.

* @return a String containing servlet description

@Override

public String getServletInfo() {

return "Short description";

}// </editor-fold>

}

JasperData.java

Before creating class to access DB, first create a table.

delimiter $$

CREATE TABLE `message_header` (

`MESSAGE_ID` int(11) NOT NULL AUTO_INCREMENT,

`NAME` varchar(50) DEFAULT NULL,

`EMAIL` varchar(50) DEFAULT NULL,

`website` varchar(50) DEFAULT NULL,

`subject` varchar(50) DEFAULT NULL,

`message` varchar(500) DEFAULT NULL,

`record_status` varchar(1) DEFAULT NULL,

`record_add_date` date DEFAULT NULL

) ;

and insert sample data in the table -

INSERT INTO `jsr`.`message_header` (`MESSAGE_ID`, `NAME`, `EMAIL`, `website`, `subject`, `message`, `record_status`, `record_add_date`) VALUES ('19', 'abcd', 'abcd@abcd.com', 'www.abcd.abcd', 'this is subject', 'this is message', 'A', '2013-07-06');

Now create class to access this tables from Database.

/**

* This class is used to get Data from DB.

package com.data;

import java.sql.Connection;

import java.sql.PreparedStatement;

import java.sql.ResultSet;

import java.sql.SQLException;

import java.util.ArrayList;

import java.util.List;

import java.util.logging.Level;

import java.util.logging.Logger;

import servlet.JasperServlet;

/**

* @author Vikas Verma

public class JasperData {

/**

* Connection settings.

private final String CONN_URL =

"jdbc:mysql://localhost/jsr?user=root&password=*****";

private final String DRIVER =

"com.mysql.jdbc.Driver";

/**

* SQL Query.

private final String SQL =

" SELECT RECORD_ADD_DATE, NAME," +

" EMAIL, WEBSITE,SUBJECT, MESSAGE," +

" RECORD_STATUS" +

" FROM MESSAGE_HEADER" +

" ORDER BY RECORD_ADD_DATE";

/**

* This method return report data from MySQL DB

* @return List object of Data Beans.

public List getData() {

JasperDataBean objBean;

List<JasperDataBean> dataList = new ArrayList<JasperDataBean>(0);

Connection conn;

PreparedStatement ps;

ResultSet rs;

try {

/**

* Load Driver.

Class.forName(DRIVER).newInstance();

/**

* Get data from DB.

conn = java.sql.DriverManager.getConnection(CONN_URL);

ps = conn.prepareStatement(SQL);

rs = ps.executeQuery();

/**

* Populate List of Data Bean.

while (rs.next()) {

objBean = new JasperDataBean();

objBean.setAddDate(rs.getString("RECORD_ADD_DATE"));

objBean.setName(rs.getString("NAME"));

objBean.setEmail(rs.getString("EMAIL"));

objBean.setWebsite(rs.getString("WEBSITE"));

objBean.setSubject(rs.getString("SUBJECT"));

objBean.setMessage(rs.getString("MESSAGE"));

objBean.setRecordStatus(rs.getString("RECORD_STATUS"));

dataList.add(objBean);

}

} catch (ClassNotFoundException ex) {

Logger.getLogger(JasperServlet.class.getName()).log(Level.SEVERE, null, ex);

} catch (InstantiationException ex) {

Logger.getLogger(JasperServlet.class.getName()).log(Level.SEVERE, null, ex);

} catch (IllegalAccessException ex) {

Logger.getLogger(JasperServlet.class.getName()).log(Level.SEVERE, null, ex);

} catch (SQLException ex) {

Logger.getLogger(JasperServlet.class.getName()).log(Level.SEVERE, null, ex);

}

/**

* Return List of data.

return dataList;

}

JasperDataBean.java

/**

* JavaBean class to hold DB data.

package com.data;

/**

* @author Vikas Verma

public class JasperDataBean {

private String addDate;

private String name;

private String email;

private String website;

private String subject;

private String message;

private String recordStatus;

public JasperDataBean() {

}

public JasperDataBean(String addDate, String name,

String email, String website,

String subject, String message, String

recordStatus) {

this.addDate = addDate;

this.name = name;

this.email = email;

this.website = website;

this.subject = subject;

this.message = message;

this.recordStatus = recordStatus;

}

public String getAddDate() {

return addDate;

}

public void setAddDate(String addDate) {

this.addDate = addDate;

}

public String getName() {

return name;

}

public void setName(String name) {

this.name = name;

}

public String getEmail() {

return email;

}

public void setEmail(String email) {

this.email = email;

}

public String getWebsite() {

return website;

}

public void setWebsite(String website) {

this.website = website;

}

public String getSubject() {

return subject;

}

public void setSubject(String subject) {

this.subject = subject;

}

public String getMessage() {

return message;

}

public void setMessage(String message) {

this.message = message;

}

public String getRecordStatus() {

return recordStatus;

}

public void setRecordStatus(String recordStatus) {

this.recordStatus = recordStatus;

}

/* end of class */

web.xml

<description>For Report 1</description>

<servlet-name>JasperServlet</servlet-name>

<servlet-class>servlet.JasperServlet</servlet-class>

</servlet>

<servlet-mapping>

<servlet-name>JasperServlet</servlet-name>

<url-pattern>/JasperServlet</url-pattern>

</servlet-mapping>

Just compile and run the above file and click on the Generate Report link to download the generated PDF.

Thanks

References -

http://en.wikipedia.org/wiki/JasperReports

Vikas Java Notes

Monday, July 15, 2013

Jasper Report from Servlet and MySql

JasperReport.jrxml

report.jsp

JasperServlet.java

JasperData.java

JasperDataBean.java

web.xml

References -

4 comments: