de.unknownreality.dataframe.csv

Class CSVReader

java.lang.Object

de.unknownreality.dataframe.csv.CSVReader

All Implemented Interfaces:

DataContainer<CSVHeader,CSVRow>, RowIterator<CSVRow>, Iterable<CSVRow>

Direct Known Subclasses:

CSVFileReader, CSVResourceReader, CSVStringReader

public abstract class CSVReader
extends Object
implements DataContainer<CSVHeader,CSVRow>

Created by Alex on 09.03.2016.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CSVReader(Character separator, boolean containsHeader, String headerPrefix, String[] ignorePrefixes) Creates a CSVIterator

Method Summary

Modifier and Type	Method and Description
boolean	containsHeader() Returns true if this reader considers a header row
CSVHeader	getHeader() Returns the csv header created by this reader
String	getHeaderPrefix() Returns the prefix for the header line used by this reader
String[]	getIgnorePrefixes() Returns the array of prefixes for lines ignored by this reader
Character	getSeparator() Returns the csv row separator used by this reader
void	initHeader() Reads and created the csv header
abstract CSVIterator	iterator() Returns a CSVIterator for this reader
<T> List<T>	map(Class<T> cl) Maps this data container to a list of entities.
DataFrameBuilder	toDataFrame() Converts this reader into a DataFrameBuilder.

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

Constructor Detail

CSVReader

protected CSVReader(Character separator,
                    boolean containsHeader,
                    String headerPrefix,
                    String[] ignorePrefixes)

Creates a CSVIterator

Parameters:

separator - csv column separator

containsHeader - specifies whether file contains header row

headerPrefix - specifies the prefix of the header row

ignorePrefixes - array of prefixes for lines that should be ignored

Method Detail

containsHeader

public boolean containsHeader()

Returns true if this reader considers a header row

Returns:

true if header row exists

getHeaderPrefix

public String getHeaderPrefix()

Returns the prefix for the header line used by this reader

Returns:

header line prefix

getSeparator

public Character getSeparator()

Returns the csv row separator used by this reader

Returns:

csv row separator

getHeader

public CSVHeader getHeader()

Returns the csv header created by this reader

Specified by:

getHeader in interface DataContainer<CSVHeader,CSVRow>

Returns:

csv header

getIgnorePrefixes

public String[] getIgnorePrefixes()

Returns the array of prefixes for lines ignored by this reader

Returns:

prefixes array

initHeader

public void initHeader()

Reads and created the csv header

iterator

public abstract CSVIterator iterator()

Returns a CSVIterator for this reader

Specified by:

iterator in interface Iterable<CSVRow>

Returns:

csv iterator

toDataFrame

public DataFrameBuilder toDataFrame()

Converts this reader into a DataFrameBuilder.

Returns:

DataFrameBuilder for this csv reader.

map

public <T> List<T> map(Class<T> cl)

Description copied from interface: DataContainer

Maps this data container to a list of entities.

Specified by:

map in interface DataContainer<CSVHeader,CSVRow>

Type Parameters:

T - type of entities

Parameters:

cl - class of resulting entities

Returns:

list of mapped entities

See Also:

DataMapper.map(DataContainer, Class)