PageRenderTime 46ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 0ms

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

https://gitlab.com/essere.lab.public/qualitas.class-corpus
HTML | 365 lines | 338 code | 27 blank | 0 comment | 0 complexity | 834ea13bf5ae514acea023b5904e6179 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 - CSV 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 - CSV 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 CSV 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/csvdatasource/?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="#csvdatasource">CSV 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="csvdatasource"></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">CSV 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 a CSV 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">1.2.0</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>CSV Data Sources</b>
    180. 

  180. 

  181. <br>
    182. 

  182. 

  183. <br>
    184. 

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

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

  186. and the generated <span class="element"><a href="http://jasperreports.sourceforge.net/api/net/sf/jasperreports/engine/JasperReport.html" target="_blank">JasperReport</a></span> object 
    187. 

  187. is filled section by section. 
    188. 

  188. <br>
    189. 

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

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

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

  192. <br>
    193. 

  193. Sometimes data that users need to fill the report with is found in plain text files, in a 
    194. 

  194. certain format, such as the popular CSV (comma-separated value).
    195. 

  195. <br>
    196. 

  196. JasperReports provides an implementation for such a data source, by wrapping the CSV 
    197. 

  197. data from a text file into a <span class="element"><a href="http://jasperreports.sourceforge.net/api/net/sf/jasperreports/engine/data/JRCsvDataSource.html" target="_blank">JRCsvDataSource</a></span>. 
    198. 

  198. The CSV data source usually needs to read a file from disk, or at least from an input stream. 
    199. 

  199. <br>
    200. 

  200. CSV is a file format with very few formatting rules: data rows are separated by a record 
    201. 

  201. delimiter (text sequence) and fields inside each row are separated by a field delimiter 
    202. 

  202. (character). Fields containing delimiter characters can be placed inside quotes. If fields 
    203. 

  203. contain quotes themselves, these are duplicated (for example, <code>"John ""Doe"""</code> will be 
    204. 

  204. displayed as <code>John "Doe"</code>).
    205. 

  205. <br>
    206. 

  206. The most common delimiters for CSV files are:
    207. 

  207. <ul>
    208. 

  208. 

  209. <li>comma (<code>,</code>) - as field delimiter</li>
    210. 

  210. 

  211. <li>newline (<code>\n</code>) - as record delimiter</li>
    212. 

  212. 

  213. </ul>
    214. 

  214. Users can override these default values by calling <code>setFieldDelimiter(char)</code> and 
    215. 

  215. <code>setRecordDelimiter(String)</code> of the <code>JRCsvDataSource</code> class. 
    216. 

  216. <br>
    217. 

  217. There are two categories of CSV files:
    218. 

  218. <ol>
    219. 

  219. 

  220. <li>files with a header record containing column names, all the other records containing field values;</li>
    221. 

  221. 

  222. <li>files without a header record; all records contain only field values. This is the default category.</li>
    223. 

  223. 

  224. </ol>
    225. 

  225. For the files in the first category, column names are read from the first row in the CSV file. 
    226. 

  226. But the engine should be informed that the input file belongs to the 
    227. 

  227. first category. This can be done by calling the <code>setUseFirstRowAsHeader(true)</code> method of the <code>JRCsvDataSource</code>.
    228. 

  228. <br>
    229. 

  229. If files belong to the second category (default), column names have to be provided separately, taking into account that 
    230. 

  230. the column names order should be the same as the column order in a data record. If this is not possible, 
    231. 

  231. the default naming convention is to use the <code>COLUMN_</code> prefix followed by the zero-based column index.
    232. 

  232. <br>
    233. 

  233. For instance, if is known that a particular column is the third column in the record 
    234. 

  234. (index=2), then one could name the corresponding field "COLUMN_2" and use the 
    235. 

  235. column data without problems.
    236. 

  236. <br> 
    237. 

  237. Another problem when working with CSV files is related to data types. Handling data types 
    238. 

  238. for fields in CSV data sources is special since the CSV file format 
    239. 

  239. does not provide such information. This kind of matter is solved by trying to match each field in 
    240. 

  240. the data source to its corresponding report field type. For number and date/time fields, 
    241. 

  241. converting text values to <code>java.lang.Number</code> and <code>java.util.Date</code> values respectively 
    242. 

  242. requires parsing using format objects. This is controlled by specifying the date and 
    243. 

  243. number format objects to be used with the <code>JRCsvDataSource</code> instance by calling its 
    244. 

  244. <code>setDateFormat(DateFormat)</code> and <code>setNumberFormat(NumberFormat)</code> methods 
    245. 

  245. before passing it to the report-filling process.
    246. 

  246. <br>
    247. 

  247. 

  248. <br>
    249. 

  249. 

  250. <b>CSV Data Source Example</b>
    251. 

  251. 

  252. <br>
    253. 

  253. 

  254. <br>
    255. 

  255. In our example data records are stored in the /data/CsvDataSource.txt file. Although the file extension is <code>.txt</code>, 
    256. 

  256. it contains structured data according to the CSV rules:
    257. 

  257. <pre>
    258. 

  258.   "Dallas",47,"Janet Fuller","445 Upland Pl.","Trial"
    259. 

  259.   "Lyon",38,"Andrew Heiniger","347 College Av.","Active"
    260. 

  260.   "Dallas",43,"Susanne Smith","2 Upland Pl.","Active"
    261. 

  261.   "Berne",22,"Bill Ott","250 - 20th Ave.","Active"
    262. 

  262.   "Boston",32,"Michael Ott","339 College Av.","Trial"
    263. 

  263.   "Dallas",4,"Sylvia Ringer","365 College Av.","Active"
    264. 

  264.   "Boston",23,"Julia Heiniger","358 College Av.","Active"
    265. 

  265.   "Chicago",39,"Mary Karsen","202 College Av.","Active"
    266. 

  266.   "Dallas",40,"Susanne Miller","440 - 20th Ave.","Trial"
    267. 

  267.   "Berne",9,"James Schneider","277 Seventh Av.","Active"
    268. 

  268.   "Dallas",36,"John Steel","276 Upland Pl.","Suspended"
    269. 

  269.   "Chicago",35,"George Karsen","412 College Av.","Suspended"
    270. 

  270.   "Dallas",37,"Michael Clancy","19 Seventh Av.","Deleted"
    271. 

  271.   "Lyon",2,"Anne Miller","20 Upland Pl.","Active"
    272. 

  272.   "Dallas",0,"Laura Steel","429 Seventh Av.","Active"
    273. 

  273.   "Lyon",28,"Susanne White","74 - 20th Ave.","Deleted"
    274. 

  274.   "Paris",5,"Laura Miller","294 Seventh Av.","Active"
    275. 

  275.   "Lyon",17,"Laura Ott","443 Seventh Av.","Active"
    276. 

  276.   "New York",46,"Andrew May","172 Seventh Av.","Active"
    277. 

  277.   "New York",44,"Sylvia Ott","361 College Av.","Active"
    278. 

  278.   "Dallas",19,"Susanne Heiniger","86 - 20th Ave.","Active"
    279. 

  279.   "Chicago",11,"Julia White","412 Upland Pl.","Active"
    280. 

  280.   "Dallas",10,"Anne Fuller","135 Upland Pl.","Active"
    281. 

  281.   "New York",41,"Bill King","546 College Av.","Deleted"
    282. 

  282.   "Oslo",45,"Janet May","396 Seventh Av.","Active"
    283. 

  283.   "Paris",18,"Sylvia Fuller","158 - 20th Ave.","Trial"
    284. 

  284.   "San Francisco",48,"Robert White","549 Seventh Av.","Active"
    285. 

  285.   "Paris",25,"Sylvia Steel","269 College Av.","Suspended"
    286. 

  286.   "San Francisco",7,"James Peterson","231 Upland Pl.","Active"
    287. 

  287.   "Oslo",42,"Robert Ott","503 Seventh Av.","Trial"
    288. 

  288. </pre>
    289. 

  289. The file has no header row with column names. Column names are set independently, as shown in the 
    290. 

  290. <code>getDataSource()</code> method in the /src/CsvDataSourceApp.java file: 
    291. 

  291. <pre>
    292. 

  292.   private static JRCsvDataSource getDataSource() throws JRException
    293. 

  293.   {
    294. 

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

  295.     JRCsvDataSource ds = new JRCsvDataSource(JRLoader.getLocationInputStream("data/CsvDataSource.txt"));
    296. 

  296.     ds.setRecordDelimiter("\r\n");
    297. 

  297.     ds.setColumnNames(columnNames);
    298. 

  298.     return ds;
    299. 

  299.   }
    300. 

  300. </pre>
    301. 

  301. The five column names are: <code>city</code>, <code>id</code>, <code>name</code>, <code>address</code> and <code>state</code>, 
    302. 

  302. in this particular order. Field names are identical to the column names defined here.
    303. 

  303. <br>
    304. 

  304. The <code>JRCsvDataSource</code> object prepared above is passed to the engine at fill time (see again the /src/CsvDataSourceApp.java file):
    305. 

  305. <pre>
    306. 

  306.   public void fill() throws JRException
    307. 

  307.   {
    308. 

  308.     long start = System.currentTimeMillis();
    309. 

  309.     //Preparing parameters
    310. 

  310.     Map parameters = new HashMap();
    311. 

  311.     parameters.put("ReportTitle", "Address Report");
    312. 

  312.     parameters.put("DataFile", "CsvDataSource.txt - CSV data source");
    313. 

  313.     Set states = new HashSet();
    314. 

  314.     states.add("Active");
    315. 

  315.     states.add("Trial");
    316. 

  316.     parameters.put("IncludedStates", states);
    317. 

  317. 

  318.     JasperFillManager.fillReportToFile("build/reports/CsvDataSourceReport.jasper", parameters, getDataSource());
    319. 

  319.     System.err.println("Filling time : " + (System.currentTimeMillis() - start));
    320. 

  320.   }
    321. 

  321. </pre>
    322. 

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

  323. or <code>Trial</code> states will be taken into account:
    324. 

  324. <br>
    325. 

  325. 

  326. <br>
    327. 

  327. 

  328. <code>
    329. 

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

  330. <br>
    331. 

  331. 

  332. <br>
    333. 

  333. &nbsp;&nbsp;...
    334. 

  334. <br>
    335. 

  335. 

  336. <br>
    337. 

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

  338. </code>
    339. 

  339. 

  340. <br>
    341. 

  341. 

  342. <br>
    343. 

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

  344. 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.
    345. 

  345.     </span></td>
    346. 

  346. </tr>
    347. 

  347. <tr>
    348. 

  348. <td colspan="5">
    349. 

  349. <br>
    350. 

  350. </td>
    351. 

  351. </tr>
    352. 

  352. </table>
    353. 

  353. <br>
    354. 

  354. <table width="100%" border="0" cellpadding="0" cellspacing="0">
    355. 

  355. <tr>
    356. 

  356. <td>
    357. 

  357. <hr size="1">
    358. 

  358. </td>
    359. 

  359. </tr>
    360. 

  360. <tr>
    361. 

  361. <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>
    362. 

  362. </tr>
    363. 

  363. </table>
    364. 

  364. </body>
    365. 

  365. </html>
    366. 

  366.