Search code examples
jasper-reports

What is the difference between variable, parameter and field in JasperReports?


I am a newbie to JasperReports, have been working on some small samples. It seems "Fields", "Parameters" and "Variables" are very commonly used to demonstrate dynamic data and looks much alike. So can I ask what's their difference specifically in JasperReports?

I guess variable is something defined within a Jasper report and can dynamically change. Parameter is something taking from external source (Java..etc), field is for entities (database schema, class entity), but I don't think my understand is all right.


Solution

  • From my personal experience with JasperReports i can deduce that you will be using Parameters and Fields the most. Parameters and fields are memory locations or values which you can populate from your code, i.e when you generate the report.

    What you would usually be doing is populating a parameter map or maps with different settings for your report. I use parameters if i have a summary page or a cover page (the very first in a report) Something like:

    parameters.put("authorName", author); //where authorName is a parameter you have created in your JRXML template.
    

    Next, you might be using some custom "variables" or you might be using variables provided from JasperReports. Some of those useful variables are: PAGE_COUNT and PAGE_NUMBER. They keep track of... report page counts and page numbers. Of course you can have custom variables.

    Fields are used where data changes frequently. They are quite similar to parameters but with each iteration the data might change. Like, a field might be a list of germanCar objects for one iteration and a list of japaneseCar object for the next. I would use a field to hold the list of Car objects that might change.

    Bottom line is parameters and fields are quite similar, but fields are populated from the JasperReportDataSource (so they can change frequently as you are populating that datasource), while parameters you would use for cover pages or custom JR settings WHILE generating the report itself. They could be quite confusing.

    Hope this helps a bit!