Package com.inductiveautomation.ignition.common.util.csv

Class CSVWriter

java.lang.Object

com.inductiveautomation.ignition.common.util.csv.CSVWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class CSVWriter
extends java.lang.Object
implements java.io.Closeable

A very simple CSV writer released under a commercial-friendly license.

Field Summary

Fields

Modifier and Type	Field	Description
static char	DEFAULT_ESCAPE_CHARACTER	The character used for escaping quotes.
static java.lang.String	DEFAULT_LINE_END	Default line terminator uses platform encoding.
static char	DEFAULT_QUOTE_CHARACTER	The default quote character to use if none is supplied to the constructor.
static char	DEFAULT_SEPARATOR	The default separator to use if none is supplied to the constructor.
static int	INITIAL_STRING_SIZE
static char	NO_ESCAPE_CHARACTER	The escape constant to use when you wish to suppress all escaping.
static char	NO_QUOTE_CHARACTER	The quote constant to use when you wish to suppress all quoting.

Constructor Summary

Constructors

Constructor	Description
CSVWriter(java.io.Writer writer)	Constructs CSVWriter using a comma for the separator.
CSVWriter(java.io.Writer writer, char separator)	Constructs CSVWriter with supplied separator.
CSVWriter(java.io.Writer writer, char separator, char quotechar)	Constructs CSVWriter with supplied separator and quote char.
CSVWriter(java.io.Writer writer, char separator, char quotechar, char escapechar)	Constructs CSVWriter with supplied separator and quote char.
CSVWriter(java.io.Writer writer, char separator, char quotechar, char escapechar, java.lang.String lineEnd)	Constructs CSVWriter with supplied separator, quote char, escape char and line ending.
CSVWriter(java.io.Writer writer, char separator, char quotechar, java.lang.String lineEnd)	Constructs CSVWriter with supplied separator and quote char.

Method Summary

Modifier and Type	Method	Description
boolean	checkError()	Checks to see if the there has been an error in the printstream.
void	close()	Close the underlying stream writer flushing any buffered content.
void	flush()	Flush underlying stream to writer.
protected java.lang.StringBuilder	processLine(java.lang.String nextElement)
void	setResultService(ResultSetHelper resultService)
void	writeAll(java.sql.ResultSet rs, boolean includeColumnNames)	Writes the entire ResultSet to a CSV file.
void	writeAll(java.util.List<java.lang.String[]> allLines)	Writes the entire list to a CSV file.
protected void	writeColumnNames(java.sql.ResultSet rs)
void	writeNext(java.lang.String[] nextLine)	Writes the next line to the file.
void	writeNext(java.util.List<java.lang.String> nextLine)

Methods inherited from class java.lang.Object

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

Field Detail

INITIAL_STRING_SIZE

public static final int INITIAL_STRING_SIZE

See Also:

Constant Field Values

DEFAULT_ESCAPE_CHARACTER

public static final char DEFAULT_ESCAPE_CHARACTER

The character used for escaping quotes.

See Also:

Constant Field Values

DEFAULT_SEPARATOR

public static final char DEFAULT_SEPARATOR

The default separator to use if none is supplied to the constructor.

See Also:

Constant Field Values

DEFAULT_QUOTE_CHARACTER

public static final char DEFAULT_QUOTE_CHARACTER

The default quote character to use if none is supplied to the constructor.

See Also:

Constant Field Values

NO_QUOTE_CHARACTER

public static final char NO_QUOTE_CHARACTER

The quote constant to use when you wish to suppress all quoting.

See Also:

Constant Field Values

NO_ESCAPE_CHARACTER

public static final char NO_ESCAPE_CHARACTER

The escape constant to use when you wish to suppress all escaping.

See Also:

Constant Field Values

DEFAULT_LINE_END

public static final java.lang.String DEFAULT_LINE_END

Default line terminator uses platform encoding.

See Also:

Constant Field Values

Constructor Detail

CSVWriter

public CSVWriter(java.io.Writer writer)

Constructs CSVWriter using a comma for the separator.

Parameters:

writer - the writer to an underlying CSV source.

CSVWriter

public CSVWriter(java.io.Writer writer,
                 char separator)

Constructs CSVWriter with supplied separator.

Parameters:

writer - the writer to an underlying CSV source.

separator - the delimiter to use for separating entries.

CSVWriter

public CSVWriter(java.io.Writer writer,
                 char separator,
                 char quotechar)

Constructs CSVWriter with supplied separator and quote char.

Parameters:

writer - the writer to an underlying CSV source.

separator - the delimiter to use for separating entries

quotechar - the character to use for quoted elements

CSVWriter

public CSVWriter(java.io.Writer writer,
                 char separator,
                 char quotechar,
                 char escapechar)

Constructs CSVWriter with supplied separator and quote char.

Parameters:

writer - the writer to an underlying CSV source.

separator - the delimiter to use for separating entries

quotechar - the character to use for quoted elements

escapechar - the character to use for escaping quotechars or escapechars

CSVWriter

public CSVWriter(java.io.Writer writer,
                 char separator,
                 char quotechar,
                 java.lang.String lineEnd)

Constructs CSVWriter with supplied separator and quote char.

Parameters:

writer - the writer to an underlying CSV source.

separator - the delimiter to use for separating entries

quotechar - the character to use for quoted elements

lineEnd - the line feed terminator to use

CSVWriter

public CSVWriter(java.io.Writer writer,
                 char separator,
                 char quotechar,
                 char escapechar,
                 java.lang.String lineEnd)

Constructs CSVWriter with supplied separator, quote char, escape char and line ending.

Parameters:

writer - the writer to an underlying CSV source.

separator - the delimiter to use for separating entries

quotechar - the character to use for quoted elements

escapechar - the character to use for escaping quotechars or escapechars

lineEnd - the line feed terminator to use

Method Detail

writeAll

public void writeAll(java.util.List<java.lang.String[]> allLines)

Writes the entire list to a CSV file. The list is assumed to be a String[]

Parameters:

allLines - a List of String[], with each String[] representing a line of the file.

writeColumnNames

protected void writeColumnNames(java.sql.ResultSet rs)
                         throws java.sql.SQLException

Throws:

java.sql.SQLException

writeAll

public void writeAll(java.sql.ResultSet rs,
                     boolean includeColumnNames)
              throws java.sql.SQLException,
                     java.io.IOException

Writes the entire ResultSet to a CSV file.

The caller is responsible for closing the ResultSet.

Parameters:

rs - the recordset to write

includeColumnNames - true if you want column names in the output, false otherwise

Throws:

java.io.IOException - thrown by getColumnValue

java.sql.SQLException - thrown by getColumnValue

writeNext

public void writeNext(java.util.List<java.lang.String> nextLine)

writeNext

public void writeNext(java.lang.String[] nextLine)

Writes the next line to the file.

Parameters:

nextLine - a string array with each comma-separated element as a separate entry.

processLine

protected java.lang.StringBuilder processLine(java.lang.String nextElement)

flush

public void flush()
           throws java.io.IOException

Flush underlying stream to writer.

Throws:

java.io.IOException - if bad things happen

close

public void close()
           throws java.io.IOException

Close the underlying stream writer flushing any buffered content.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException - if bad things happen

checkError

public boolean checkError()

Checks to see if the there has been an error in the printstream.

setResultService

public void setResultService(ResultSetHelper resultService)