csv.impl

Class AbstractStreamTableReader

java.lang.Object

csv.impl.AbstractTableReader

csv.impl.AbstractStreamTableReader

All Implemented Interfaces:

TableReader, Iterator<Object[]>

Direct Known Subclasses:

CSVReader, ExcelReader, XmlReader

public abstract class AbstractStreamTableReader
extends AbstractTableReader

An abstract implementation of TableReader. This implementation takes care of simple stream handling.

Author:

RalphSchuster

Constructor Summary

Constructors

Constructor and Description
AbstractStreamTableReader() Default Constructor.
AbstractStreamTableReader(File file) Creates a new instance of Reader.
AbstractStreamTableReader(InputStream in) The constructor for a given input stream.
AbstractStreamTableReader(String file) Creates a new instance of Reader.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the reader and its underlying stream.
protected InputStreamReader	createInputStreamReader(InputStream stream) Creates the input stream reader that feeds the buffered reader.
protected BufferedReader	createReader() Creates the buffered reader.
CharsetDecoder	getCharsetDecoder() Returns the charset decoder to be used.
InputStream	getInputStream() Returns the underlying input stream.
protected BufferedReader	getReader() Returns the underlying reader.
void	remove() This method throws an exception.
void	reset() Resets the reader and its underlying stream.
void	setCharset(Charset charset) Sets the charset to be used on the input stream.
void	setCharset(String charset) Sets the charset to be used on the input stream.
void	setCharsetDecoder(CharsetDecoder charsetDecoder) Sets the charset decoder to be used on the input stream.
void	setInputStream(InputStream in) Sets the input stream.

Methods inherited from class csv.impl.AbstractTableReader

addCommentCallBack, convert, convert, convertArray, convertArray, get, getColumnIndex, getColumnType, getHeaderRow, getLineCount, getMinimumColumnCount, getRowCount, getTypeConversionHandler, hasHeaderRow, incrementLineCount, incrementRowCount, isHeaderRowRead, notifyComment, open, readHeaderRow, registerCommentCallBack, registerTypeConversionHandler, removeCommentCallBack, setColumnType, setHasHeaderRow, setHeaderRow, setHeaderRowRead, setMinimumColumnCount, unregisterCommentCallBack, unregisterTypeConversionHandler

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

hasNext, next

Constructor Detail

AbstractStreamTableReader

public AbstractStreamTableReader()

Default Constructor.

AbstractStreamTableReader

public AbstractStreamTableReader(InputStream in)

The constructor for a given input stream.

Parameters:

in - input stream

AbstractStreamTableReader

public AbstractStreamTableReader(File file)
                          throws FileNotFoundException

Creates a new instance of Reader.

Parameters:

file - file to read from

Throws:

FileNotFoundException - when the file could not be found.

AbstractStreamTableReader

public AbstractStreamTableReader(String file)
                          throws FileNotFoundException

Creates a new instance of Reader.

Parameters:

file - file to read from

Throws:

FileNotFoundException - when the file could not be found.

Method Detail

setInputStream

public void setInputStream(InputStream in)

Sets the input stream. This implementation throws an exception when the stream is already set.

Parameters:

in - the stream to set

getReader

protected BufferedReader getReader()

Returns the underlying reader.

Returns:

reader object

createReader

protected BufferedReader createReader()

Creates the buffered reader. The method will call createInputStreamReader(InputStream) for the creation of the underlying reader.

Returns:

the buffered reader.

createInputStreamReader

protected InputStreamReader createInputStreamReader(InputStream stream)

Creates the input stream reader that feeds the buffered reader.

Parameters:

stream - the original input stream

Returns:

the stream reader

getCharsetDecoder

public CharsetDecoder getCharsetDecoder()

Returns the charset decoder to be used.

Returns:

the charset decoder

setCharsetDecoder

public void setCharsetDecoder(CharsetDecoder charsetDecoder)

Sets the charset decoder to be used on the input stream.

Parameters:

charsetDecoder - the charset decoder to set

setCharset

public void setCharset(Charset charset)

Sets the charset to be used on the input stream.

Parameters:

charset - the charset to set

setCharset

public void setCharset(String charset)

Sets the charset to be used on the input stream.

Parameters:

charset - the charset to set

getInputStream

public InputStream getInputStream()

Returns the underlying input stream.

Returns:

the inputStream

reset

public void reset()

Resets the reader and its underlying stream.

Specified by:

reset in interface TableReader

Overrides:

reset in class AbstractTableReader

remove

public void remove()

This method throws an exception. Input streams cannot support the remove method.

close

public void close()

Closes the reader and its underlying stream.

Specified by:

close in interface TableReader

Overrides:

close in class AbstractTableReader

See Also:

TableReader.close()