org.grouplens.lenskit.util.table.writer

Interface TableWriter

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractTableWriter, CSVWriter, MultiplexedTableWriter, TableBuilder

@ThreadSafe
public interface TableWriter
extends Closeable

Write rows to a table.

Instances of this class are used to actually write rows to a table. Once the table has finished, call close() to finish the table and close the underlying output.

Method Summary

Modifier and Type	Method and Description
void	close() Finish the table.
TableLayout	getLayout() Get the layout of this table.
void	writeRow(List<?> row) Write a row to the table.
void	writeRow(Object... row) Write a row to the table.

Method Detail

getLayout

TableLayout getLayout()

Get the layout of this table.

Returns:

The table's layout.

writeRow

void writeRow(Object... row)
       throws IOException

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:

IOException - if an error occurs writing the row.

IllegalArgumentException - if row has the incorrect number of columns.

writeRow

void writeRow(List<?> row)
       throws IOException

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:

IOException - if an error occurs writing the row.

IllegalArgumentException - if row has the incorrect number of columns.

Since:

1.1

close

void close()
    throws IOException

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

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException