uno.informatics.common.io.text

Class TextFileRowWriter

java.lang.Object

uno.informatics.common.io.text.AbstractTextFileHandler

uno.informatics.common.io.text.TextFileRowWriter

All Implemented Interfaces:

AutoCloseable, Reader, RowWriter, TableWriter, TextFileHandler

public class TextFileRowWriter
extends AbstractTextFileHandler
implements RowWriter

Field Summary

Fields inherited from interface uno.informatics.common.io.TextFileHandler

COMMA, TAB

Constructor Summary

Constructors

Constructor and Description
TextFileRowWriter(BufferedWriter bufferedWriter)
TextFileRowWriter(Path path) Constructs an initialised reader using a file.
TextFileRowWriter(String reference) Constructs an initialised reader using a string reference to a text file.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the data source, freeing up an resources.
protected String	convertValue(Object value)
void	flush()
protected void	initialise() Initialises the writer.
boolean	newColumn() Creates a new column in the data source
boolean	newRow() Creates a new row in the data source
void	writeCell(Object cell) Writes the value in the current cell of the data source
void	writeCells(List<List<Object>> cells) Write all cells to the data source in one step
void	writeCellsAsArray(Object[][] cells) Write all cells to the data source in one step
void	writeRowCells(List<Object> cells) Writes the row cells to the data source
void	writeRowCellsAsArray(Object[] cells) Writes the row cells to the data source

Methods inherited from class uno.informatics.common.io.text.AbstractTextFileHandler

getColumnCount, getColumnIndex, getCommentString, getDelimiterString, getPath, getPathReference, getRowCount, getRowIndex, getRowPosition, getRowSize, incrementColumnIndex, incrementRowIndex, incrementRowPosition, isInStrictMode, isInUse, isRowSizesEqual, isRowSizeSetExternally, ready, resetCellIndex, setColumnIndex, setCommentString, setDelimiterString, setFileReference, setInStrictMode, setPath, setRowIndex, setRowPosition, setRowSize, setRowSizeInternal, updateRowFromSize, updateRowSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface uno.informatics.common.io.Reader

ready

Constructor Detail

TextFileRowWriter

public TextFileRowWriter(String reference)
                  throws IOException,
                         FileNotFoundException

Constructs an initialised reader using a string reference to a text file.

Parameters:

reference - a text file name or URL

Throws:

FileNotFoundException - if the file to write is not found

IOException - if an I/O error occurs

TextFileRowWriter

public TextFileRowWriter(Path path)
                  throws IOException,
                         FileNotFoundException

Constructs an initialised reader using a file.

Parameters:

path - the Path to file to be written.

Throws:

FileNotFoundException - if the file to write is not found

IOException - if an I/O error occurs

TextFileRowWriter

public TextFileRowWriter(BufferedWriter bufferedWriter)
                  throws IOException

Throws:

IOException

Method Detail

close

public final void close()

Description copied from interface: Reader

Closes the data source, freeing up an resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Reader

flush

public final void flush()

writeCellsAsArray

public final void writeCellsAsArray(Object[][] cells)
                             throws IOException

Description copied from interface: TableWriter

Write all cells to the data source in one step

Specified by:

writeCellsAsArray in interface TableWriter

Parameters:

cells - the cells to be written to the data source

Throws:

IOException - if the data can not be written

writeCells

public final void writeCells(List<List<Object>> cells)
                      throws IOException

Description copied from interface: TableWriter

Write all cells to the data source in one step

Specified by:

writeCells in interface TableWriter

Parameters:

cells - the cells to be written to the data source

Throws:

IOException - if the data can not be written

writeRowCellsAsArray

public final void writeRowCellsAsArray(Object[] cells)
                                throws IOException

Description copied from interface: RowWriter

Writes the row cells to the data source

Specified by:

writeRowCellsAsArray in interface RowWriter

Parameters:

cells - row cells to be written to the data source

Throws:

IOException - if the data can not be written

writeRowCells

public final void writeRowCells(List<Object> cells)
                         throws IOException

Description copied from interface: RowWriter

Writes the row cells to the data source

Specified by:

writeRowCells in interface RowWriter

Parameters:

cells - row cells to be written to the data source

Throws:

IOException - if the data can not be written

writeCell

public final void writeCell(Object cell)
                     throws IOException

Description copied from interface: TableWriter

Writes the value in the current cell of the data source

Specified by:

writeCell in interface TableWriter

Parameters:

cell - value

Throws:

IOException - if the data can not be written

convertValue

protected String convertValue(Object value)

newRow

public final boolean newRow()
                     throws IOException

Description copied from interface: TableWriter

Creates a new row in the data source

Specified by:

newRow in interface TableWriter

Returns:

true if the row was created, false otherwise

Throws:

IOException - if a new row can not be created

newColumn

public final boolean newColumn()
                        throws IOException

Description copied from interface: TableWriter

Creates a new column in the data source

Specified by:

newColumn in interface TableWriter

Returns:

true if the column was created, false otherwise

Throws:

IOException - if a new column can not be created

initialise

protected final void initialise()
                         throws FileNotFoundException,
                                IOException

Initialises the writer.

Overrides:

initialise in class AbstractTextFileHandler

Throws:

FileNotFoundException - if the file to write is not found

IOException - if an I/O error occurs