net.sf.jasperreports.export

Interface CsvExporterConfiguration

All Superinterfaces:

CommonExportConfiguration, ExporterConfiguration

All Known Subinterfaces:

CsvMetadataExporterConfiguration

All Known Implementing Classes:

SimpleCsvExporterConfiguration, SimpleCsvMetadataExporterConfiguration

public interface CsvExporterConfiguration
extends ExporterConfiguration

Interface containing settings used by the CSV exporters.

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

JRCsvExporter, JRCsvMetadataExporter

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_FIELD_DELIMITER Property whose value is used as default for the getFieldDelimiter() export configuration setting.
static String	PROPERTY_FIELD_ENCLOSURE Property whose value is used as default for the getFieldEnclosure() export configuration setting.
static String	PROPERTY_FORCE_FIELD_ENCLOSURE Property whose value is used as default for the getForceFieldEnclosure() export configuration setting.
static String	PROPERTY_RECORD_DELIMITER Property whose value is used as default for the getRecordDelimiter() export configuration setting.
static String	PROPERTY_WRITE_BOM Property whose value is used as default for the isWriteBOM() export configuration setting.

Fields inherited from interface net.sf.jasperreports.export.CommonExportConfiguration

PROPERTY_EXPORT_CONFIGURATION_OVERRIDE_REPORT_HINTS

Method Summary

Modifier and Type	Method and Description
String	getFieldDelimiter() Returns the string representing the character or sequence of characters to be used to delimit two fields on the same record.
String	getFieldEnclosure() Returns a string representing the character to be used to enclose a field value on a record.
Boolean	getForceFieldEnclosure() Returns a flag that enforces all exported field values to be enclosed within a pair of enclosure characters (usually a pair of quotes: "").
String	getRecordDelimiter() Returns the string representing the character or sequence of characters to be used to delimit two records.
Boolean	isWriteBOM() Specifies whether the exporter should put a BOM character at the beginning of the output.

Methods inherited from interface net.sf.jasperreports.export.CommonExportConfiguration

isOverrideHints

Field Detail

PROPERTY_FIELD_DELIMITER

static final String PROPERTY_FIELD_DELIMITER

Property whose value is used as default for the getFieldDelimiter() export configuration setting. The default is a comma character.

See Also:

JRPropertiesUtil, Constant Field Values

PROPERTY_RECORD_DELIMITER

static final String PROPERTY_RECORD_DELIMITER

Property whose value is used as default for the getRecordDelimiter() export configuration setting. The default is a character return (\n).

See Also:

JRPropertiesUtil, Constant Field Values

PROPERTY_WRITE_BOM

static final String PROPERTY_WRITE_BOM

Property whose value is used as default for the isWriteBOM() export configuration setting. The default is false.

See Also:

JRPropertiesUtil, Constant Field Values

PROPERTY_FIELD_ENCLOSURE

static final String PROPERTY_FIELD_ENCLOSURE

Property whose value is used as default for the getFieldEnclosure() export configuration setting. Default value is ".

See Also:

JRPropertiesUtil, Constant Field Values

PROPERTY_FORCE_FIELD_ENCLOSURE

static final String PROPERTY_FORCE_FIELD_ENCLOSURE

Property whose value is used as default for the getForceFieldEnclosure() export configuration setting. Default value is false.

See Also:

JRPropertiesUtil, Constant Field Values

Method Detail

getFieldDelimiter

String getFieldDelimiter()

Returns the string representing the character or sequence of characters to be used to delimit two fields on the same record.

See Also:

PROPERTY_FIELD_DELIMITER

getFieldEnclosure

String getFieldEnclosure()

Returns a string representing the character to be used to enclose a field value on a record. If this is a multi-character string, the first character only will be taken into account. White spaces are not considered.

Default value is ".

See Also:

PROPERTY_FIELD_ENCLOSURE

getForceFieldEnclosure

Boolean getForceFieldEnclosure()

Returns a flag that enforces all exported field values to be enclosed within a pair of enclosure characters (usually a pair of quotes: "").

Default value is false.

See Also:

PROPERTY_FORCE_FIELD_ENCLOSURE

getRecordDelimiter

String getRecordDelimiter()

Returns the string representing the character or sequence of characters to be used to delimit two records.

See Also:

PROPERTY_RECORD_DELIMITER

isWriteBOM

Boolean isWriteBOM()

Specifies whether the exporter should put a BOM character at the beginning of the output.

See Also:

PROPERTY_WRITE_BOM