...
| Info |
|---|
The support for JasperReports is an optional download. This product is distributed under the LGPL and cannot be bundled with Apache Licensed products. |
JasperReports JasperReports (http://jasperreports.sourceforge.net
) is one of the leading open-source java Java reporting libraries. It compiles .jrxml (XML source) to .jasper (=compiled version) files, which in turn can be transformed to several output types (PDF, CSV, XLS and HTML).
In the following example, we will use Webwork the framework to dynamically create a PDF with a list of persons. Our WW action will be used to create a List with objects, and our JasperReport Result will use this list to fill our template, and return the PDF.
I assume you already have a WW SAF webapp working.
| Note |
|---|
Note: although this is a very simple example, I suggest you read the fine documentation of both WW SAF and JR. |
| Info | ||
|---|---|---|
| ||
Webwork 2.2 beta 3 (but should apply to previous versions) |
...
| Code Block | ||
|---|---|---|
| ||
package com.mevipro.test;
public class Person {
private Long id;
private String name;
private String lastName;
public Person() {
super();
}
public Person(String name, String lastName) {
super();
this.name = name;
this.lastName = lastName;
}
public Person(Long id, String name, String lastName) {
super();
this.id = id;
this.name = name;
this.lastName = lastName;
}
/**
* @return Returns the id.
*/
public Long getId() {
return id;
}
/**
* @param id The id to set.
*/
public void setId(Long id) {
this.id = id;
}
/**
* @return Returns the lastName.
*/
public String getLastName() {
return lastName;
}
/**
* @param lastName The lastName to set.
*/
public void setLastName(String lastName) {
this.lastName = lastName;
}
/**
* @return Returns the name.
*/
public String getName() {
return name;
}
/**
* @param name The name to set.
*/
public void setName(String name) {
this.name = name;
}
}
|
Nothing special. Just your basic properties, constructor, getters and setters.
...
Before we can continue, we need to add the JR libraries to our classpath. You can download the JR project here: http://www.sourceforge.net/projects/jasperreports
Save the jasperreports-X-project.zip to your harddisk, and extract the files.
...
| Code Block | ||
|---|---|---|
| ||
package com.mevipro.test.action;
import java.util.ArrayList;
import java.util.List;
import net.sf.jasperreports.engine.JasperCompileManager;
import com.mevipro.test.Person;
import com.opensymphony.xwork.ActionSupport;
public class JasperAction extends ActionSupport {
//basic List - it will serve as our dataSource later on
private List myList;
/*
* (non-Javadoc)
*
* @see com.opensymphony.xwork.ActionSupport#execute()
*/
public String execute() throws Exception {
// create some imaginary persons
Person p1 = new Person(new Long(1), "Patrick", "Lightbuddie");
Person p2 = new Person(new Long(2), "Jason", "Carrora");
Person p3 = new Person(new Long(3), "Alexandru", "Papesco");
Person p4 = new Person(new Long(4), "Jay", "Boss");
/*
* store everything in a list - normally, this should be coming from a
* database but for the sake of simplicity, I left that out
*/
myList = new ArrayList();
myList.add(p1);
myList.add(p2);
myList.add(p3);
myList.add(p4);
/*
* Here we compile our xml jasper template to a jasper file.
* Note: this isn't exactly considered 'good practice'.
* You should either use precompiled jasper files (.jasper) or provide some kind of check
* to make sure you're not compiling the file on every request.
* If you don't have to compile the report, you just setup your data source (eg. a List)
*/
try {
JasperCompileManager.compileReportToFile(
"WW_WEBAPP/jasper/our_jasper_template.jrxml",
"WW_WEBAPP/jasper/our_compiled_template.jasper");
} catch (Exception e) {
e.printStackTrace();
return ERROR;
}
//if all goes well ..
return SUCCESS;
}
/**
* @return Returns the myList.
*/
public List getMyList() {
return myList;
}
}
|
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<?xml version="1.0"?>
<!DOCTYPE jasperReport
PUBLIC "-//JasperReports//DTD Report Design//EN"
"http://jasperreports.sourceforge.net/dtds/jasperreport.dtd">
<jasperReport name="jasper_test">
<!-- our fields -->
<field name="name" class="java.lang.String"/>
<field name="lastName" class="java.lang.String"/>
<title>
<band height="50">
<staticText>
<reportElement x="0" y="0" width="180" height="15"/>
<textElement/>
<text>
<![CDATA[Webwork JasperReports Sample]]>
</text>
</staticText>
</band>
</title>
<pageHeader>
<band></band>
</pageHeader>
<columnHeader>
<band height="20">
<staticText>
<reportElement x="180" y="0" width="180" height="20"/>
<textElement>
<font isUnderline="true"/>
</textElement>
<text>
<![CDATA[NAME]]>
</text>
</staticText>
<staticText>
<reportElement x="360" y="0" width="180" height="20"/>
<textElement>
<font isUnderline="true"/>
</textElement>
<text>
<![CDATA[LASTNAME]]>
</text>
</staticText>
</band>
</columnHeader>
<detail>
<band height="20">
<textField>
<reportElement x="180" y="0" width="180" height="15"/>
<textElement/>
<textFieldExpression>
<![CDATA[$F{name}]]>
</textFieldExpression>
</textField>
<textField>
<reportElement x="360" y="0" width="180" height="15"/>
<textElement/>
<textFieldExpression>
<![CDATA[$F{lastName}]]>
</textFieldExpression>
</textField>
</band>
</detail>
<columnFooter>
<band></band>
</columnFooter>
<pageFooter>
<band height="15">
<staticText>
<reportElement x="0" y="0" width="40" height="15"/>
<textElement/>
<text>
<![CDATA[Page:]]>
</text>
</staticText>
<textField>
<reportElement x="40" y="0" width="100" height="15"/>
<textElement/>
<textFieldExpression class="java.lang.Integer">
<![CDATA[$V{PAGE_NUMBER}]]>
</textFieldExpression>
</textField>
</band>
</pageFooter>
<summary>
<band></band>
</summary>
</jasperReport>
|
Save this file in WW_WEBAPP/jasper/ as 'our_jasper_template.jrxml'.
...
In the detail band we use the
| Code Block |
|---|
$F{name} |
expression. This means JR will ask WW how to retrieve the field value. WW will happily look up this value in the stack (find the person, and invoke the getName() getter), and return it. Similar for the
| Code Block |
|---|
$F{lastName} |
The rest is mostly markup to define the layout.
...
When our JasperAction executes correctly, we will use the Result type registered with the name 'jasper'. This is already done when you include the webwork-default (
| Code Block |
|---|
<include file="webwork-default.xml"/> |
). This result type will be configured by our params, which we'll specify below:
...
You should now be able to execute http://localhost:8080/YOUR_WEBAPP/myJasperTest.action - and you should see a nice list of names.
WW provides probably the most elegant way to deal with JasperReport files; specify the location of the .jasper file, specify what dataSource you want to use, and there you go.