Package csv.impl
Class AbstractColumnFilter
java.lang.Object
csv.impl.AbstractColumnFilter
- All Implemented Interfaces:
TableReader
,Iterable<Object[]>
,Iterator<Object[]>
- Direct Known Subclasses:
DefaultColumnFilter
Filters columns from underlying table reader.
This is an abstract implementation only that eases filtering. Most of the
methods are forwared to underlying reader.
- Author:
- ralph
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes the underlying reader.protected Object[]
Filters columns within a row.Forwarded to underlying reader.int
getColumnIndex
(String name) Returns the column index of given column name.protected abstract int
getFilteredIndex
(int originalIndex) Returns the index in filtered row of the specified original column index.Object[]
Returns the header row.int
Returns the minimum number of columns to be returned byIterator.next()
.protected TableReader
Returns the underlying reader.protected int
Returns the index of current row (delivered rows only)boolean
Tells whether the underlying stream has a header row or notboolean
hasNext()
iterator()
Object[]
next()
void
open()
Opens the reader or resets it.void
registerCommentCallBack
(CommentCallback callback) Registers a comment callback.void
remove()
void
reset()
Resets the reader.void
setHasHeaderRow
(boolean hasHeaderRow) Tells the reader whether the underlying stream will treat first row as header row.void
setMinimumColumnCount
(int length) Sets the minimum number of columns to be returned byIterator.next()
.void
unregisterCommentCallBack
(CommentCallback callback) Unregisters a comment callback.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
Methods inherited from interface java.util.Iterator
forEachRemaining
-
Constructor Details
-
AbstractColumnFilter
Constructor.- Parameters:
reader
- the reader this filter shall process
-
-
Method Details
-
getReader
Returns the underlying reader.- Returns:
- the reader
-
close
public void close()Closes the underlying reader.- Specified by:
close
in interfaceTableReader
- See Also:
-
get
Forwarded to underlying reader.- Parameters:
name
- name of column (from header row)row
- row of values- Returns:
- the value in the respective column
- See Also:
-
getColumnIndex
Returns the column index of given column name. The first column with given name will be returned.- Specified by:
getColumnIndex
in interfaceTableReader
- Parameters:
name
- name of column- Returns:
- index of column or -1 if it does not exist.
-
getHeaderRow
Returns the header row. Please note that header rows are never delivered throughIterator.next()
.- Specified by:
getHeaderRow
in interfaceTableReader
- Returns:
- header row if such was defined.
-
getMinimumColumnCount
public int getMinimumColumnCount()Returns the minimum number of columns to be returned byIterator.next()
.- Specified by:
getMinimumColumnCount
in interfaceTableReader
- Returns:
- length number of columns
-
hasHeaderRow
public boolean hasHeaderRow()Tells whether the underlying stream has a header row or not- Specified by:
hasHeaderRow
in interfaceTableReader
- Returns:
- true if there is a header row.
-
open
public void open()Opens the reader or resets it.- Specified by:
open
in interfaceTableReader
-
iterator
-
registerCommentCallBack
Registers a comment callback. The callback will be executed when a comment is detected in input. Note that not all implementations actually support comments.- Specified by:
registerCommentCallBack
in interfaceTableReader
- Parameters:
callback
- callback to be registered
-
reset
public void reset()Resets the reader.- Specified by:
reset
in interfaceTableReader
-
setHasHeaderRow
public void setHasHeaderRow(boolean hasHeaderRow) Tells the reader whether the underlying stream will treat first row as header row.- Specified by:
setHasHeaderRow
in interfaceTableReader
- Parameters:
hasHeaderRow
- true if there is a header row.
-
setMinimumColumnCount
public void setMinimumColumnCount(int length) Sets the minimum number of columns to be returned byIterator.next()
.- Specified by:
setMinimumColumnCount
in interfaceTableReader
- Parameters:
length
- number of columns
-
unregisterCommentCallBack
Unregisters a comment callback. Note that not all implementations actually support comments.- Specified by:
unregisterCommentCallBack
in interfaceTableReader
- Parameters:
callback
- callback to be unregistered
-
hasNext
public boolean hasNext() -
getRowIndex
protected int getRowIndex()Returns the index of current row (delivered rows only)- Returns:
- the rowIndex
-
next
-
filter
Filters columns within a row. Do not override here but overridegetFilteredIndex(int)
instead.- Parameters:
row
- row to be filtered- Returns:
- row with filtered column sonly
- See Also:
-
getFilteredIndex
protected abstract int getFilteredIndex(int originalIndex) Returns the index in filtered row of the specified original column index.- Parameters:
originalIndex
- index of value in row from underlying reader- Returns:
- index of value in filtered row or -1 if column will not be visible.
-
remove
public void remove()
-