org.lenskit.util.table.writer

Class CSVWriter

java.lang.Object

org.lenskit.util.table.writer.AbstractTableWriter

org.lenskit.util.table.writer.CSVWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, TableWriter

public class CSVWriter
extends AbstractTableWriter

Implementation of TableWriter for CSV files.

Constructor Summary

Constructors

Constructor and Description
CSVWriter(java.io.Writer w, TableLayout l) Construct a new CSV writer.

Method Summary

Modifier and Type	Method and Description
void	close() Finish the table.
void	flush() Flush the writer, causing all currently-written rows to be flushed to output.
TableLayout	getLayout() Get the layout of this table.
static CSVWriter	open(java.io.File file, TableLayout layout) Open a CSV writer to write to an auto-compressed file.
static CSVWriter	open(java.io.File file, TableLayout layout, CompressionMode compression) Open a CSV writer to write to a file.
void	writeRow(java.util.List<?> row) Write a row to the table.

Methods inherited from class org.lenskit.util.table.writer.AbstractTableWriter

checkRowWidth, writeRow

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVWriter

public CSVWriter(@WillCloseWhenClosed @Nonnull
                 java.io.Writer w,
                 @Nullable
                 TableLayout l)
          throws java.io.IOException

Construct a new CSV writer.

Parameters:

w - The underlying writer to output to.

l - The table layout, or null if the table has no headers.

Throws:

java.io.IOException - if there is an error writing the column headers.

Method Detail

flush

public void flush()
           throws java.io.IOException

Description copied from interface: TableWriter

Flush the writer, causing all currently-written rows to be flushed to output.

Throws:

java.io.IOException - if an error occurs while flushing output.

close

public void close()
           throws java.io.IOException

Description copied from interface: TableWriter

Finish the table. Depending on how it was constructed, some underlying resource may be closed.

Throws:

java.io.IOException

writeRow

public void writeRow(java.util.List<?> row)
              throws java.io.IOException

Description copied from interface: TableWriter

Write a row to the table. This method is thread-safe.

Parameters:

row - A row of values. If the table requires more columns, the remaining columns are empty. The row is copied if necessary; the caller is free to re-use the same array for returnValue calls.

Throws:

java.io.IOException - if an error occurs writing the row.

getLayout

public TableLayout getLayout()

Description copied from interface: TableWriter

Get the layout of this table.

Returns:

The table’s layout.

open

public static CSVWriter open(java.io.File file,
                             TableLayout layout,
                             CompressionMode compression)
                      throws java.io.IOException

Open a CSV writer to write to a file.

Parameters:

file - The file to write to.

layout - The layout of the table.

compression - What compression, if any, to use.

Returns:

A CSV writer outputting to file.

Throws:

java.io.IOException - if there is an error opening the file or writing the column header.

open

public static CSVWriter open(java.io.File file,
                             @Nullable
                             TableLayout layout)
                      throws java.io.IOException

Open a CSV writer to write to an auto-compressed file. The file will be compressed if its name ends in “.gz”.

Parameters:

file - The file.

layout - The table layout.

Returns:

The CSV writer.

Throws:

java.io.IOException - if there is an error opening the file or writing the column header.

See Also:

open(File, TableLayout, CompressionMode)