org.lenskit.util.table

Class TableBuilder

java.lang.Object

org.lenskit.util.table.writer.AbstractTableWriter

org.lenskit.util.table.TableBuilder

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.commons.lang3.builder.Builder<Table>, TableWriter

public class TableBuilder
extends AbstractTableWriter
implements org.apache.commons.lang3.builder.Builder<Table>

Builder to construct tables.

Constructor Summary

Constructors

Constructor and Description
TableBuilder(java.util.List<java.lang.String> columns)
TableBuilder(TableLayout layout) Construct a new builder using a particular layout.

Method Summary

Modifier and Type	Method and Description
void	addRow(java.util.List<?> row) Add a row to the table.
void	addRow(java.lang.Object... row) Add a row to the table.
Table	build()
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.
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

TableBuilder

public TableBuilder(TableLayout layout)

Construct a new builder using a particular layout.

Parameters:

layout - The table layout.

TableBuilder

public TableBuilder(java.util.List<java.lang.String> columns)

Method Detail

getLayout

public TableLayout getLayout()

Description copied from interface: TableWriter

Get the layout of this table.

Specified by:

getLayout in interface TableWriter

Returns:

The table’s layout.

close

public void close()

Description copied from interface: TableWriter

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

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface TableWriter

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.

Specified by:

flush in interface TableWriter

Throws:

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

writeRow

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

Description copied from interface: TableWriter

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

Specified by:

writeRow in interface TableWriter

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.

addRow

public void addRow(java.util.List<?> row)

Add a row to the table.

Parameters:

row - The row to add.

Throws:

java.lang.IllegalArgumentException - if the row has the wrong length.

Since:

1.1

addRow

public void addRow(java.lang.Object... row)

Add a row to the table.

Parameters:

row - The row to add.

Throws:

java.lang.IllegalArgumentException - if the row has the wrong length.

Since:

1.1

build

public Table build()

Specified by:

build in interface org.apache.commons.lang3.builder.Builder<Table>