alma.acs.logging.tools

Class CSVConverter

java.lang.Object

alma.acs.logging.tools.LogConverter

alma.acs.logging.tools.CSVConverter

Direct Known Subclasses:

TextConverter, TwikiTableConverter

public class CSVConverter
extends LogConverter

Objects of this class produce a CSV string from a given log. The CSV adhere to the definition in RFC4180.

It is possible to select the columns of the log to export and their positions by setting a string.

A method generate the header in CSV format

All the fields appear inside double quotes. If a field contains double quotes they are escaped by double quotes. It is also possible not to enclose the fields by double quotes but in that case the content of the field is changed because some character are not allowed.

It is possible to define a different separator instead of a comma, like for example the TAB.

Author:

acaproni

Field Summary

Fields inherited from class alma.acs.logging.tools.LogConverter

ADDITIONAL_DATA_ID, colIndex

Constructor Summary

Constructors

Constructor and Description
CSVConverter() Constructor.
CSVConverter(java.lang.String cols) Constructor
CSVConverter(java.lang.String cols, char separator, boolean doubleQuotes) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	convert(ILogEntry log) Convert a log in a CSV string
void	encloseByDoubleQuotes(boolean enclose) Put or remove the double quotes around the fields
java.lang.String	getHeader() Generate the header for the CSV file (it is optional and can appear in the first line of the file)
void	setSeparator(char sep) Set the separator

Methods inherited from class alma.acs.logging.tools.LogConverter

setCols, setCols

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVConverter

public CSVConverter(java.lang.String cols)

Constructor

Parameters:

cols - A string describing the field of the log and their position in the output

CSVConverter

public CSVConverter()

Constructor.

The converted string contains all the fields just once and the additional data.

CSVConverter

public CSVConverter(java.lang.String cols,
                    char separator,
                    boolean doubleQuotes)

Constructor

Parameters:

cols - A string describing the field of the log and their position in the output

separator - A character to use as fields separator

doubleQuotes - If true the fields are enclosed by double quotes

Method Detail

setSeparator

public void setSeparator(char sep)

Set the separator

Parameters:

sep - The new separator char

encloseByDoubleQuotes

public void encloseByDoubleQuotes(boolean enclose)

Put or remove the double quotes around the fields

Parameters:

enclose - If true the fields are enclosed by double quotes

getHeader

public java.lang.String getHeader()

Generate the header for the CSV file (it is optional and can appear in the first line of the file)

Specified by:

getHeader in class LogConverter

Returns:

The CSV string representing the header in CSV format with CR/LF at the end of the line

convert

public java.lang.String convert(ILogEntry log)

Convert a log in a CSV string

Specified by:

convert in class LogConverter

Parameters:

log - The log to convert

Returns:

The CSV string representing the log