Package net.sf.jasperreports.export

Class SimpleCsvExporterConfiguration

java.lang.Object

net.sf.jasperreports.export.SimpleCommonExportConfiguration

net.sf.jasperreports.export.SimpleExporterConfiguration

net.sf.jasperreports.export.SimpleCsvExporterConfiguration

All Implemented Interfaces:

CommonExportConfiguration, CsvExporterConfiguration, ExporterConfiguration

Direct Known Subclasses:

SimpleCsvMetadataExporterConfiguration

public class SimpleCsvExporterConfiguration
extends SimpleExporterConfiguration
implements CsvExporterConfiguration

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Field Summary

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

PROPERTY_EXPORT_CONFIGURATION_OVERRIDE_REPORT_HINTS

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

PROPERTY_ESCAPE_FORMULA, PROPERTY_FIELD_DELIMITER, PROPERTY_FIELD_ENCLOSURE, PROPERTY_FORCE_FIELD_ENCLOSURE, PROPERTY_RECORD_DELIMITER, PROPERTY_WRITE_BOM

Constructor Summary

Constructors

Constructor	Description
SimpleCsvExporterConfiguration()

Method Summary

Modifier and Type	Method	Description
Boolean	getEscapeFormula()	Returns a flag that enforces field values containing formula to be escaped in order to be interpreted as pure text.
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.
void	setEscapeFormula(Boolean escapeFormula)
void	setFieldDelimiter(String fieldDelimiter)
void	setFieldEnclosure(String fieldEnclosure)
void	setForceFieldEnclosure(Boolean forceFieldEnclosure)
void	setRecordDelimiter(String recordDelimiter)
void	setWriteBOM(Boolean isWriteBOM)

Methods inherited from class net.sf.jasperreports.export.SimpleCommonExportConfiguration

isOverrideHints, setOverrideHints

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

isOverrideHints

Constructor Detail

SimpleCsvExporterConfiguration

public SimpleCsvExporterConfiguration()

Method Detail

getFieldDelimiter

public String getFieldDelimiter()

Description copied from interface: CsvExporterConfiguration

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

Specified by:

getFieldDelimiter in interface CsvExporterConfiguration

See Also:

CsvExporterConfiguration.PROPERTY_FIELD_DELIMITER

setFieldDelimiter

public void setFieldDelimiter(String fieldDelimiter)

getFieldEnclosure

public String getFieldEnclosure()

Description copied from interface: CsvExporterConfiguration

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 ".

Specified by:

getFieldEnclosure in interface CsvExporterConfiguration

See Also:

CsvExporterConfiguration.PROPERTY_FIELD_ENCLOSURE

setFieldEnclosure

public void setFieldEnclosure(String fieldEnclosure)

getRecordDelimiter

public String getRecordDelimiter()

Description copied from interface: CsvExporterConfiguration

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

Specified by:

getRecordDelimiter in interface CsvExporterConfiguration

See Also:

CsvExporterConfiguration.PROPERTY_RECORD_DELIMITER

setRecordDelimiter

public void setRecordDelimiter(String recordDelimiter)

isWriteBOM

public Boolean isWriteBOM()

Description copied from interface: CsvExporterConfiguration

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

Specified by:

isWriteBOM in interface CsvExporterConfiguration

See Also:

CsvExporterConfiguration.PROPERTY_WRITE_BOM

setWriteBOM

public void setWriteBOM(Boolean isWriteBOM)

getForceFieldEnclosure

public Boolean getForceFieldEnclosure()

Description copied from interface: CsvExporterConfiguration

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.

Specified by:

getForceFieldEnclosure in interface CsvExporterConfiguration

See Also:

CsvExporterConfiguration.PROPERTY_FORCE_FIELD_ENCLOSURE

setForceFieldEnclosure

public void setForceFieldEnclosure(Boolean forceFieldEnclosure)

getEscapeFormula

public Boolean getEscapeFormula()

Description copied from interface: CsvExporterConfiguration

Returns a flag that enforces field values containing formula to be escaped in order to be interpreted as pure text.

Default value is false.

Specified by:

getEscapeFormula in interface CsvExporterConfiguration

See Also:

CsvExporterConfiguration.PROPERTY_ESCAPE_FORMULA

setEscapeFormula

public void setEscapeFormula(Boolean escapeFormula)