PageRenderTime 49ms CodeModel.GetById 19ms RepoModel.GetById 0ms app.codeStats 0ms

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

https://gitlab.com/essere.lab.public/qualitas.class-corpus
HTML | 305 lines | 283 code | 22 blank | 0 comment | 0 complexity | 6777f6641a5669f9160a9219fc265853 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 - XLS Data Source 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 - XLS Data Source 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 the XLS data source implementation could be used to fill reports.</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/xlsdatasource/?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="#xlsdatasource">XLS Data Source</a></span></td>
    106. 

  106. </tr>
    107. 

  107. <tr>
    108. 

  108. <td colspan="2">
    109. 

  109. <br>
    110. 

  110. </td>
    111. 

  111. </tr>
    112. 

  112. <tr>
    113. 

  113. <td colspan="2"><span class="label">Secondary Features</span></td>
    114. 

  114. </tr>
    115. 

  115. <tr>
    116. 

  116. <td></td><td><span class="element"><a href="../datasource/index.html#datasources">Data Sources</a></span></td>
    117. 

  117. </tr>
    118. 

  118. </table>
    119. 

  119. <table border="0" cellpadding="0" cellspacing="0" width="100%">
    120. 

  120. <tr>
    121. 

  121. <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%">
    122. 

  122. <br>
    123. 

  123. </td>
    124. 

  124. </tr>
    125. 

  125. <tr>
    126. 

  126. <td align="right" colspan="5"><a name="xlsdatasource"></a><a class="toc" href="#top">top</a></td>
    127. 

  127. </tr>
    128. 

  128. <tr>
    129. 

  129. <td colspan="5">
    130. 

  130. <hr size="1">
    131. 

  131. </td>
    132. 

  132. </tr>
    133. 

  133. <tr valign="top">
    134. 

  134. <td><img border="0" src="../../resources/jr-16x16.png"></td><td colspan="4"><span class="name">XLS Data Source</span></td>
    135. 

  135. </tr>
    136. 

  136. <tr>
    137. 

  137. <td colspan="5">
    138. 

  138. <br>
    139. 

  139. </td>
    140. 

  140. </tr>
    141. 

  141. <tr valign="top">
    142. 

  142. <td>
    143. 

  143. <br>
    144. 

  144. </td><td nowrap="true"><span class="label">Description / Goal</span></td><td>
    145. 

  145. <br>
    146. 

  146. </td><td colspan="2"><span class="description">
    147. 

  147. How to fill a report using data from an XLS file.
    148. 

  148.     </span></td>
    149. 

  149. </tr>
    150. 

  150. <tr valign="top">
    151. 

  151. <td>
    152. 

  152. <br>
    153. 

  153. </td><td colspan="1"><span class="label">Since</span></td><td>
    154. 

  154. <br>
    155. 

  155. </td><td colspan="2"><span class="description">3.6.1</span></td>
    156. 

  156. </tr>
    157. 

  157. <tr valign="top">
    158. 

  158. <td>
    159. 

  159. <br>
    160. 

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

  161. <br>
    162. 

  162. </td><td colspan="2">
    163. 

  163. <table border="0" cellpadding="0" cellspacing="0" width="100%">
    164. 

  164. <tr>
    165. 

  165. <td><span class="element"><a href="../datasource/index.html">/demo/samples/datasource</a></span></td>
    166. 

  166. </tr>
    167. 

  167. </table>
    168. 

  168. </td>
    169. 

  169. </tr>
    170. 

  170. <tr>
    171. 

  171. <td colspan="5">
    172. 

  172. <br>
    173. 

  173. </td>
    174. 

  174. </tr>
    175. 

  175. <tr>
    176. 

  176. <td>
    177. 

  177. <br>
    178. 

  178. </td><td colspan="4"><span class="description">
    179. 

  179. <b>XLS Data Sources</b>
    180. 

  180. 

  181. <br>
    182. 

  182. 

  183. <br>
    184. 

  184. Report filling is one of the basic operations during the report generation. After the report compilation, 
    185. 

  185. report data are read from the report data source, and/or calculated from report expressions, 
    186. 

  186. and the generated report sections are filled one by one. 
    187. 

  187. <br>
    188. 

  188. Data sources are very useful when data come as a set of structured records, either extracted from a 
    189. 

  189. relational database, or loaded from specific files. In order to become more familiar with data source 
    190. 

  190. objects please consult the <a href="../datasources.html#datasources" target="_blank"><span class="element">Data Sources</span></a> section.
    191. 

  191. <br>
    192. 

  192. When reporting data is stored in Microsoft Excel files (XLS), the 
    193. 

  193. <span class="element"><a href="http://jasperreports.sourceforge.net/api/net/sf/jasperreports/engine/data/JRXlsDataSource.html" target="_blank">JRXlsDataSource</a></span> data source 
    194. 

  194. implementation can be used to read it and feed it into the report. 
    195. 

  195. <br>
    196. 

  196. The XLS data source uses the <code>JExcelApi</code> library to load the XLS workbook and read 
    197. 

  197. from it. Instances of this data source can be created by supplying either an in-memory 
    198. 

  198. workbook object, a file, or an input stream to read the data from. 
    199. 

  199. <br>
    200. 

  200. Report-field mapping for this data source implementation is very similar to the CSV data 
    201. 

  201. source field-mapping explained in the <a href="../csvdatasource" target="_blank"><span class="element">CSV Data Source</span></a> sample. It works on the assumption that 
    202. 

  202. the workbook contains data in a tabular form (rows are records and columns contain 
    203. 

  203. report-field values).
    204. 

  204. <br>
    205. 

  205. 

  206. <br>
    207. 

  207. 

  208. <b>XLS Data Source Example</b>
    209. 

  209. 

  210. <br>
    211. 

  211. 

  212. <br>
    213. 

  213. In our example data records are stored in the /data/XlsDataSource.data.xls file. It contains the same 
    214. 

  214. records as in the <a href="../csvdatasource" target="_blank"><span class="element">CSV Data Source</span></a> sample, but the <code>city</code> and 
    215. 

  215. <code>id</code> columns are separated by an empty column (ie. records contain in fact 6 fields, but 
    216. 

  216. the second field in each record is always empty).
    217. 

  217. <br>
    218. 

  218. There are no column headers in the .xls file. This means 
    219. 

  219. that column names are set independently, as shown in the 
    220. 

  220. <code>getDataSource()</code> method in the /src/XlsDataSourceApp.java file: 
    221. 

  221. <pre>
    222. 

  222.   private static JRXlsDataSource getDataSource() throws JRException
    223. 

  223.   {
    224. 

  224.     JRXlsDataSource ds;
    225. 

  225.     try
    226. 

  226.     {
    227. 

  227.       String[] columnNames = new String[]{"city", "id", "name", "address", "state"};
    228. 

  228.       int[] columnIndexes = new int[]{0, 2, 3, 4, 5};
    229. 

  229.       ds = new JRXlsDataSource(JRLoader.getLocationInputStream("data/XlsDataSource.data.xls"));
    230. 

  230.       ds.setColumnNames(columnNames, columnIndexes);
    231. 

  231.     }
    232. 

  232.     catch (IOException e)
    233. 

  233.     {
    234. 

  234.       throw new JRException(e);
    235. 

  235.     }
    236. 

  236. 

  237.     return ds;
    238. 

  238.   }
    239. 

  239. </pre>
    240. 

  240. Column names are the same as in the CSV example: <code>city</code>, <code>id</code>, <code>name</code>, <code>address</code> and <code>state</code>. 
    241. 

  241. But they are associated with particular column indexes: <code>0, 2, 3, 4, 5</code>. The empty column's index (1) is skipped, and doing so, 
    242. 

  242. the empty content of the second column will be neglected.
    243. 

  243. <br>
    244. 

  244. The <code>JRXlsDataSource</code> object prepared above is passed to the engine at fill time (see again the /src/XlsDataSourceApp.java file):
    245. 

  245. <pre>
    246. 

  246.   public void fill() throws JRException
    247. 

  247.   {
    248. 

  248.     long start = System.currentTimeMillis();
    249. 

  249.     //Preparing parameters
    250. 

  250.     Map parameters = new HashMap();
    251. 

  251.     parameters.put("ReportTitle", "Address Report");
    252. 

  252.     parameters.put("DataFile", "XlsDataSource.data.xls - XLS data source");
    253. 

  253.     Set states = new HashSet();
    254. 

  254.     states.add("Active");
    255. 

  255.     states.add("Trial");
    256. 

  256.     parameters.put("IncludedStates", states);
    257. 

  257. 

  258.     JasperFillManager.fillReportToFile("build/reports/XlsDataSourceReport.jasper", parameters, getDataSource());
    259. 

  259.     System.err.println("Filling time : " + (System.currentTimeMillis() - start));
    260. 

  260.   }
    261. 

  261. </pre>
    262. 

  262. The <code>IncludedStates</code> parameter defined above is used for data filtering. Only records with <code>Active</code> 
    263. 

  263. or <code>Trial</code> states will be taken into account:
    264. 

  264. <br>
    265. 

  265. 

  266. <br>
    267. 

  267. 

  268. <code>
    269. 

  269. &nbsp;&nbsp;&lt;parameter name="IncludedStates" class="java.util.Set"/&gt;
    270. 

  270. <br>
    271. 

  271. 

  272. <br>
    273. 

  273. &nbsp;&nbsp;...
    274. 

  274. <br>
    275. 

  275. 

  276. <br>
    277. 

  277. &nbsp;&nbsp;&lt;filterExpression&gt;&lt;![CDATA[$P{IncludedStates}.contains($F{state}) ? Boolean.TRUE : Boolean.FALSE]]&gt;&lt;/filterExpression&gt;
    278. 

  278. </code>
    279. 

  279. 

  280. <br>
    281. 

  281. 

  282. <br>
    283. 

  283. In order to figure out more on XLS data sources, just test this sample by running from the command line the <code>ant test view</code> command. 
    284. 

  284. It will generate all supported document types containing the sample report in the /build/reports directory, and then the report will be open with JasperReports internal viewer.
    285. 

  285.     </span></td>
    286. 

  286. </tr>
    287. 

  287. <tr>
    288. 

  288. <td colspan="5">
    289. 

  289. <br>
    290. 

  290. </td>
    291. 

  291. </tr>
    292. 

  292. </table>
    293. 

  293. <br>
    294. 

  294. <table width="100%" border="0" cellpadding="0" cellspacing="0">
    295. 

  295. <tr>
    296. 

  296. <td>
    297. 

  297. <hr size="1">
    298. 

  298. </td>
    299. 

  299. </tr>
    300. 

  300. <tr>
    301. 

  301. <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>
    302. 

  302. </tr>
    303. 

  303. </table>
    304. 

  304. </body>
    305. 

  305. </html>
    306. 

  306.