THE JASPERREPORTS ULTIMATE GUIDE
PAGE I
THE JASPERREPORTS ULTIMATE GUIDE
The JasperReports Ultimate Guide Third Edition
Copyright © 2011 Jaspersoft Corporation. All rights reserved. Printed in the U.S.A.
Jaspersoft, the Jaspersoft logo, Jaspersoft iReport Designer, JasperReports Library,
JasperReports Server, Jaspersoft OLAP, and Jaspersoft ETL are trademarks and/or registered
trademarks of Jaspersoft Corporation in the United States and in jurisdictions throughout the
world. All other company and product names are or may be trade names or trademarks of
their respective owners.
This is version 0811-UGJ37-6 of the JasperReports Ultimate Guide.
PAGE II
THE JASPERREPORTS ULTIMATE GUIDE
TABLE OF CONTENTS
G
ETTING
S
TARTED
.............................................................................................1
I
NSTALLING
J
ASPER
R
EPORTS
....................................................................................1
R
EQUIREMENTS
.....................................................................................................1
X11/H
EADLESS
J
AVA
.............................................................................................3
B
UILDING
THE
S
OURCE
F
ILES
AND
R
UNNING
THE
S
AMPLES
.............................................3
A
NT
B
UILD
T
OOL
...............................................................................................................................3
B
UILDING
THE
P
ROJECT
FROM
S
OURCE
F
ILES
..........................................................................................4
R
UNNING
THE
S
AMPLES
.......................................................................................................................4
HSQLDB D
EMO
D
ATABASE
...............................................................................................................4
W
ORKING
WITH
R
EPORT
T
EMPLATES
......................................................................6
C
REATING
R
EPORT
T
EMPLATES
................................................................................6
R
EPORT
D
ESIGN
P
REVIEW
.......................................................................................7
L
OADING
AND
S
TORING
R
EPORT
T
EMPLATE
F
ILES
.........................................................8
C
OMPILING
R
EPORT
T
EMPLATES
.............................................................................10
E
XPRESSIONS
S
CRIPTING
L
ANGUAGE
........................................................................10
R
EPORT
C
OMPILERS
............................................................................................11
A B
RIEF
H
ISTORY
OF
R
EPORT
C
OMPILATION
..........................................................................................12
C
ONFIGURATION
P
ROPERTIES
TO
C
USTOMIZE
R
EPORT
C
OMPILATION
............................................................13
JDT C
OMPILER
–S
PECIFIC
C
ONFIGURATION
P
ROPERTIES
..........................................................................15
A
NT
T
ASKS
........................................................................................................15
A
NT
T
ASKS
FOR
C
OMPILING
R
EPORTS
.....................................................................15
A
TTRIBUTES
OF
THE
R
EPORT
T
EMPLATE
C
OMPILATION
T
ASK
......................................................................16
A
NT
T
ASK
FOR
D
ECOMPILING
R
EPORTS
................................................................................................17
A
NT
T
ASK
FOR
U
PDATING
R
EPORTS
....................................................................................................17
F
ILLING
R
EPORT
T
EMPLATES
..............................................................................19
R
EPORTING
D
ATA
................................................................................................20
G
ENERATED
R
EPORTS
..........................................................................................21
F
ILLING
O
RDER
(V
ERTICAL
/H
ORIZONTAL
F
ILLING
).......................................................21
PAGE III
THE JASPERREPORTS ULTIMATE GUIDE
A
SYNCHRONOUS
R
EPORT
F
ILLING
...........................................................................22
H
ANDLING
G
ENERATED
R
EPORTS
........................................................................24
L
OADING
AND
S
AVING
G
ENERATED
R
EPORTS
.............................................................24
V
IEWING
R
EPORTS
...............................................................................................25
P
RINTING
R
EPORTS
..............................................................................................27
E
XPORTING
R
EPORTS
...........................................................................................28
L
ARGE
F
ILE
S
UPPORT
.......................................................................................30
F
ILE
V
IRTUALIZER
................................................................................................31
S
WAP
F
ILE
V
IRTUALIZER
.......................................................................................31
I
N
-M
EMORY
GZIP V
IRTUALIZER
.............................................................................32
API O
VERVIEW
...............................................................................................33
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.
DESIGN
.J
ASPER
D
ESIGN
............................................................................33
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.J
ASPER
R
EPORT
.....................................................................................34
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.J
ASPER
C
OMPILE
M
ANAGER
........................................................................34
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.J
ASPER
P
RINT
........................................................................................34
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.JRD
ATA
S
OURCE
...................................................................................34
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.JRR
ESULT
S
ET
D
ATA
S
OURCE
....................................................................35
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.
DATA
.JRB
EAN
A
RRAY
D
ATA
S
OURCE
AND
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.
DATA
.JRB
EAN
C
OLLECTION
D
ATA
S
OURCE
.....................................................35
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.
DATA
.JRX
ML
D
ATA
S
OURCE
......................................................................35
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.JRE
MPTY
D
ATA
S
OURCE
..........................................................................35
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.J
ASPER
F
ILL
M
ANAGER
..............................................................................36
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.JRA
BSTRACT
S
CRIPLET
............................................................................36
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.JRD
EFAULT
S
CRIPTLET
............................................................................36
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.J
ASPER
P
RINT
M
ANAGER
...........................................................................37
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.J
ASPER
E
XPORT
M
ANAGER
........................................................................37
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.J
ASPER
R
UN
M
ANAGER
............................................................................37
NET
.
SF
.
JASPERREPORTS
.
VIEW
.JRV
IEWER
..............................................................................................37
NET
.
SF
.
JASPERREPORTS
.
VIEW
.J
ASPER
V
IEWER
.........................................................................................38
NET
.
SF
.
JASPERREPORTS
.
VIEW
.J
ASPER
D
ESIGN
V
IEWER
...............................................................................38
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.
UTIL
.JRL
OADER
.....................................................................................38
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.
UTIL
.JRS
AVER
.......................................................................................38
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.
XML
.JRX
ML
L
OADER
................................................................................38
NET
.
SF
.
JASPERREPORTS
.
ENGINE
.
XML
.JRP
RINT
X
ML
L
OADER
........................................................................39
R
EPORT
T
EMPLATE
S
TRUCTURE
..........................................................................40
JRXML...........................................................................................................40
XSD R
EFERENCE
...............................................................................................40
JRXML E
NCODING
.............................................................................................41
R
EPORT
T
EMPLATE
P
ROPERTIES
.............................................................................42
PAGE IV
THE JASPERREPORTS ULTIMATE GUIDE
R
EPORT
N
AME
................................................................................................................................43
L
ANGUAGE
..................................................................................................................................... 43
C
OLUMN
C
OUNT
.............................................................................................................................. 43
P
RINT
O
RDER
.................................................................................................................................43
P
AGE
S
IZE
..................................................................................................................................... 44
P
AGE
O
RIENTATION
..........................................................................................................................44
P
AGE
M
ARGINS
............................................................................................................................... 45
C
OLUMN
S
IZE
AND
S
PACING
...............................................................................................................45
E
MPTY
D
ATA
S
OURCE
B
EHAVIOR
........................................................................................................45
T
ITLE
AND
S
UMMARY
S
ECTION
P
LACEMENT
............................................................................................46
C
OLUMN
F
OOTER
P
LACEMENT
............................................................................................................46
S
CRIPTLET
C
LASS
............................................................................................................................46
R
ESOURCE
B
UNDLE
..........................................................................................................................47
M
ISSING
R
ESOURCES
B
EHAVIOR
.........................................................................................................47
P
AGINATION
....................................................................................................................................47
F
ORMATTING
N
UMBERS
, D
ATES
,
AND
T
IMES
...........................................................................................47
C
USTOM
P
ROPERTIES
...........................................................................................48
I
MPORTING
P
ACKAGES
..........................................................................................49
S
TYLES
.............................................................................................................49
R
EPORT
S
TYLE
N
AME
......................................................................................................................51
D
EFAULT
R
EPORT
S
TYLE
...................................................................................................................51
C
ASCADING
R
EPORT
S
TYLES
..............................................................................................................51
C
ONDITIONAL
S
TYLES
....................................................................................................................... 51
R
EFERENCING
A
R
EPORT
S
TYLE
..........................................................................................................53
S
TYLE
TEMPLATES
............................................................................................................................ 53
R
EPORTING
D
ATA
............................................................................................56
E
XPRESSIONS
.....................................................................................................56
S
YNTAX
......................................................................................................................................... 57
C
ALCULATOR
.................................................................................................................................. 58
B
UILT
-I
N
F
UNCTIONS
........................................................................................................................ 59
C
ONDITIONAL
E
XPRESSIONS
............................................................................................................... 59
P
ARAMETERS
......................................................................................................60
P
ARAMETER
N
AME
........................................................................................................................... 60
P
ARAMETER
C
LASS
..........................................................................................................................61
P
ROMPTING
FOR
P
ARAMETER
V
ALUES
..................................................................................................61
P
ARAMETER
C
USTOM
P
ROPERTIES
.......................................................................................................61
P
ARAMETER
D
EFAULT
V
ALUE
.............................................................................................................62
B
UILT
-I
N
R
EPORT
P
ARAMETERS
..........................................................................................................62
D
ATA
S
OURCES
..................................................................................................67
JDBC D
ATA
S
OURCE
...................................................................................................................... 68
J
AVA
B
EANS
D
ATA
S
OURCES
..............................................................................................................69
M
AP
-B
ASED
D
ATA
S
OURCES
.............................................................................................................71
T
ABLE
M
ODEL
D
ATA
S
OURCE
.............................................................................................................71
XML D
ATA
S
OURCES
...................................................................................................................... 72
PAGE V
