uno.informatics.common.io.text

Class TextFileRowReader

java.lang.Object

uno.informatics.common.io.text.AbstractTextFileHandler

uno.informatics.common.io.text.TextFileRowReader

All Implemented Interfaces:

AutoCloseable, Reader, RowReader, TableReader, TextFileHandler

public class TextFileRowReader
extends AbstractTextFileHandler
implements RowReader

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONVERT_VALUES Sets if the reader should attempt to convert values.
static int	IGNORE_MULTIPLE_DELIMITERS Sets if two more more delimiters are encountered together if these should be treated as one delimiters
static int	NO_OPTIONS Sets no options, all options are set to false
static int	PARSE_EMPTY_STRINGS Sets if the reader should parse empty strings.
static int	REMOVE_WHITE_SPACE Sets if the reader remove any prefix or suffix white space for Strings
static int	ROWS_SAME_SIZE Sets if rows are adjusted to be all the same size as the first row

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

COMMA, TAB

Constructor Summary

Constructors

Constructor and Description
TextFileRowReader(BufferedReader bufferedReader)
TextFileRowReader(Path path) Constructs an initialised reader using a file.
TextFileRowReader(String reference) Constructs an initialised reader using a string reference to a text file.

Method Summary

Modifier and Type	Method and Description
void	close() Close the reader, disposing of any internal resources
protected String	convertToken(String string)
protected String	convertTokenWithoutTrim(String string)
protected String	convertTokenWithTrim(String string)
protected Object	convertValue(String text)
protected Object	convertValue(String text, int dataTypes)
int[]	getAllConversionTypes()
Object	getCell() Gets the value of the current cell
boolean	getCellAsBoolean() Gets the value of the current cell as an boolean
double	getCellAsDouble() Gets the value of the current cell as a double
int	getCellAsInt() Gets the value of the current cell as an int
String	getCellAsString() Gets the value of the current cell as a string
int	getConversionTypes(int index)
protected int	getDefaultConversionTypes()
int	getOptions() Gets an int representing a bit array of options
List<Object>	getRowCells() Gets the current remaining unread row cell values
Object[]	getRowCellsAsArray() Gets the current remaining unread row cell values as an array
List<Boolean>	getRowCellsAsBoolean() Gets the current remaining unread row cell values
boolean[]	getRowCellsAsBooleanArray() Gets the current remaining unread row cell values as an array
List<Double>	getRowCellsAsDouble() Gets the current remaining unread row cell values
double[]	getRowCellsAsDoubleArray() Gets the current remaining unread row cell values as an array
List<Integer>	getRowCellsAsInt() Gets the current remaining unread row cell values
int[]	getRowCellsAsIntArray() Gets the current remaining unread row cell values as an array
List<String>	getRowCellsAsString() Gets the current remaining unread row cell values
String[]	getRowCellsAsStringArray() Gets the current remaining unread row cell values as an array
boolean	hasNextColumn() Determines if there another cell in the current column
boolean	hasNextRow() Determines if there is another row in the current data source
protected void	initialise() Initialises the reader.
boolean	nextColumn() Moves the reader on to the next cell in the column.
boolean	nextRow() Moves the reader on to the next row in the data source.
protected Object	parseValue(String text, int rowIndex, int columnIndex)
protected Object	parseValue(String text, int rowIndex, int columnIndex, int conversionTypes)
List<List<Object>>	readCells() Read all cells from the data source at one time
Object[][]	readCellsAsArray() Read all cells from the data source at one time
boolean	ready() Check to see if the reader is ready to be used and if additional cells can still be read
void	setAllConversionTypes(int[] conversionTypes)
void	setConversionTypes(int conversionTypes, int index)
void	setDefaultConversionTypes(int defaultConversionTypes)
void	setDelimiterString(String delimiter) Sets the delimiter string.
void	setOptions(int options) Sets an int representing a bit array of options

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, resetCellIndex, setColumnIndex, setCommentString, 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

Field Detail

NO_OPTIONS

public static final int NO_OPTIONS

Sets no options, all options are set to false

See Also:

Constant Field Values

PARSE_EMPTY_STRINGS

public static final int PARSE_EMPTY_STRINGS

Sets if the reader should parse empty strings.

See Also:

Constant Field Values

CONVERT_VALUES

public static final int CONVERT_VALUES

Sets if the reader should attempt to convert values.

See Also:

Constant Field Values

IGNORE_MULTIPLE_DELIMITERS

public static final int IGNORE_MULTIPLE_DELIMITERS

Sets if two more more delimiters are encountered together if these should be treated as one delimiters

See Also:

Constant Field Values

ROWS_SAME_SIZE

public static final int ROWS_SAME_SIZE

Sets if rows are adjusted to be all the same size as the first row

See Also:

Constant Field Values

REMOVE_WHITE_SPACE

public static final int REMOVE_WHITE_SPACE

Sets if the reader remove any prefix or suffix white space for Strings

See Also:

Constant Field Values

Constructor Detail

TextFileRowReader

public TextFileRowReader(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 is not found

IOException - if an I/O error occurs

TextFileRowReader

public TextFileRowReader(Path path)
                  throws IOException,
                         FileNotFoundException

Constructs an initialised reader using a file.

Parameters:

path - the Path to file to be read.

Throws:

FileNotFoundException - if the file to read is not found

IOException - if an I/O error occurs

TextFileRowReader

public TextFileRowReader(BufferedReader bufferedReader)
                  throws IOException

Throws:

IOException

Method Detail

ready

public final boolean ready()

Check to see if the reader is ready to be used and if additional cells can still be read

Specified by:

ready in interface Reader

Overrides:

ready in class AbstractTextFileHandler

Returns:

true if the reader is ready to be used and if additional cells can still be read, false otherwise

close

public final void close()

Close the reader, disposing of any internal resources

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Reader

getOptions

public final int getOptions()

Gets an int representing a bit array of options

Returns:

an int preresenting a bit array of options

setOptions

public final void setOptions(int options)
                      throws IOException

Sets an int representing a bit array of options

Parameters:

options - an int preresenting a bit array of options

Throws:

IOException

setDelimiterString

public final void setDelimiterString(String delimiter)
                              throws IOException

Sets the delimiter string.

Overrides:

setDelimiterString in class AbstractTextFileHandler

Parameters:

delimiter - the delimiter string

Throws:

IOException - if the reader is already is use

readCellsAsArray

public final Object[][] readCellsAsArray()
                                  throws IOException

Description copied from interface: TableReader

Read all cells from the data source at one time

Specified by:

readCellsAsArray in interface TableReader

Returns:

all cells from the data source at one time

Throws:

IOException - if the data source can not be read

readCells

public final List<List<Object>> readCells()
                                   throws IOException

Description copied from interface: TableReader

Read all cells from the data source at one time

Specified by:

readCells in interface TableReader

Returns:

all cells from the data source at one time

Throws:

IOException - if the data source can not be read

hasNextRow

public final boolean hasNextRow()

Description copied from interface: TableReader

Determines if there is another row in the current data source

Specified by:

hasNextRow in interface TableReader

Returns:

true if this is not the last cell in the row, false if it is the last

nextRow

public final boolean nextRow()
                      throws IOException

Description copied from interface: TableReader

Moves the reader on to the next row in the data source. If row by row and there are any unread cells in the current row these will be unread

Specified by:

nextRow in interface TableReader

Returns:

true if this is not the last cell in the row, false if it is the last

Throws:

IOException - if the data source can not be read

hasNextColumn

public boolean hasNextColumn()

Description copied from interface: TableReader

Determines if there another cell in the current column

Specified by:

hasNextColumn in interface TableReader

Returns:

true if this is not the last cell in the column, false if it is the last

nextColumn

public boolean nextColumn()
                   throws IOException

Description copied from interface: TableReader

Moves the reader on to the next cell in the column. If reading column by column and there are any unread cells in the current column these will be unread

Specified by:

nextColumn in interface TableReader

Returns:

true if this is not the last cell in the column, false if it is the last

Throws:

IOException - if the data source can not be read

getCell

public Object getCell()
               throws IOException

Description copied from interface: TableReader

Gets the value of the current cell

Specified by:

getCell in interface TableReader

Returns:

the value of the current cell

Throws:

IOException - if the data source can not be read

getCellAsString

public String getCellAsString()
                       throws IOException

Description copied from interface: TableReader

Gets the value of the current cell as a string

Specified by:

getCellAsString in interface TableReader

Returns:

the value of the current cell

Throws:

IOException - if the data source can not be read or can not be converted to String

getCellAsDouble

public double getCellAsDouble()
                       throws IOException

Description copied from interface: TableReader

Gets the value of the current cell as a double

Specified by:

getCellAsDouble in interface TableReader

Returns:

the value of the current cell

Throws:

IOException - if the data source can not be read or can not be converted to double

getCellAsInt

public int getCellAsInt()
                 throws IOException

Description copied from interface: TableReader

Gets the value of the current cell as an int

Specified by:

getCellAsInt in interface TableReader

Returns:

the value of the current cell

Throws:

IOException - if the data source can not be read or can not be converted to an int

getCellAsBoolean

public boolean getCellAsBoolean()
                         throws IOException

Description copied from interface: TableReader

Gets the value of the current cell as an boolean

Specified by:

getCellAsBoolean in interface TableReader

Returns:

the value of the current cell

Throws:

IOException - if the data source can not be read or can not be converted to an boolean

getRowCells

public final List<Object> getRowCells()
                               throws IOException

Description copied from interface: RowReader

Gets the current remaining unread row cell values

Specified by:

getRowCells in interface RowReader

Returns:

the remaining unread row cell values

Throws:

IOException - if the data source can not be read

getRowCellsAsString

public final List<String> getRowCellsAsString()
                                       throws IOException

Description copied from interface: RowReader

Gets the current remaining unread row cell values

Specified by:

getRowCellsAsString in interface RowReader

Returns:

the remaining unread row cell values

Throws:

IOException - if the data source can not be read

getRowCellsAsInt

public final List<Integer> getRowCellsAsInt()
                                     throws IOException

Description copied from interface: RowReader

Gets the current remaining unread row cell values

Specified by:

getRowCellsAsInt in interface RowReader

Returns:

the remaining unread row cell values

Throws:

IOException - if the data source can not be read

getRowCellsAsDouble

public final List<Double> getRowCellsAsDouble()
                                       throws IOException

Description copied from interface: RowReader

Gets the current remaining unread row cell values

Specified by:

getRowCellsAsDouble in interface RowReader

Returns:

the remaining unread row cell values

Throws:

IOException - if the data source can not be read

getRowCellsAsBoolean

public final List<Boolean> getRowCellsAsBoolean()
                                         throws IOException

Description copied from interface: RowReader

Gets the current remaining unread row cell values

Specified by:

getRowCellsAsBoolean in interface RowReader

Returns:

the remaining unread row cell values

Throws:

IOException - if the data source can not be read

getRowCellsAsArray

public final Object[] getRowCellsAsArray()
                                  throws IOException

Description copied from interface: RowReader

Gets the current remaining unread row cell values as an array

Specified by:

getRowCellsAsArray in interface RowReader

Returns:

the remaining unread row cell values as an array

Throws:

IOException - if the data source can not be read

getRowCellsAsStringArray

public final String[] getRowCellsAsStringArray()
                                        throws IOException

Description copied from interface: RowReader

Gets the current remaining unread row cell values as an array

Specified by:

getRowCellsAsStringArray in interface RowReader

Returns:

the remaining unread row cell values as an array

Throws:

IOException - if the data source can not be read

getRowCellsAsIntArray

public final int[] getRowCellsAsIntArray()
                                  throws IOException

Description copied from interface: RowReader

Gets the current remaining unread row cell values as an array

Specified by:

getRowCellsAsIntArray in interface RowReader

Returns:

the remaining unread row cell values as an array

Throws:

IOException - if the data source can not be read

getRowCellsAsDoubleArray

public final double[] getRowCellsAsDoubleArray()
                                        throws IOException

Description copied from interface: RowReader

Gets the current remaining unread row cell values as an array

Specified by:

getRowCellsAsDoubleArray in interface RowReader

Returns:

the remaining unread row cell values as an array

Throws:

IOException - if the data source can not be read

getRowCellsAsBooleanArray

public final boolean[] getRowCellsAsBooleanArray()
                                          throws IOException

Description copied from interface: RowReader

Gets the current remaining unread row cell values as an array

Specified by:

getRowCellsAsBooleanArray in interface RowReader

Returns:

the remaining unread row cell values as an array

Throws:

IOException - if the data source can not be read

parseValue

protected Object parseValue(String text,
                            int rowIndex,
                            int columnIndex)
                     throws IOException

Throws:

IOException

parseValue

protected Object parseValue(String text,
                            int rowIndex,
                            int columnIndex,
                            int conversionTypes)
                     throws IOException

Throws:

IOException

convertValue

protected Object convertValue(String text)

convertValue

protected Object convertValue(String text,
                              int dataTypes)
                       throws ConversionException

Throws:

ConversionException

initialise

protected final void initialise()
                         throws FileNotFoundException,
                                IOException

Initialises the reader.

Overrides:

initialise in class AbstractTextFileHandler

Throws:

FileNotFoundException - if the file to read is not found

IOException - if an I/O error occurs

convertToken

protected String convertToken(String string)

convertTokenWithTrim

protected String convertTokenWithTrim(String string)

convertTokenWithoutTrim

protected String convertTokenWithoutTrim(String string)

getDefaultConversionTypes

protected int getDefaultConversionTypes()

setDefaultConversionTypes

public final void setDefaultConversionTypes(int defaultConversionTypes)

getConversionTypes

public final int getConversionTypes(int index)

getAllConversionTypes

public final int[] getAllConversionTypes()

setAllConversionTypes

public final void setAllConversionTypes(int[] conversionTypes)

Specified by:

setAllConversionTypes in interface TableReader

setConversionTypes

public final void setConversionTypes(int conversionTypes,
                                     int index)