← Back to branch summary

~brian-thomason/+junk/jasperreports3.7

« back to all changes in this revision

Viewing changes to src/net/sf/jasperreports/engine/export/JRCsvExporterParameter.java

  • Committer: Brian Thomason
  • Date: 2011-12-20 17:51:16 UTC
  • Revision ID: brian.thomason@canonical.com-20111220175116-apwo6unuaedvgzo3
Initial import

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/net/sf/jasperreports/engine/export/JRCsvExporterParameter.java
 
1
/*
 
2
 * JasperReports - Free Java Reporting Library.
 
3
 * Copyright (C) 2001 - 2009 Jaspersoft Corporation. All rights reserved.
 
4
 * http://www.jaspersoft.com
 
5
 *
 
6
 * Unless you have purchased a commercial license agreement from Jaspersoft,
 
7
 * the following license terms apply:
 
8
 *
 
9
 * This program is part of JasperReports.
 
10
 *
 
11
 * JasperReports is free software: you can redistribute it and/or modify
 
12
 * it under the terms of the GNU Lesser General Public License as published by
 
13
 * the Free Software Foundation, either version 3 of the License, or
 
14
 * (at your option) any later version.
 
15
 *
 
16
 * JasperReports is distributed in the hope that it will be useful,
 
17
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 
19
 * GNU Lesser General Public License for more details.
 
20
 * 
 
21
 * You should have received a copy of the GNU Lesser General Public License
 
22
 * along with JasperReports. If not, see <http://www.gnu.org/licenses/>.
 
23
 */
 
24
 
 
25
/*
 
26
 * Contributors:
 
27
 * Mirko Wawrowsky - mawawrosky@users.sourceforge.net
 
28
 */
 
29
package net.sf.jasperreports.engine.export;
 
30
 
 
31
import net.sf.jasperreports.engine.JRExporterParameter;
 
32
import net.sf.jasperreports.engine.util.JRProperties;
 
33
 
 
34
 
 
35
/**
 
36
 * Contains parameters useful for export in CSV format.
 
37
 * <p>
 
38
 * The CSV exporter can send data to a string buffer, output stream, character stream or file on disk. The engine looks
 
39
 * among the export parameters in order to find the selected output type in this order: OUTPUT_STRING_BUFFER, OUTPUT_WRITER,
 
40
 * OUTPUT_STREAM, OUTPUT_FILE, OUTPUT_FILE_NAME.
 
41
 *
 
42
 * @author Teodor Danciu (teodord@users.sourceforge.net)
 
43
 * @version $Id: JRCsvExporterParameter.java 3033 2009-08-27 11:46:22Z teodord $
 
44
 */
 
45
public class JRCsvExporterParameter extends JRExporterParameter
 
46
{
 
47
 
 
48
 
 
49
        /**
 
50
         *
 
51
         */
 
52
        protected JRCsvExporterParameter(String name)
 
53
        {
 
54
                super(name);
 
55
        }
 
56
 
 
57
 
 
58
        /**
 
59
         * A string representing the character or sequence of characters used to delimit two fields on the same line. The
 
60
         * default value is a comma.
 
61
         */
 
62
        public static final JRCsvExporterParameter FIELD_DELIMITER = new JRCsvExporterParameter("Field Delimiter");
 
63
 
 
64
 
 
65
        /**
 
66
         * Property whose value is used as default for the {@link #FIELD_DELIMITER FIELD_DELIMITER} export parameter.
 
67
         * 
 
68
         * @see JRProperties
 
69
         */
 
70
        public static final String PROPERTY_FIELD_DELIMITER = JRProperties.PROPERTY_PREFIX + "export.csv.field.delimiter";
 
71
 
 
72
 
 
73
        /**
 
74
         * A string representing the character or sequence of characters used to delimit two lines. The default value is a
 
75
         * character return (\n).
 
76
         */
 
77
        public static final JRCsvExporterParameter RECORD_DELIMITER = new JRCsvExporterParameter("Record Delimiter");
 
78
        
 
79
        
 
80
        /**
 
81
         * Property whose value is used as default for the {@link #RECORD_DELIMITER RECORD_DELIMITER} export parameter.
 
82
         * 
 
83
         * @see JRProperties
 
84
         */
 
85
        public static final String PROPERTY_RECORD_DELIMITER = JRProperties.PROPERTY_PREFIX + "export.csv.record.delimiter";
 
86
 
 
87
 
 
88
}