PageRenderTime 37ms CodeModel.GetById 9ms RepoModel.GetById 0ms app.codeStats 1ms

/projects/jasperreports-3.7.4/dist/docs/sample.reference/antcompile/index.html

https://gitlab.com/essere.lab.public/qualitas.class-corpus
HTML | 414 lines | 379 code | 35 blank | 0 comment | 0 complexity | d4412d808ffc117d9d641be67bde5b84 MD5 | raw file
    

  1. <html xmlns:jr="http://jasperreports.sourceforge.net/jasperreports" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    2. 

  2. <head>
    3. 

  3. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
    4. 

  4. <title>JasperReports 3.7.4 - Ant Compile Sample</title>
    5. 

  5. <style type="text/css">
    6. 

  6. .title {
    7. 

  7. 	font-family: Arial, Verdana, Helvetica, sans-serif;
    8. 

  8. 	font-size: 28px;
    9. 

  9. 	font-weight: normal;
    10. 

  10. }
    11. 

  11. 

  12. .toc {
    13. 

  13. 	font-family: Courier New, Courier, serif;
    14. 

  14. 	font-size: 12px;
    15. 

  15. 	font-weight: normal;
    16. 

  16. }
    17. 

  17. 

  18. .name {
    19. 

  19. 	font-family: Courier New, Courier, serif;
    20. 

  20. 	font-size: 16px;
    21. 

  21. 	font-weight: bold;
    22. 

  22. }
    23. 

  23. 

  24. .label {
    25. 

  25. 	font-family: Arial, Verdana, Helvetica, sans-serif;
    26. 

  26. 	font-size: 12px;
    27. 

  27. 	font-weight: bold;
    28. 

  28. 	font-style: italic;
    29. 

  29. }
    30. 

  30. 

  31. .description {
    32. 

  32. 	font-family: Arial, Verdana, Helvetica, sans-serif;
    33. 

  33. 	font-size: 12px;
    34. 

  34. 	font-weight: normal;
    35. 

  35. }
    36. 

  36. 

  37. .value {
    38. 

  38. 	font-family: Courier New, Courier, serif;
    39. 

  39. 	font-size: 12px;
    40. 

  40. 	font-weight: normal;
    41. 

  41. }
    42. 

  42. 

  43. .element {
    44. 

  44. 	font-family: Courier New, Courier, serif;
    45. 

  45. 	font-size: 12px;
    46. 

  46. 	font-weight: normal;
    47. 

  47. }
    48. 

  48. 

  49. .attribute {
    50. 

  50. 	font-family: Courier New, Courier, serif;
    51. 

  51. 	font-size: 12px;
    52. 

  52. 	font-weight: bold;
    53. 

  53. }
    54. 

  54. 

  55. .code {
    56. 

  56. 	font-family: Courier New, Courier, serif;
    57. 

  57. 	font-size: 12px;
    58. 

  58. 	font-weight: normal;
    59. 

  59. }
    60. 

  60. </style>
    61. 

  61. </head>
    62. 

  62. <body bgcolor="#FFFFFF">
    63. 

  63. <a name="top"></a>
    64. 

  64. <table width="100%" border="0" cellpadding="0" cellspacing="0">
    65. 

  65. <tr>
    66. 

  66. <td align="right" colspan="2"><span class="element"><a href="../../sample.reference.html">Sample Reference</a> - <a href="../../schema.reference.html">Schema Reference</a> - <a href="../../config.reference.html">Configuration Reference</a> - <a href="http://jasperreports.sourceforge.net/api/index.html">API (Javadoc)</a></span>
    67. 

  67. <br>
    68. 

  68. </td>
    69. 

  69. </tr>
    70. 

  70. <tr>
    71. 

  71. <td colspan="2">
    72. 

  72. <hr size="1">
    73. 

  73. </td>
    74. 

  74. </tr>
    75. 

  75. <tr valign="middle">
    76. 

  76. <td nowrap="true"><span class="title">JasperReports - Ant Compile Sample (version 3.7.4)</span></td><td align="right"><img border="0" src="../../resources/jasperreports.png"></td>
    77. 

  77. </tr>
    78. 

  78. <tr>
    79. 

  79. <td colspan="2">
    80. 

  80. <hr size="1">
    81. 

  81. </td>
    82. 

  82. </tr>
    83. 

  83. </table>
    84. 

  84. <br>
    85. 

  85. <span class="description"><span class="description">Shows how multiple JRXML files can be compiled in batch mode using the ANT build tool.</span></span>
    86. 

  86. <br>
    87. 

  87. <br>
    88. 

  88. <span class="element"><a href="http://sourceforge.net/projects/jasperreports/files/jasperreports/JasperReports%203.7.4/jasperreports-3.7.4-project.zip/download" target="_blank">Download All Sample Source Files</a></span>
    89. 

  89. <br>
    90. 

  90. <span class="element"><a href="http://jasperforge.org/scm/viewvc.php/tags/jr-3-7-4/jasperreports/demo/samples/antcompile/?root=jasperreports" target="_blank">Browse Sample Source Files on SVN</a></span>
    91. 

  91. <table cellspacing="0" cellpadding="0" border="0" width="100%">
    92. 

  92. <tr>
    93. 

  93. <td style="width: 20px;">
    94. 

  94. <br>
    95. 

  95. </td><td>
    96. 

  96. <br>
    97. 

  97. </td>
    98. 

  98. </tr>
    99. 

  99. <tr>
    100. 

  100. <td colspan="2"><span class="label">Main Features in This Sample</span></td>
    101. 

  101. </tr>
    102. 

  102. <tr>
    103. 

  103. <td>
    104. 

  104. <br>
    105. 

  105. </td><td><span class="element"><a href="#antcompile">Compiling Multiple Report Template Files Using the Ant Build Tool</a></span></td>
    106. 

  106. </tr>
    107. 

  107. <tr>
    108. 

  108. <td>
    109. 

  109. <br>
    110. 

  110. </td><td><span class="element"><a href="#antdecompile">Generating the JRXML Source Files for Multiple Compiled Report Template Files Using the Ant Build Tool (Decompiling)</a></span></td>
    111. 

  111. </tr>
    112. 

  112. <tr>
    113. 

  113. <td colspan="2">
    114. 

  114. <br>
    115. 

  115. </td>
    116. 

  116. </tr>
    117. 

  117. <tr>
    118. 

  118. <td colspan="2"><span class="label">Secondary Features</span></td>
    119. 

  119. </tr>
    120. 

  120. <tr>
    121. 

  121. <td></td><td><span class="element"><a href="../groovy/index.html#reportcompilers">Report Compilers</a></span></td>
    122. 

  122. </tr>
    123. 

  123. </table>
    124. 

  124. <table border="0" cellpadding="0" cellspacing="0" width="100%">
    125. 

  125. <tr>
    126. 

  126. <td><img height="1" width="20" border="0" src="../../resources/px.gif"></td><td><img height="1" width="20" border="0" src="../../resources/px.gif"></td><td><img height="1" width="20" border="0" src="../../resources/px.gif"></td><td><img height="1" width="20" border="0" src="../../resources/px.gif"></td><td width="100%">
    127. 

  127. <br>
    128. 

  128. </td>
    129. 

  129. </tr>
    130. 

  130. <tr>
    131. 

  131. <td align="right" colspan="5"><a name="antcompile"></a><a class="toc" href="#top">top</a></td>
    132. 

  132. </tr>
    133. 

  133. <tr>
    134. 

  134. <td colspan="5">
    135. 

  135. <hr size="1">
    136. 

  136. </td>
    137. 

  137. </tr>
    138. 

  138. <tr valign="top">
    139. 

  139. <td><img border="0" src="../../resources/jr-16x16.png"></td><td colspan="4"><span class="name">Compiling Multiple Report Template Files Using the Ant Build Tool</span></td>
    140. 

  140. </tr>
    141. 

  141. <tr>
    142. 

  142. <td colspan="5">
    143. 

  143. <br>
    144. 

  144. </td>
    145. 

  145. </tr>
    146. 

  146. <tr valign="top">
    147. 

  147. <td>
    148. 

  148. <br>
    149. 

  149. </td><td nowrap="true"><span class="label">Description / Goal</span></td><td>
    150. 

  150. <br>
    151. 

  151. </td><td colspan="2"><span class="description">
    152. 

  152. How to compile all your JRXML report source files at application build time using the Ant build tool.
    153. 

  153.     </span></td>
    154. 

  154. </tr>
    155. 

  155. <tr valign="top">
    156. 

  156. <td>
    157. 

  157. <br>
    158. 

  158. </td><td colspan="1"><span class="label">Since</span></td><td>
    159. 

  159. <br>
    160. 

  160. </td><td colspan="2"><span class="description">0.4.6</span></td>
    161. 

  161. </tr>
    162. 

  162. <tr valign="top">
    163. 

  163. <td>
    164. 

  164. <br>
    165. 

  165. </td><td nowrap="true" colspan="1"><span class="label">Other Samples</span></td><td>
    166. 

  166. <br>
    167. 

  167. </td><td colspan="2">
    168. 

  168. <table border="0" cellpadding="0" cellspacing="0" width="100%">
    169. 

  169. <tr>
    170. 

  170. <td><span class="element"><a href="../beanshell/index.html">/demo/samples/beanshell</a></span></td>
    171. 

  171. </tr>
    172. 

  172. <tr>
    173. 

  173. <td><span class="element"><a href="../groovy/index.html">/demo/samples/groovy</a></span></td>
    174. 

  174. </tr>
    175. 

  175. <tr>
    176. 

  176. <td><span class="element"><a href="../java1.5/index.html">/demo/samples/java1.5</a></span></td>
    177. 

  177. </tr>
    178. 

  178. <tr>
    179. 

  179. <td><span class="element"><a href="../javascript/index.html">/demo/samples/javascript</a></span></td>
    180. 

  180. </tr>
    181. 

  181. </table>
    182. 

  182. </td>
    183. 

  183. </tr>
    184. 

  184. <tr>
    185. 

  185. <td colspan="5">
    186. 

  186. <br>
    187. 

  187. </td>
    188. 

  188. </tr>
    189. 

  189. <tr>
    190. 

  190. <td>
    191. 

  191. <br>
    192. 

  192. </td><td colspan="4"><span class="description">
    193. 

  193. The JRXML files represent the source files for static report templates. These report templates need to be 
    194. 

  194. prepared for use at runtime by compiling them into <code>*.jasper</code> files, which are basically serialized 
    195. 

  195. <span class="element"><a href="http://jasperreports.sourceforge.net/api/net/sf/jasperreports/engine/JasperReport.html" target="_blank">JasperReport</a></span> objects, ready for filling with data.
    196. 

  196. <br>
    197. 

  197. 

  198. <br>
    199. 

  199. Report template source files having the <code>*.jrxml</code> file extensions are compiled into serialized object files 
    200. 

  200. having the <code>*.jasper</code> file extension, just like Java source files having the <code>*.java</code> file extension 
    201. 

  201. are transformed into Java bytecode binary files with the <code>*.class</code> file extension.
    202. 

  202. <br>
    203. 

  203. The transformation of <code>*.jrxml</code> files into <code>*.jasper</code> files should be part of the application 
    204. 

  204. build process, just as the compilation of <code>*.java</code> files into <code>*.class</code> files is.
    205. 

  205. In the majority of cases, when the report templates are static and do not change at runtime (only data feed into them changes), 
    206. 

  206. there is no point in deploying source JRXML files  with the application.
    207. 

  207. <br>
    208. 

  208. After all, when deploying a Java application, you deploy <code>*.class</code> files, packaged up in JARs, not source <code>*.java</code> files. 
    209. 

  209. The same technique is applicable to JR report template files, where compiled <code>*.jasper</code> files should be created 
    210. 

  210. at application built time and then deployed as part of the application classpath as resources.
    211. 

  211. <br>
    212. 

  212. 

  213. <br>
    214. 

  214. The JasperReports library provides a built-in Ant task for compiling source JRXML report template files into <code>*.jasper</code> files. 
    215. 

  215. This task is represented by the <span class="element"><a href="http://jasperreports.sourceforge.net/api/net/sf/jasperreports/ant/JRAntCompileTask.html" target="_blank">JRAntCompilerTask</a></span> task and 
    216. 

  216. works very similar to the Ant built-in <a href="http://ant.apache.org/manual/CoreTasks/javac.html" target="_blank"><span class="element">Javac</span></a> task.
    217. 

  217. <br>
    218. 

  218. 

  219. <br>
    220. 

  220. This task scans source folders and looks up for report template files (usually having the JRXML file extension) 
    221. 

  221. and compiles them into <code>*.jasper</code> files which are placed into a destination folder hierarchy.
    222. 

  222. <br>
    223. 

  223. The destination folder tree is similar to the source folder tree, meaning that the relative location of source files from 
    224. 

  224. the root source folder is preserved for the resulting <code>*.jasper</code> files.
    225. 

  225. <br>
    226. 

  226. 

  227. <br>
    228. 

  228. Similar to the <code>Javac</code> task, the source folders can be specified using either the <code>srcdir</code> attribute 
    229. 

  229. of the task (when there is only one root source folder) or using a nested <code>&lt;src&gt;</code> tag (when source files 
    230. 

  230. are scattered across multiple paths).
    231. 

  231. 

  232. <br>
    233. 

  233. 

  234. <br>
    235. 

  235. Open the <code>build.xml</code> file in the current sample and notice how the custom Ant task called <code>jrc</code> is defined:
    236. 

  236. <br>
    237. 

  237. 

  238. <br>
    239. 

  239. 

  240. <pre>
    241. 

  241. &lt;taskdef name="jrc" classname="net.sf.jasperreports.ant.JRAntCompileTask"&gt; 
    242. 

  242.   &lt;classpath refid="classpath"/&gt;
    243. 

  243. &lt;/taskdef&gt;
    244. 

  244. 

  245. </pre>
    246. 

  246. This task definition uses a <code>&lt;classpath&gt;</code> element which contains the JasperReports JAR and all its required dependencies.
    247. 

  247. <br>
    248. 

  248. 

  249. <br>
    250. 

  250. Then, the custom <code>jrc</code> task is used to compile report templates having the <code>*.jrxml</code> file extension found under 
    251. 

  251. the sample's <code>reports</code> folder. This source folder is specified using the <code>srcdir</code> attribute of the <code>jrc</code> task 
    252. 

  252. in the <code>compile1</code> target of the <code>build.xml</code> file:
    253. 

  253. <br>
    254. 

  254. 

  255. <br>
    256. 

  256. 

  257. <pre>
    258. 

  258. &lt;target name="compile1"&gt; 
    259. 

  259.   &lt;mkdir dir="./build/reports"/&gt; 
    260. 

  260.   &lt;jrc 
    261. 

  261.     srcdir="./reports"
    262. 

  262.     destdir="./build/reports"
    263. 

  263.     tempdir="./build/reports"
    264. 

  264.     keepjava="true"
    265. 

  265.     xmlvalidation="true"&gt;
    266. 

  266.    &lt;classpath refid="runClasspath"/&gt;
    267. 

  267.    &lt;include name="**/*.jrxml"/&gt;
    268. 

  268.   &lt;/jrc&gt;
    269. 

  269. &lt;/target&gt; 
    270. 

  270. 

  271. </pre>
    272. 

  272. The <code>compile2</code> target in the same <code>build.xml</code> file performs the same report compilation process, 
    273. 

  273. but the source folder is specified using a nested <code>&lt;src&gt;</code> tag with filesets. The nested source tag allows compiling report 
    274. 

  274. templates that are scattered through many different locations and are not grouped under a single root report source folder.
    275. 

  275. <br>
    276. 

  276. 

  277. <br>
    278. 

  278. 

  279. <pre>
    280. 

  280. &lt;target name="compile2"&gt;
    281. 

  281.   &lt;mkdir dir="./build/reports"/&gt; 
    282. 

  282.   &lt;jrc 
    283. 

  283.     destdir="./build/reports"
    284. 

  284.     tempdir="./build/reports"
    285. 

  285.     keepjava="true"
    286. 

  286.     xmlvalidation="true"&gt;
    287. 

  287.    &lt;src&gt;
    288. 

  288.     &lt;fileset dir="./reports"&gt;
    289. 

  289.      &lt;include name="**/*.jrxml"/&gt;
    290. 

  290.     &lt;/fileset&gt;
    291. 

  291.    &lt;/src&gt;
    292. 

  292.    &lt;classpath refid="runClasspath"/&gt;
    293. 

  293.   &lt;/jrc&gt; 
    294. 

  294. &lt;/target&gt; 
    295. 

  295. 

  296. </pre>
    297. 

  297. Notice that both report compilation targets have a <code>&lt;classpath&gt;</code> nested element, used to specify the classpath used by the report 
    298. 

  298. compiler. This so called run-classpath contains classes that are referenced inside the report templates themselves, such as scriptlet classes, 
    299. 

  299. chart customizers and so forth.
    300. 

  300. <br>
    301. 

  301. In this particular sample, both source JRXML files make use of such helper classes found in the <code>src</code> folder of the samples. 
    302. 

  302. These helper classes have to be compiled before the report templates are compiled, using the <code>javac</code> target of the <code>build.xml</code> file.
    303. 

  303. <br>
    304. 

  304. 

  305. <br>
    306. 

  306. In addition to the <code>srcdir</code> and the <code>destdir</code> attributes, the <code>jrc</code> custom Ant task shipped with JasperReports 
    307. 

  307. supports the following attributes:
    308. 

  308. <br>
    309. 

  309. 

  310. <br>
    311. 

  311. 

  312. <ul>
    313. 

  313. 

  314. <li>
    315. 

  315. <code>compiler</code> : Name of the class that implements the <span class="element"><a href="http://jasperreports.sourceforge.net/api/net/sf/jasperreports/engine/design/JRCompiler.html" target="_blank">JRCompiler</a></span> interface to be used for compiling the reports (optional).</li>
    316. 

  316. 

  317. <li>
    318. 

  318. <code>xmlvalidation</code> : Flag to indicate whether the XML validation should be performed on the source report template files (<code>true</code> by default).</li>
    319. 

  319. 

  320. <li>
    321. 

  321. <code>tempdir</code> : Location to store the temporarily generated files (the current working directory by default).</li>
    322. 

  322. 

  323. <li>
    324. 

  324. <code>keepjava</code> : Flag to indicate if the temporary Java files generated on the fly should be kept and not deleted automatically (<code>false</code> by default).</li>
    325. 

  325. 

  326. </ul>
    327. 

  327. 

  328. <br>
    329. 

  329. 

  330. <br>
    331. 

  331. In our sample, we use the default report compiler, which is the JDT-based compiler, because the JDT JAR is found in the classpath. 
    332. 

  332. This compiler works on the assumption that report expressions are Java expressions and thus it produces a Java class file dynamically containing 
    333. 

  333. all the report expressions and compiles it using the JDT Java compiler. Normally, this report compiler does all the Java class file generation 
    334. 

  334. and compilation in-memory and does not work with actual files on disk, which makes it very flexible and easy to deploy in all environments. 
    335. 

  335. However, if the <code>keepjava</code> flag is turned to <code>true</code>, it will save the report's temporary Java source file on disk, 
    336. 

  336. in the specified <code>tempdir</code>. This is useful for debugging report expressions in certain cases.
    337. 

  337. <br>
    338. 

  338. 

  339. <br>
    340. 

  340. Depending on the report expression language they are mapped to, other report compiler implementations might produce script files instead of Java files, 
    341. 

  341. for report expression evaluation. The <code>keepjava</code> and the <code>tempdir</code> attributes will still work for them, except that the files 
    342. 

  342. that will be kept into the temporary location will not be Java source files but script files, also helpful for debugging.
    343. 

  343.     </span></td>
    344. 

  344. </tr>
    345. 

  345. <tr>
    346. 

  346. <td colspan="5">
    347. 

  347. <br>
    348. 

  348. </td>
    349. 

  349. </tr>
    350. 

  350. <tr>
    351. 

  351. <td align="right" colspan="5"><a name="antdecompile"></a><a class="toc" href="#top">top</a></td>
    352. 

  352. </tr>
    353. 

  353. <tr>
    354. 

  354. <td colspan="5">
    355. 

  355. <hr size="1">
    356. 

  356. </td>
    357. 

  357. </tr>
    358. 

  358. <tr valign="top">
    359. 

  359. <td><img border="0" src="../../resources/jr-16x16.png"></td><td colspan="4"><span class="name">Generating the JRXML Source Files for Multiple Compiled Report Template Files Using the Ant Build Tool (Decompiling)</span></td>
    360. 

  360. </tr>
    361. 

  361. <tr>
    362. 

  362. <td colspan="5">
    363. 

  363. <br>
    364. 

  364. </td>
    365. 

  365. </tr>
    366. 

  366. <tr valign="top">
    367. 

  367. <td>
    368. 

  368. <br>
    369. 

  369. </td><td nowrap="true"><span class="label">Description / Goal</span></td><td>
    370. 

  370. <br>
    371. 

  371. </td><td colspan="2"><span class="description">
    372. 

  372. How to re-create the JRXML source files for multiple compiled report templates using the Ant build tool. 
    373. 

  373. This is useful in cases where only the compiled <code>*.jasper</code> files of older reports are available, 
    374. 

  374. the initial <code>*.jrxml</code> source files being lost.
    375. 

  375.     </span></td>
    376. 

  376. </tr>
    377. 

  377. <tr valign="top">
    378. 

  378. <td>
    379. 

  379. <br>
    380. 

  380. </td><td colspan="1"><span class="label">Since</span></td><td>
    381. 

  381. <br>
    382. 

  382. </td><td colspan="2"><span class="description">3.7.1</span></td>
    383. 

  383. </tr>
    384. 

  384. <tr>
    385. 

  385. <td colspan="5">
    386. 

  386. <br>
    387. 

  387. </td>
    388. 

  388. </tr>
    389. 

  389. <tr>
    390. 

  390. <td>
    391. 

  391. <br>
    392. 

  392. </td><td colspan="4"><span class="description">
    393. 

  393. [Under Construction]
    394. 

  394.     </span></td>
    395. 

  395. </tr>
    396. 

  396. <tr>
    397. 

  397. <td colspan="5">
    398. 

  398. <br>
    399. 

  399. </td>
    400. 

  400. </tr>
    401. 

  401. </table>
    402. 

  402. <br>
    403. 

  403. <table width="100%" border="0" cellpadding="0" cellspacing="0">
    404. 

  404. <tr>
    405. 

  405. <td>
    406. 

  406. <hr size="1">
    407. 

  407. </td>
    408. 

  408. </tr>
    409. 

  409. <tr>
    410. 

  410. <td align="center"><span style="font-decoration:none;font-family:Verdana,Arial,Helvetica,sans-serif;font-size:8pt;font-style:normal;color:#000000;">&copy; 2001-2010 Jaspersoft Corporation <a style="color:#000000;" target="_blank" href="http://www.jaspersoft.com">www.jaspersoft.com</a></span></td>
    411. 

  411. </tr>
    412. 

  412. </table>
    413. 

  413. </body>
    414. 

  414. </html>
    415. 

  415.