AbstractTableReader (CSV/Excel Utility Package 2.8.1 API)

java.lang.Object
- csv.impl.AbstractTableReader

All Implemented Interfaces:

TableReader, Iterable<Object[]>, Iterator<Object[]>

Direct Known Subclasses:

AbstractStreamTableReader, JdbcReader, JTableReader
```
public abstract class AbstractTableReader
extends Object
implements TableReader
```
Abstract implementation that shall be suitable for most implementations.

Author:

ralph

Constructor Summary

Constructors
Constructor Description

AbstractTableReader()
Default Constructor.

Constructors
Constructor	Description
`AbstractTableReader()`	Default Constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addCommentCallBack(CommentCallback callback)`	Deprecated. Use `TableReader.registerCommentCallBack(CommentCallback)` instead.
`void`	`close()`	Does nothing
`protected Object`	`convert(int columnIndex, String value)`	Converts the string back to correct object.
`protected Object`	`convert(String type, String value)`	Converts the string back to correct object.
`protected Object[]`	`convertArray(String[] columns)`	Returns an array from the columns.
`protected Object[]`	`convertArray(List<String> columns)`	Returns an array from the columns.
`Object`	`get(String name, Object[] row)`	Returns the value in column with specified name.
`int`	`getColumnIndex(String name)`	Returns the column index of given column name.
`String`	`getColumnType(int columnIndex)`	Returns the type of a column.
`Object[]`	`getHeaderRow()`	Returns the header row.
`int`	`getLineCount()`	Line count reflects the lines in an input file.
`int`	`getMinimumColumnCount()`	Returns the minimum number of columns to be returned by `Iterator.next()`.
`int`	`getRowCount()`	Returns the row count.
`protected TypeConversionHandler`	`getTypeConversionHandler(String type)`	Returns a type conversion handler for the given type.
`boolean`	`hasHeaderRow()`	Tells whether the underlying stream has a header row or not
`protected int`	`incrementLineCount()`	Increases the line count.
`protected int`	`incrementRowCount()`	Increments the row Count.
`boolean`	`isHeaderRowRead()`
`Iterator<Object[]>`	`iterator()`
`protected void`	`notifyComment(String s, int row, int cell)`	Notifies all comment callbacks about a comment.
`void`	`open()`	Opens the CSV reader.
`protected void`	`readHeaderRow()`	Reads the header row if required.
`void`	`registerCommentCallBack(CommentCallback callback)`	Adds a comment callback.
`void`	`registerTypeConversionHandler(TypeConversionHandler handler)`	Registers a type conversion handler.
`void`	`removeCommentCallBack(CommentCallback callback)`	Deprecated. Use `TableReader.unregisterCommentCallBack(CommentCallback)` instead
`void`	`reset()`	Resets the CSV reader and its underlying stream.
`void`	`setColumnType(int columnIndex, Class<?> type)`	Explicitely set the type of a column.
`void`	`setHasHeaderRow(boolean hasHeaderRow)`	Tells the reader whether the underlying stream will treat first row as header row.
`protected void`	`setHeaderRow(String[] names)`	Sets the header rows.
`protected void`	`setHeaderRowRead(boolean headerRowRead)`
`void`	`setMinimumColumnCount(int length)`	Sets the minimum number of columns to be returned by `Iterator.next()`.
`void`	`unregisterCommentCallBack(CommentCallback callback)`	Removes a comment callback.
`void`	`unregisterTypeConversionHandler(TypeConversionHandler handler)`	Unregisters a type conversion handler.

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface java.util.Iterator
forEachRemaining, hasNext, next, remove

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractTableReader
```
public AbstractTableReader()
```
    Default Constructor.
- Method Detail
  - open
```
public void open()
```
    Opens the CSV reader.
    
    Specified by:
    
    open in interface TableReader
  - reset
```
public void reset()
```
    Resets the CSV reader and its underlying stream.
    
    Specified by:
    
    reset in interface TableReader
  - getHeaderRow
```
public Object[] getHeaderRow()
```
    Returns the header row.
    
    Specified by:
    
    getHeaderRow in interface TableReader
    
    Returns:
    
    header row if such was defined.
  - readHeaderRow
```
protected void readHeaderRow()
```
    Reads the header row if required. This is an empty method. Subclasses must override to correctly read the header row.
  - setHeaderRow
```
protected void setHeaderRow(String[] names)
```
    Sets the header rows.
    
    Parameters:
    
    names - names to be set
  - setHeaderRowRead
```
protected void setHeaderRowRead(boolean headerRowRead)
```
    Parameters:
    
    headerRowRead - the headerRowRead to set
  - get
```
public Object get(String name,
                  Object[] row)
```
    Returns the value in column with specified name. Returns null if row has no such column.
    
    Parameters:
    
    name - name of column (from header row)
    
    row - row of values
    
    Returns:
    
    value in row for specified column.
  - getColumnIndex
```
public int getColumnIndex(String name)
```
    Returns the column index of given column name. The first column with given name will be returned.
    
    Specified by:
    
    getColumnIndex in interface TableReader
    
    Parameters:
    
    name - name of column
    
    Returns:
    
    index of column or -1 if it does not exist.
  - setColumnType
```
public void setColumnType(int columnIndex,
                          Class<?> type)
```
    Explicitely set the type of a column. This information will be used to convert the value of this column.
    
    Parameters:
    
    columnIndex - index of column
    
    type - type of column
    
    See Also:
    
    getTypeConversionHandler(String), convert(int, String)
  - getColumnType
```
public String getColumnType(int columnIndex)
```
    Returns the type of a column. This information will be used to convert the value of this column.
    
    Parameters:
    
    columnIndex - index of column.
    
    Returns:
    
    type of values in column
    
    See Also:
    
    getTypeConversionHandler(String), convert(int, String)
  - hasHeaderRow
```
public boolean hasHeaderRow()
```
    Tells whether the underlying stream has a header row or not
    
    Specified by:
    
    hasHeaderRow in interface TableReader
    
    Returns:
    
    true if there is a header row.
  - setHasHeaderRow
```
public void setHasHeaderRow(boolean hasHeaderRow)
```
    Tells the reader whether the underlying stream will treat first row as header row.
    
    Specified by:
    
    setHasHeaderRow in interface TableReader
    
    Parameters:
    
    hasHeaderRow - true if there is a header row.
  - addCommentCallBack
```
public void addCommentCallBack(CommentCallback callback)
```
    Deprecated. Use TableReader.registerCommentCallBack(CommentCallback) instead.
    
    Adds a comment callback.
    
    Parameters:
    
    callback - the callback
  - registerCommentCallBack
```
public void registerCommentCallBack(CommentCallback callback)
```
    Adds a comment callback.
    
    Specified by:
    
    registerCommentCallBack in interface TableReader
    
    Parameters:
    
    callback - the callback
  - removeCommentCallBack
```
public void removeCommentCallBack(CommentCallback callback)
```
    Deprecated. Use TableReader.unregisterCommentCallBack(CommentCallback) instead
    
    Removes a comment callback.
    
    Parameters:
    
    callback - the callback
  - unregisterCommentCallBack
```
public void unregisterCommentCallBack(CommentCallback callback)
```
    Removes a comment callback.
    
    Specified by:
    
    unregisterCommentCallBack in interface TableReader
    
    Parameters:
    
    callback - the callback
  - iterator
```
public Iterator<Object[]> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Object[]>
  - notifyComment
```
protected void notifyComment(String s,
                             int row,
                             int cell)
```
    Notifies all comment callbacks about a comment.
    
    Parameters:
    
    s - the comment to notify about
    
    row - row number
    
    cell - cell number in row
  - registerTypeConversionHandler
```
public void registerTypeConversionHandler(TypeConversionHandler handler)
```
    Registers a type conversion handler.
    
    Parameters:
    
    handler - handler to register
  - unregisterTypeConversionHandler
```
public void unregisterTypeConversionHandler(TypeConversionHandler handler)
```
    Unregisters a type conversion handler.
    
    Parameters:
    
    handler - handler to unregister
  - convert
```
protected Object convert(int columnIndex,
                         String value)
```
    Converts the string back to correct object. This method will retrieve the column type from getColumnType(int) and then then forward the transformation to convert(String, String).
    
    Parameters:
    
    columnIndex - index of column of this value
    
    value - string representation of object
    
    Returns:
    
    object the converted object
    
    See Also:
    
    convert(String, String), registerTypeConversionHandler(TypeConversionHandler), getColumnType(int)
  - convert
```
protected Object convert(String type,
                         String value)
```
    Converts the string back to correct object.
    
    Parameters:
    
    type - type of object being returned
    
    value - string representation of object
    
    Returns:
    
    object
  - getTypeConversionHandler
```
protected TypeConversionHandler getTypeConversionHandler(String type)
```
    Returns a type conversion handler for the given type.
    
    Parameters:
    
    type - type to get a handler for
    
    Returns:
    
    conversion handler
  - incrementLineCount
```
protected int incrementLineCount()
```
    Increases the line count. Line count reflects the lines in an input file.
    
    Returns:
    
    lines read so far
  - getLineCount
```
public int getLineCount()
```
    Line count reflects the lines in an input file.
    
    Returns:
    
    lines read so far
  - incrementRowCount
```
protected int incrementRowCount()
```
    Increments the row Count. Row count is the number of netto rows (<= line count) meaning rows delivered by Iterator.next().
    
    Returns:
    
    rows delivered so far
  - getRowCount
```
public int getRowCount()
```
    Returns the row count. Row count is the number of netto rows (<= line count) meaning rows delivered by Iterator.next().
    
    Returns:
    
    rows delivered so far
  - close
```
public void close()
```
    Does nothing
    
    Specified by:
    
    close in interface TableReader
    
    See Also:
    
    TableReader.close()
  - setMinimumColumnCount
```
public void setMinimumColumnCount(int length)
```
    Description copied from interface: TableReader
    
    Sets the minimum number of columns to be returned by Iterator.next().
    
    Specified by:
    
    setMinimumColumnCount in interface TableReader
    
    Parameters:
    
    length - number of columns
    
    See Also:
    
    TableReader.setMinimumColumnCount(int)
  - getMinimumColumnCount
```
public int getMinimumColumnCount()
```
    Description copied from interface: TableReader
    
    Returns the minimum number of columns to be returned by Iterator.next().
    
    Specified by:
    
    getMinimumColumnCount in interface TableReader
    
    Returns:
    
    the minimumLineCount
  - convertArray
```
protected Object[] convertArray(List<String> columns)
```
    Returns an array from the columns. This function exists for convinience to take care of minimum column count.
    
    Parameters:
    
    columns - columns to return
    
    Returns:
    
    arrray with column values
  - convertArray
```
protected Object[] convertArray(String[] columns)
```
    Returns an array from the columns. This function exists for convinience to take care of minimum column count.
    
    Parameters:
    
    columns - columns to return
    
    Returns:
    
    arrray with column values
  - isHeaderRowRead
```
public boolean isHeaderRowRead()
```
    Returns:
    
    the headerRowRead

Class AbstractTableReader

Constructor Summary

Method Summary

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.Iterator

Methods inherited from class java.lang.Object

Constructor Detail

AbstractTableReader

Method Detail

open

reset

getHeaderRow

readHeaderRow

setHeaderRow

setHeaderRowRead

get

getColumnIndex

setColumnType

getColumnType

hasHeaderRow

setHasHeaderRow

addCommentCallBack

registerCommentCallBack

removeCommentCallBack

unregisterCommentCallBack

iterator

notifyComment

registerTypeConversionHandler

unregisterTypeConversionHandler

convert

convert

getTypeConversionHandler

incrementLineCount

getLineCount

incrementRowCount

getRowCount

close

setMinimumColumnCount

getMinimumColumnCount

convertArray

convertArray

isHeaderRowRead