5
5
JasperReports 14 15 16 17 18 19 20 21 22
JasperReports - Bevezető ismeretek
<path i d=" c l a s s p a t h "> < f i l e s e t d i r=" ${ l i b . d i r } ">
23 24 25 26 27 28 29 30
31 32 33 34 35 36 37
38 39 40 41 42 43 44 45 46 47 48 49 50 51
52 53 54 55 56 57 58 59 60 61
6
JasperReports
JasperReports - Bevezető ismeretek
62 63 < f i l e s e t d i r=" ${my . d i r } "> 64 65 66 67 68 69
• view : Elindítja a Report Viewert megnézni a jrprint fájlt • clean: Minden generált fájlt letöröl • writeApi Az ant script első 20 sora a meghívható parancsok (target-ek) működési környezetének beállításáról szól, ami lényegében azt jelenti most, 1.2. ábra: A Jasper Design Viewer alkalmazás hogy a Java CLASSPATH helyesen legyen beállítva, azaz ismert legyen az összes jar fájl. A A fenti build.xml a következő target-eket, default target a viewDesignXML, ahogy azt a azaz parancsokat tartalmazza, amit a ant - 4. sor project tag-jénél látjuk is. Ez azt jelenti, hogy az projecthelp paranccsal lehet kiíratni: • viewDesignXML: A Design Viewer haszná- ant viewDesignXML lata megnézni a tervezett XML report dehajtódik végre egy egyszerű ant parancsra, signt aminek eredményeképpen az 1.2. ábra ablaka jelenik meg. Ez annyit tud, hogy a minden• viewDesign: A Design Viewer hasznnálata kori design-t, azaz a JRXML vizuális kinézetet megnézni a lefordított riportot tekinthetjük meg vele. Esetünkben a file.name • compile: A jrxml fájl fordítása jasper bi- script változó értéke HelloWorld, ugyanis a megnáris fájlra tekintendő fájl neve: HelloWorld.jrxml. Itt a 7
JasperReports
JasperReports - Bevezető ismeretek
XML argumentumnak pont az a szerepe, hogy tényleg a forrás tervet nézzük meg. Az ant compile parancs a már említett jrxml (XML szöveg) → jasper (lefordított, bináris forma) fordítás végzi el a HelloWorld riportra, megkapva ezzel a HelloWorld.jasper fájlt. Az
Egy riport elkészítése után a HelloWorld.jrprint fájlt kapjuk, ami JasperReports formátumban tartalmazza a létrehozott jelentést. Az 1.3. ábra mutatja a Jasper Viewer alkalmazást, amit be lehet építeni a programunkba, mert képes a képernyőn megjeleníteni vagy akár kinyomtatni a keletkezett eredményt. ant view Desi gn Ez a JasperViewer osztály parancssorból is elhívás már ezzel a bináris, natív formával kéindítható: pes megmutatni a leendő jelentés kinézetét, amihez szintén a Jasper Design Viewer alkalmazást ant view használja. A build.xml clean opciója a generált fájlokat törli le. A writeApi a JRAntApiWriteTask ant taszk használatát mutatja meg. Amennyiben lefuttatjuk, úgy esetünkben most a build/reports könyvtárba nem a jasper fájlt generálja le, hanem helyette egy jrxml→java fordítást végez, azaz megtekinthetjük a riport definíció java forráskódját. Ez elsősorban hibakereséshez jelenthet egy hatékony eszközt, de a gyakorlatban erre nagyon ritkán kerül sor, amennyiben mi egy egyszerű riportkészítő programozók vagyunk. Érdekességként az 1-3. Programlista tartalmazza az így létrehozott java forráskódot, amire minden1.3. ábra: A Jasper Viewer alkalmazás képpen érdemes egy pillantást vetni. // 1−3. P r o g r a m l i s t a : Hel loW orl d . j a v a /∗ ∗ Generated by J a s p e r R e p o r t s − 2 0 1 2 . 1 2 . 2 1 . 1 0 : 5 9 ∗/ import j a v a . awt . C o l o r ; import o r g . j f r e e . c h a r t . p l o t . P l o t O r i e n t a t i o n ; import o r g . j f r e e . c h a r t . r e n d e r e r . xy . XYBubbleRenderer ; import import import import import import import import import import import import
net . net . net . net . net . net . net . net . net . net . net . net .
sf sf sf sf sf sf sf sf sf sf sf sf
. . . . . . . . . . . .
jasperreports jasperreports jasperreports jasperreports jasperreports jasperreports jasperreports jasperreports jasperreports jasperreports jasperreports jasperreports
. charts . ∗ ; . charts . design . ∗ ; . charts . u t i l . ∗ ; . crosstabs . ∗ ; . crosstabs . design . ∗ ; . crosstabs . f i l l . calculation . BucketDefinition ; . engine . ∗ ; . e n g i n e . b a s e . JRBaseChartPlot . J R B a s e S e r i e s C o l o r ; . e n g i n e . b a s e . JRBaseFont ; . engine . design . ∗ ; . engine . type . ∗ ; . engine . u t i l . ReportCreator ;
public c l a s s HelloWorld implements R e p o r t C r e a t o r {
8
JasperReports
JasperReports - Bevezető ismeretek
public J a s p e r D e s i g n c r e a t e ( ) throws JRException { J a s p e r D e s i g n j a s p e r D e s i g n = new J a s p e r D e s i g n ( ) ; j a s p e r D e s i g n . setName ( " F i r s t R e p o r t " ) ; j a sp e r D e s ig n . setLanguage ( " java " ) ; j a s p e r D e s i g n . setPageWidth ( 5 9 5 ) ; jasperDesign . setPageHeight ( 842) ; j a s p e r D e s i g n . setColumnWidth ( 5 5 5 ) ; j a s p e r D e s i g n . setColumnSpacing ( 0 ) ; jasperDesign . setLeftMargin ( 20) ; jasperDesign . setRightMargin ( 20) ; j a s p e r D e s i g n . setTopMargin ( 3 0 ) ; j a s p e r D e s i g n . setBottomMargin ( 3 0 ) ; JRDesignDataset r e p o r t M a i n D a t a s e t = new JRDesignDataset ( true ) ; r e p o r t M a i n D a t a s e t . setName ( " F i r s t R e p o r t " ) ; jasperDesign . setMainDataset ( reportMainDataset ) ; // d e t a i l B a n d // band name = d e t a i l B a n d 0 JRDesignBand d e t a i l B a n d 0 = new JRDesignBand ( ) ; detailBand0 . setHeight ( 20) ; d e t a i l B a n d 0 . s e t S p l i t T y p e ( n e t . s f . j a s p e r r e p o r t s . e n g i n e . t y p e . SplitTypeEnum .STRETCH) ; J R D e s i g n S t a t i c T e x t detailBand0_0 = new J R D e s i g n S t a t i c T e x t ( j a s p e r D e s i g n ) ; detailBand0_0 . s e t P o s i t i o n T y p e ( n e t . s f . j a s p e r r e p o r t s . e n g i n e . t y p e . PositionTypeEnum . å FIX_RELATIVE_TO_TOP) ; detailBand0_0 . setX ( 2 0 ) ; detailBand0_0 . setY ( 0 ) ; detailBand0_0 . setWidth ( 2 0 0 ) ; detailBand0_0 . s e t H e i g h t ( 2 0 ) ; JRParagraph detailBand0_0Paragraph = detailBand0_0 . g e t P a r a g r a p h ( ) ; detailBand0_0 . s e t T e x t ( " ␣ H e l l ó ␣ V i l á g ! ␣ " ) ; d e t a i l B a n d 0 . addElement ( detailBand0_0 ) ; ( ( J R D e s i g n S e c t i o n ) j a s p e r D e s i g n . g e t D e t a i l S e c t i o n ( ) ) . g e t B a n d s L i s t ( ) . add ( 0 , d e t a i l B a n d 0 ) ;
}
}
return j a s p e r D e s i g n ;
Általában persze nem parancssori eszköz• single star (*): Illeszkedik 0 vagy több karakterre a PATH neven belül, de annak csak egy adott zel dolgozunk, hanem az iReport tervezővel, de szintjét tekintve. mégis érdemes az ismertetett ant script lehetőségeivel tisztában lennünk, mert egyrészt jobb át• double star (**): Illeszkedik 0 vagy több karakterre a PATH neven belül és a teljes directory úttekintést kapunk az eszközrendszerről, másrészt vonalat nézi, bizonyos feladatokat (tipikusan a jrxml →jasper fordítást) hatékonyabban lehet vele elvégezni. • question mark (?): Pontosan 1 tetszőleges karakternyi illeszkedés a PATH neven belül Ugyanakkor a Jasper Viewer egy olyan kész panel, amit az alkalmazásainkba is beépíthetünk. A jobb megértés érdekében tekintsük a következő könyvtár és fájl elrendezést:
1. bar.txt (a . könyvtárban) Mielőtt továbblépnénk, szeretnénk pár szóban kitérni a build.xml -ben használt alábbi minták jelentésére, ugyanis ezek az ismeretek fontosak és ugyanakkor sokszor nem eléggé ismertek:
2. src/bar.c (a ./src könyvtárban) 3. src/baz.c (a ./src könyvtárban) 4. src/test/bartest.c (a ./src/test könyvtárban) 9
JasperReports
JasperReports - Bevezető ismeretek
Ekkor a *.c kifejezés nem illeszkedik semmire, mert az aktuális könyvtárban nincs ilyen, hiszen ott csak egy bar.txt van. Az src/*.c illeszkedik a 2. és 3. fájlra is. A */*.c hasonlóképpen a 2. és 3. fájlokat választja ki, ugyanis a * csak 1 könyvtár szinten való illeszkedést jelent, a 4. sor pedig 2 könyvtárat is tartalmaz a bartest.c előtt. Amennyiben mégis az összes *.c fájlt szeretnénk, úgy a **/*.c illeszkedik a 2, 3. és 4. fájlra is, mert a ** több szintű könyvtárat jelent. A bar.* természetesen csak az 1. fájlra illeszkedik, de a **/bar.* már az 1. és 2. fájlokra is. Nézzünk még 2 példát! A **/bar*.* az 1, 2 és 4. állományokra, míg az src/ba?.c csak a 2. és 3. fájlokra illeszkedik.
A riport előállítása és megtekintése Az eddigiek során elkészítettük a HelloWorld.jrxml riport tervet és a megfelelő ant paranccsal lefordítottuk azt, így jelenleg rendelkezünk a HelloWorld.jasper fájllal is. Azt tudjuk, hogy a riportunk jelenleg semmilyen külső adatot nem igényel, egyedül csak egy statikus szöveget jelenít meg. Az 1-4. Programlista egy 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
olyan Java programot mutat, amivel elkészíthetjük a jelentésünket, azaz előállíthatjuk a HelloWorld.jrprint állományt. Tekintsünk a forráskódra! A JRHelper class 23-26 sora közötti makeReport() metódus készíti el a riportot. Ez gyakorlatilag a JasperFillManager osztály segítségével történik. Az 1. paraméter a .jasper fájl neve, a 2. a külső paraméterek átvételét biztosító java.util.Map objektum, míg a 3. egy külső adatforrást reprezentáló JRDataSource objektum. Tekintettel arra, hogy most se paraméterünk nincs, se külső adatforrásunk, ezért üres Map-pel és a beépített JREmptyDataSource objektummal hívjuk meg a main() 40. sorában. A JRHelper compile() metódusát általában nem programozottan használjuk, de ugyanazt csinálja, mint az ismertetett ant compile parancs. Ennek az az oka, hogy egy jól letesztelt riportnak általában nem a külalakja változik, hanem a feldolgozott külső adatok, így azt hatékonysági okokból sem érdemes állandóan újrafordítani.
// 1−4. P r o g r a m l i s t a : JRHelper . j a v a package o r g . c s . t e s t ; import import import import import import
j a v a . u t i l . HashMap ; net . s f . j a s p e r r e p o r t s net . s f . j a s p e r r e p o r t s net . s f . j a s p e r r e p o r t s net . s f . j a s p e r r e p o r t s net . s f . j a s p e r r e p o r t s
. e n g i n e . JRDataSource ; . e n g i n e . JREmptyDataSource ; . e n g i n e . JRException ; . e n g i n e . JasperCompileManager ; . engine . JasperFillManager ;
/∗ ∗ ∗ ∗ @author i n y i r i ∗/ public c l a s s JRHelper { public void c o m p i l e ( S t r i n g jrxmlFileName ) throws JRException { JasperCompileManager . c o m p i l e R e p o r t T o F i l e ( jrxmlFileName ) ; } public void makeReport ( S t r i n g j a s p e r F i l e N a m e , HashMap params , JRDataSource j r D s ) throws å JRException { J a s p e r F i l l M a n a g e r . f i l l R e p o r t T o F i l e ( j a s p e r F i l e N a m e , params , j r D s ) ; }
24 25 26 27 28 29
public s t a t i c void main ( S t r i n g [ ] a r g s ) throws JRException {
10
JasperReports 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
JasperReports - Bevezető ismeretek
S t r i n g j r x m l F i l e = " /home/ t a n u l a s / j a s p e r r e p o r t / p e l d a −1/ HelloWorld . j r x m l " ; S t r i n g j a s p e r F i l e = " /home/ t a n u l a s / j a s p e r r e p o r t / p e l d a −1/ HelloWorld . j a s p e r " ; JRHelper j h = new JRHelper ( ) ; // //
System . o u t . p r i n t l n (" Compiling r e p o r t . . . " ) ; jh . compile ( j r x m l F i l e ) ; System . out . p r i n t l n ( "Make␣ r e p o r t . . . " ) ; JRDataSource e d s = new JREmptyDataSource ( ) ; j h . makeReport ( j a s p e r F i l e , new HashMap ( ) , e d s ) ; }
System . out . p r i n t l n ( "Done ! " ) ;
} // end c l a s s
A JRHelper program lefuttatása után keletkezik a HelloWorld.jrprint fájl, amit a már ismert eszközzel (1.3. ábra) lehet megnézni az ant view parancs segítségével. Végezetül vessünk
egy pillantást az iReport RAD eszközre (1.4. ábra), és haladjunk tovább a következő fejezeteken, amik áttekintik a JasperReports összes fontos lehetőségét!
1.4. ábra: iReport 5
11
JasperReports
2.
Adatbázis alapú dinamikus riport készítése
Adatbázis alapú dinamikus riport készítése
Ebben a részben bemutatjuk az adatbázis lekérdezésekre épülő, dinamikus riportkészítés alapjait. Kétféle technikával fogunk megismerkedni. Az első az SQL query-t a jrxml fájlba ágyazva mutatja be, mely során bemutatjuk a riportok paraméterezési lehetőségét is. A második a JRDataSource objektumra épülő megoldás, ahol nincs már szükség a queryString tag-et beágyazni a jrxml állományba. A példákhoz az Informatikai Navigátor 7. számában megismert HSQLDB adatbáziskezelőt fogjuk használni. Vegyük észre, hogy egy természeténél fogva hierarchikus felépítésű riport leírására az XML kiAdatbáziskezelő fejezetten alkalmas eszköz, hiszen gyakorlatilag Tekintettel arra, hogy szükségünk lesz egy adat- abban a szerkezetben tudjuk a jelentés templatebáziskezelőre, indítsuk el a HSQLDB-t szerver et vele elkészíteni, ahogy annak majd ki kell nézmódba, amihez részletes segítséget kapunk az nie. Informatikai Navigátor 7. számából. A megismert orszagok táblára épülő select paranccsal A riport szakaszai fogunk dinamikus adatokat szolgáltatni a jelenA következő nagyobb riport szakaszokat részletetésünk részére. sebben az iReport bemutatásánál fogjuk ismertetni, itt csak megemlítjük a szerepüket. JRXML fejlesztés – iReport
A használt fejlesztői környezet
A továbbiakban a riport tervezési munkát általában az iReport eszközzel fogjuk végezni, így azt is indítsuk el. Első lépésként frissítjük a csomaggal érkezett HSQLDB jdbc drivert arra a verzióra, amit jelenleg használunk. Ehhez az iReport Tools→Options→Classpath fülére menjünk. Töröljük ki a régi HSQLDB drivert és vegyük fel az általunk használt frissebb hsqldb.jar fájlt. Ezután kattintsunk a Report Datasources ikonra és vegyünk fel egy új JDBC kapcsolatot a mi adatbázisunkra. Emlékeztetőül megadjuk szerverünk URL-jét: jdbc:hsqldb:hsql://localhost/xdb (user: SA).
Egy JRXML fájl felépítése