org.josef.util.csv

Class CsvUtil

java.lang.Object

org.josef.util.csv.CsvUtil

@Status(stage=PRODUCTION,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public final class CsvUtil
extends Object

Utility class for manipulating csv (Comma Separated Values) data.

Version:

1.0 $Revision: 5877 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
static String	csvColumnToString(Object column, Formatter formatter) Formats the supplied column using the supplied formatter.
static String	csvRowFromValues(Character separator, Formatter formatter, Object... values) Converts the supplied values to a single String consisting of properly quoted columns (that are converted to a String using the supplied formatter), separated by the supplied column separator.
static String	csvRowFromValues(Character separator, Object... values) Converts the supplied values to a single String consisting of properly quoted columns, separated by the supplied column separator.
static String	objectToCsvRow(Object object, List<Method> getters, Formatter formatter, Character columnSeparator) Converts the supplied object to a single row of csv data.
static String	quoteCsv(String field, Character separator) Quotes a csv (comma separated value) field.
static String[]	splitRow(String row, Character columnSeparator) Splits a row of csv data into columns.
static String	stripSurroundingQuotes(String column) Strips the supplied column from optional surrounding quotes.

Methods inherited from class java.lang.Object

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

Method Detail

csvRowFromValues

public static String csvRowFromValues(Character separator,
                                      Object... values)

Converts the supplied values to a single String consisting of properly quoted columns, separated by the supplied column separator.
This method uses quoteCsv(String, Character) to properly quote each individual field.

Parameters:

values - Each value represents a column that needs to be converted to a String, then must be properly quoted and then separated from the next column.

separator - The separator to separate the supplied values.
When null, a comma is assumed.

Returns:

A String, representing an entire row of csv data or an empty String when the values is either null or empty.

csvRowFromValues

public static String csvRowFromValues(Character separator,
                                      Formatter formatter,
                                      Object... values)

Converts the supplied values to a single String consisting of properly quoted columns (that are converted to a String using the supplied formatter), separated by the supplied column separator.
This method uses quoteCsv(String, Character) to properly quote each individual field.

Parameters:

separator - The separator to separate the supplied values.
When null, a comma is assumed.

formatter - The formatter to convert the supplied values to a String.

values - Each value represents a column that needs to be converted to a String using the supplied formatter, then must be properly quoted and then separated from the next column.

Returns:

A String, representing an entire row of csv data or an empty String when the values is either null or empty.

Throws:

NullPointerException - When the supplied formatter is null.

quoteCsv

public static String quoteCsv(String field,
                              Character separator)

Quotes a csv (comma separated value) field.
A csv field needs to be quoted when it contains:

• the separator character
• embedded quotes
• line breaks

Parameters:

field - The csv field to be quoted.

separator - The separator to separate the different fields.

Returns:

The supplied field but then quoted (when necessary). A null input string will be returned as an empty string!

Throws:

NullPointerException - When the supplied separator is null.

splitRow

public static String[] splitRow(String row,
                                Character columnSeparator)

Splits a row of csv data into columns.

Parameters:

row - A row containing csv data.

columnSeparator - The separator that separates the different columns.

Returns:

All columns contained in the supplied row.
The returned value may be empty but will never be null!

Throws:

NullPointerException - When the supplied columnSeparator is null.

stripSurroundingQuotes

public static String stripSurroundingQuotes(String column)

Strips the supplied column from optional surrounding quotes.

Parameters:

column - The column to strip the optional surrounding quotes from.

Returns:

The supplied column, stripped from the optional surrounding quotes.

objectToCsvRow

public static String objectToCsvRow(Object object,
                                    List<Method> getters,
                                    Formatter formatter,
                                    Character columnSeparator)

Converts the supplied object to a single row of csv data.
This method uses reflection to execute the different getters and instead of throwing an exception when a getter is not accessible, the text "Error!" is returned for the corresponding column instead.

Parameters:

object - The object to convert to a single row of csv data.

getters - The getters to execute on the supplied object.
Each getter represents a column.

formatter - The formatter to format the different columns.

columnSeparator - The separator that separates the different columns.

Returns:

A csv formatted String representation of the supplied object.

Throws:

NullPointerException - When either the supplied getters or columnSeparator is null.

csvColumnToString

public static String csvColumnToString(Object column,
                                       Formatter formatter)

Formats the supplied column using the supplied formatter.

Parameters:

column - The column to create a String representation of.

formatter - The formatter to format the supplied column or null, to not use a formatter.

Returns:

A String representation of the supplied column.