Using Parameters in JasperReports

By: MakeItSimple. Emailed: 1765 times Printed: 2515 times    

Latest comments
By: rohit kumar - how this program is work
By: Kirti - Hi..thx for the hadoop in
By: Spijker - I have altered the code a
By: ali mohammed - why we use the java in ne
By: ali mohammed - why we use the java in ne
By: mizhelle - when I exported the data
By: raul - no output as well, i'm ge
By: Rajesh - thanx very much...
By: Suindu De - Suppose we are executing

Parameters are object references that are passed-in to the report filling operations. They are very useful for passing to the report engine data that it can not normally find in its data source. 

For example, we could pass to the report engine the name of the user that has launched the report filling operation, if we want it to appear on the report, or we could dynamically change the title of our report. 

An import aspect is the use of report parameters in the query string of the report, in order to be able to further customize the data set retrieved from the database. Those parameters could act like dynamic filters in the query that supplies data for the report. 

Declaring a parameter in a report design is very simple and it requires specifying only its name and its class: 

<parameter name="ReportTitle" class="java.lang.String"/>
<parameter name="MaxOrderID" class="java.lang.Integer"/>
<parameter name="SummaryImage" class="java.awt.Image"/>

There are two possible ways to use parameters in the query: 
1. The parameters are used like normal java.sql.PreparedStatement parameters using the following syntax: 

2. Sometimes is useful to use parameters to dynamically modify portions of the SQL query or to pass the entire SQL query as a parameter to the report filling routines. In such a case, the syntax differs a little, like in the following example: 

SELECT * FROM Orders ORDER BY $P!{OrderByClause}  

There are also the following built-in system parameters, ready to use in expressions:



This parameter will contain a map with all user defined and built-in parameters.



A user supplied java.sql.Connection used for JDBC datasources.



A user supplied instance of JRDataSource representing either one of the built-in data source types or a user-defined one.



An integer allowing users to limit the datasource size.



A JRAbstractScriptlet containing an instance of the report scriptlet provided by the user.



A java.util.Locale instance containing the resource bundle desired locale.



The java.util.ResourceBundle containing localized messages.



A java.util.TimeZone instance to use for date formatting.



The net.sf.jasperreports.engine.JRVirtualizer object to be used for page virtualization.



A java.lang.ClassLoader instance to be used during the report filling process to load resources such as images, fonts and subreport templates.


Java Home | All Java Tutorials | Latest Java Tutorials

Sponsored Links

If this tutorial doesn't answer your question, or you have a specific question, just ask an expert here. Post your question to get a direct answer.

Bookmark and Share


Be the first one to add a comment

Your name (required):

Your email(required, will not be shown to the public):

Your sites URL (optional):

Your comments:

More Tutorials by MakeItSimple.
Using Charts in JasperReports
Report Sections in JasperReports
Using Variables in JasperReports
Using Expressions in JasperReports
Fields in JasperReports
Using Parameters in JasperReports
What is a report design in JasperReports?
What is JasperReports?

More Tutorials in Java
Update contents of a file within a jar file
Tomcat and httpd configured in port 8080 and 80
Java File
Java String
Count number of vowels, consonants and digits in a String in Java
Reverse a number in Java
Student marks calculation program in Java
Handling Fractions in Java
Calculate gross salary in Java
Calculate average sale of the week in Java
Vector in Java - Sample Program
MultiLevel Inheritance sample in Java
Multiple Inheritance sample in Java
Java program using Method Overriding
Java program to check if user input is an even number

More Latest News
Most Viewed Articles (in Java )
A Serialization Example in Java
Using One-Dimensional Arrays in Java
Method Overriding in Java
indexOf( ) and lastIndexOf( ) in Java
The java Buzzwords
Write to a file in Java - Sample Program
XML and Java - Parsing XML using Java Tutorial
Student marks calculation program in Java
Handling Fractions in Java
Calculate average sale of the week in Java
How to create an array and method in JSP
How to use set, get basic and nested properties for Spring framework
Converting a number into its equalant value in words in Java
What is Java?
Using Parameters in JasperReports
Most Emailed Articles (in Java)
Converting a number into its equalant value in words in Java
java.lang.reflect package
Disadvantages of using Native methods in Java
What is UCS? What is ISO 10646?
Generating Your Key Pair example using keytool in Java
Operator Precedence in Java
PushbackReader sample program in Java
concat(), replace(), and trim() Strings in Java
instanceof sample program in Java
Use of - new - in Java
The Benefits of OOP
Increment and Decrement Operator
Characters in java
The continuing Revolution of java
Why java is important to the Internet