01: /*
02: * ============================================================================
03: * GNU Lesser General Public License
04: * ============================================================================
05: *
06: * JasperReports - Free Java report-generating library.
07: * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
08: *
09: * This library is free software; you can redistribute it and/or
10: * modify it under the terms of the GNU Lesser General Public
11: * License as published by the Free Software Foundation; either
12: * version 2.1 of the License, or (at your option) any later version.
13: *
14: * This library is distributed in the hope that it will be useful,
15: * but WITHOUT ANY WARRANTY; without even the implied warranty of
16: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17: * Lesser General Public License for more details.
18: *
19: * You should have received a copy of the GNU Lesser General Public
20: * License along with this library; if not, write to the Free Software
21: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22: *
23: * JasperSoft Corporation
24: * 303 Second Street, Suite 450 North
25: * San Francisco, CA 94107
26: * http://www.jaspersoft.com
27: */
28:
29: /*
30: * Contributors:
31: * Mirko Wawrowsky - mawawrosky@users.sourceforge.net
32: */
33: package net.sf.jasperreports.engine.export;
34:
35: import net.sf.jasperreports.engine.JRExporterParameter;
36: import net.sf.jasperreports.engine.util.JRProperties;
37:
38: /**
39: * Contains parameters useful for export in CSV format.
40: * <p>
41: * The CSV exporter can send data to a string buffer, output stream, character stream or file on disk. The engine looks
42: * among the export parameters in order to find the selected output type in this order: OUTPUT_STRING_BUFFER, OUTPUT_WRITER,
43: * OUTPUT_STREAM, OUTPUT_FILE, OUTPUT_FILE_NAME.
44: *
45: * @author Teodor Danciu (teodord@users.sourceforge.net)
46: * @version $Id: JRCsvExporterParameter.java 1824 2007-08-23 14:19:12Z teodord $
47: */
48: public class JRCsvExporterParameter extends JRExporterParameter {
49:
50: /**
51: *
52: */
53: protected JRCsvExporterParameter(String name) {
54: super (name);
55: }
56:
57: /**
58: * A string representing the character or sequence of characters used to delimit two fields on the same line. The
59: * default value is a comma.
60: */
61: public static final JRCsvExporterParameter FIELD_DELIMITER = new JRCsvExporterParameter(
62: "Field Delimiter");
63:
64: /**
65: * Property whose value is used as default for the {@link #FIELD_DELIMITER FIELD_DELIMITER} export parameter.
66: *
67: * @see JRProperties
68: */
69: public static final String PROPERTY_FIELD_DELIMITER = JRProperties.PROPERTY_PREFIX
70: + "export.csv.field.delimiter";
71:
72: /**
73: * A string representing the character or sequence of characters used to delimit two lines. The default value is a
74: * character return (\n).
75: */
76: public static final JRCsvExporterParameter RECORD_DELIMITER = new JRCsvExporterParameter(
77: "Record Delimiter");
78:
79: /**
80: * Property whose value is used as default for the {@link #RECORD_DELIMITER RECORD_DELIMITER} export parameter.
81: *
82: * @see JRProperties
83: */
84: public static final String PROPERTY_RECORD_DELIMITER = JRProperties.PROPERTY_PREFIX
85: + "export.csv.record.delimiter";
86:
87: }
|