org.databene.formats.csv

Class CSVLineIterator

java.lang.Object

org.databene.formats.csv.CSVLineIterator

All Implemented Interfaces:

Closeable, AutoCloseable, DataIterator<String[]>

public class CSVLineIterator
extends Object
implements DataIterator<String[]>

Gives access to content of a CSV file by String arrays that represent the CSV rows as specified in RFC 4180.

Author:

Volker Bergmann

See Also:

https://www.ietf.org/rfc/rfc4180.txt

Field Summary

Fields

Modifier and Type	Field and Description
static char	DEFAULT_SEPARATOR The default separator to use

Constructor Summary

Constructors

Constructor and Description
CSVLineIterator(Reader reader, char separator) Creates a parser that reads from a reader and used a special separator character
CSVLineIterator(Reader reader, char separator, boolean ignoreEmptyLines)
CSVLineIterator(String uri) Creates a parser that reads from a uri
CSVLineIterator(String uri, char separator) Creates a parser that reads from a uri
CSVLineIterator(String uri, char separator, boolean ignoreEmptyLines)
CSVLineIterator(String uri, char separator, boolean ignoreEmptyLines, String encoding)
CSVLineIterator(String uri, char separator, String encoding)

Method Summary

Modifier and Type	Method and Description
String	cellByHeader(String header, String[] data)
String[]	cellsByHeaders(String[] headers, String[] data)
void	close() Closes the source
int	columnIndexOfHeader(String header)
Class<String[]>	getType() Returns the type of the iterated elements.
int	lineCount()
DataContainer<String[]>	next(DataContainer<String[]> wrapper) Parses a CSV row into an array of Strings
static void	process(String uri, char separator, String encoding, boolean ignoreEmptyLines, CSVLineHandler lineHandler)
void	setHeaders(String[] headers)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SEPARATOR

public static final char DEFAULT_SEPARATOR

The default separator to use

See Also:

Constant Field Values

Constructor Detail

CSVLineIterator

public CSVLineIterator(String uri)
                throws IOException

Creates a parser that reads from a uri

Parameters:

uri - the URL to read from

Throws:

IOException - if uri access failed

CSVLineIterator

public CSVLineIterator(String uri,
                       char separator)
                throws IOException

Creates a parser that reads from a uri

Parameters:

uri - the URL to read from

separator - the cell separator character

Throws:

IOException - if stream access fails

CSVLineIterator

public CSVLineIterator(String uri,
                       char separator,
                       String encoding)
                throws IOException

Throws:

IOException

CSVLineIterator

public CSVLineIterator(String uri,
                       char separator,
                       boolean ignoreEmptyLines)
                throws IOException

Throws:

IOException

CSVLineIterator

public CSVLineIterator(String uri,
                       char separator,
                       boolean ignoreEmptyLines,
                       String encoding)
                throws IOException

Throws:

IOException

CSVLineIterator

public CSVLineIterator(Reader reader,
                       char separator)
                throws IOException

Creates a parser that reads from a reader and used a special separator character

Parameters:

reader - the reader to use

separator - the separator character

Throws:

IOException - if reader access fails

CSVLineIterator

public CSVLineIterator(Reader reader,
                       char separator,
                       boolean ignoreEmptyLines)
                throws IOException

Throws:

IOException

Method Detail

setHeaders

public void setHeaders(String[] headers)

getType

public Class<String[]> getType()

Description copied from interface: DataIterator

Returns the type of the iterated elements.

Specified by:

getType in interface DataIterator<String[]>

Returns:

the type of iterated data

next

public DataContainer<String[]> next(DataContainer<String[]> wrapper)

Parses a CSV row into an array of Strings

Specified by:

next in interface DataIterator<String[]>

Parameters:

wrapper - a DataContainer to receive the iterated data

Returns:

an array of Strings that represents a CSV row

cellsByHeaders

public String[] cellsByHeaders(String[] headers,
                               String[] data)

cellByHeader

public String cellByHeader(String header,
                           String[] data)

columnIndexOfHeader

public int columnIndexOfHeader(String header)

close

public void close()

Closes the source

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface DataIterator<String[]>

lineCount

public int lineCount()

process

public static void process(String uri,
                           char separator,
                           String encoding,
                           boolean ignoreEmptyLines,
                           CSVLineHandler lineHandler)
                    throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object