uno.informatics.common.io.text

Class AbstractTextFileHandler

java.lang.Object

uno.informatics.common.io.text.AbstractTextFileHandler

All Implemented Interfaces:

TextFileHandler

Direct Known Subclasses:

TextFileRowReader, TextFileRowWriter

public abstract class AbstractTextFileHandler
extends Object
implements TextFileHandler

Field Summary

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

COMMA, TAB

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTextFileHandler()
	AbstractTextFileHandler(Path path) Constructs an initialised reader using a file.
	AbstractTextFileHandler(String reference) Constructs an initialised reader using a string reference to a text file.

Method Summary

Modifier and Type	Method and Description
int	getColumnCount()
protected int	getColumnIndex()
String	getCommentString() Gets the string which indicates at comment line that should be ignored by the reader.
String	getDelimiterString() Gets the string which indicates a new field in a record.
Path	getPath() Gets the file associated with this handler
String	getPathReference()
int	getRowCount()
protected int	getRowIndex()
protected int	getRowPosition()
int	getRowSize()
protected void	incrementColumnIndex()
protected void	incrementRowIndex()
protected void	incrementRowPosition()
protected void	initialise() Initialises the reader.
boolean	isInStrictMode()
protected boolean	isInUse()
protected boolean	isRowSizesEqual()
protected boolean	isRowSizeSetExternally()
boolean	ready()
protected void	resetCellIndex()
protected void	setColumnIndex(int columnIndex)
void	setCommentString(String comment) Sets the string which indicates a comment line that should be ignored by the reader.
void	setDelimiterString(String delimiter) Sets the string which indicates a new field in a record.
void	setFileReference(String pathReference)
void	setInStrictMode(boolean isInStrictMode)
void	setPath(Path path)
protected void	setRowIndex(int rowIndex)
protected void	setRowPosition(int rowPosition)
void	setRowSize(int rowSize)
protected void	setRowSizeInternal(int rowSize)
protected void	updateRowFromSize(List<Object> row) Add addition cells to row to ensure it is the same size as other rows
protected void	updateRowSize(int size)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTextFileHandler

protected AbstractTextFileHandler()

AbstractTextFileHandler

public AbstractTextFileHandler(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 read/write is not found

IOException - if an I/O error occurs

AbstractTextFileHandler

public AbstractTextFileHandler(Path path)
                        throws IOException,
                               FileNotFoundException

Constructs an initialised reader using a file.

Parameters:

path - a Path object.

Throws:

FileNotFoundException - if the file to read/write is not found

IOException - if an I/O error occurs

Method Detail

ready

public boolean ready()

Returns:

true

getRowCount

public final int getRowCount()

getColumnCount

public final int getColumnCount()

getCommentString

public final String getCommentString()

Gets the string which indicates at comment line that should be ignored by the reader.

Returns:

the comment string

getPathReference

public final String getPathReference()

setFileReference

public final void setFileReference(String pathReference)
                            throws IOException

Throws:

IOException

getPath

public final Path getPath()

Description copied from interface: TextFileHandler

Gets the file associated with this handler

Specified by:

getPath in interface TextFileHandler

Returns:

associated file

setPath

public final void setPath(Path path)
                   throws IOException

Throws:

IOException

isInStrictMode

public final boolean isInStrictMode()

setInStrictMode

public final void setInStrictMode(boolean isInStrictMode)
                           throws IOException

Throws:

IOException

setCommentString

public final void setCommentString(String comment)
                            throws IOException

Sets the string which indicates a comment line that should be ignored by the reader. Set to null if no comments are allowed

Parameters:

comment - the comment string

Throws:

IOException - if the reader/writer is in use

getDelimiterString

public final String getDelimiterString()

Gets the string which indicates a new field in a record.

Returns:

the delimiter string

setDelimiterString

public void setDelimiterString(String delimiter)
                        throws IOException

Sets the string which indicates a new field in a record.

Parameters:

delimiter - the delimiter string

Throws:

IOException - if the reader is currently in use

initialise

protected void initialise()
                   throws FileNotFoundException,
                          IOException

Initialises the reader.

Throws:

FileNotFoundException - if the file to read/write is not found

IOException - if an I/O error occurs

updateRowFromSize

protected final void updateRowFromSize(List<Object> row)
                                throws IOException

Add addition cells to row to ensure it is the same size as other rows

Parameters:

row - row to complete

Throws:

IOException - if the row can not be completed

getRowSize

public final int getRowSize()

setRowSize

public final void setRowSize(int rowSize)
                      throws IOException

Throws:

IOException

setRowSizeInternal

protected final void setRowSizeInternal(int rowSize)

updateRowSize

protected final void updateRowSize(int size)
                            throws IOException

Throws:

IOException

isRowSizesEqual

protected final boolean isRowSizesEqual()

getRowIndex

protected final int getRowIndex()

setRowIndex

protected final void setRowIndex(int rowIndex)

incrementRowIndex

protected final void incrementRowIndex()

getRowPosition

protected final int getRowPosition()

setRowPosition

protected final void setRowPosition(int rowPosition)

incrementRowPosition

protected final void incrementRowPosition()

isInUse

protected final boolean isInUse()

getColumnIndex

protected final int getColumnIndex()

setColumnIndex

protected final void setColumnIndex(int columnIndex)

incrementColumnIndex

protected final void incrementColumnIndex()

resetCellIndex

protected final void resetCellIndex()

isRowSizeSetExternally

protected final boolean isRowSizeSetExternally()