org.pentaho.reporting.libraries.base.util

Class CSVQuoter

java.lang.Object

org.pentaho.reporting.libraries.base.util.CSVQuoter

public final class CSVQuoter
extends java.lang.Object

The CSVQuoter is a helper class to encode a string for the CSV file format.

Author:

Thomas Morgner.

Constructor Summary

Constructors

Constructor and Description
CSVQuoter() Creates a new CSVQuoter, which uses a comma as the default separator.
CSVQuoter(char separator) Creates a new CSVQuoter, which uses the defined separator.
CSVQuoter(char separator, char quate) Creates a new CSVQuoter with the given separator and quoting character.

Method Summary

Modifier and Type	Method and Description
java.lang.String	doQuoting(java.lang.String original) Encodes the string, so that the string can safely be used in CSV files.
void	doQuoting(java.lang.String original, java.io.Writer writer) A streaming version of the quoting algorithm for more performance.
char	getQuate() Returns the quoting character.
char	getSeparator() Gets the separator used in this quoter and the CSV file.
java.lang.String	undoQuoting(java.lang.String nativeString) Decodes the string, so that all escape sequences get removed.

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVQuoter

public CSVQuoter()

Creates a new CSVQuoter, which uses a comma as the default separator.

CSVQuoter

public CSVQuoter(char separator)

Creates a new CSVQuoter, which uses the defined separator.

Parameters:

separator - the separator.

Throws:

java.lang.NullPointerException - if the given separator is null.

CSVQuoter

public CSVQuoter(char separator,
                 char quate)

Creates a new CSVQuoter with the given separator and quoting character.

Parameters:

separator - the separator

quate - the quoting character

Method Detail

doQuoting

public java.lang.String doQuoting(java.lang.String original)

Encodes the string, so that the string can safely be used in CSV files. If the string does not need quoting, the original string is returned unchanged.

Parameters:

original - the unquoted string.

Returns:

The quoted string

doQuoting

public void doQuoting(java.lang.String original,
                      java.io.Writer writer)
               throws java.io.IOException

A streaming version of the quoting algorithm for more performance. Encodes the string, so that the string can safely be used in CSV files. If the string does not need quoting, the original string is returned unchanged.

Parameters:

original - the unquoted string.

writer - the writer.

Throws:

java.io.IOException - if an IO error occured.

undoQuoting

public java.lang.String undoQuoting(java.lang.String nativeString)

Decodes the string, so that all escape sequences get removed. If the string was not quoted, then the string is returned unchanged.

Parameters:

nativeString - the quoted string.

Returns:

The unquoted string.

getSeparator

public char getSeparator()

Gets the separator used in this quoter and the CSV file.

Returns:

the separator (never null).

getQuate

public char getQuate()

Returns the quoting character.

Returns:

the quote character.