de.unknownreality.dataframe.csv

Class CSVReaderBuilder

java.lang.Object

de.unknownreality.dataframe.csv.CSVReaderBuilder

All Implemented Interfaces:

ReaderBuilder<CSVHeader,CSVRow>

public class CSVReaderBuilder
extends Object
implements ReaderBuilder<CSVHeader,CSVRow>

Created by Alex on 09.03.2016.

Constructor Summary

Constructors

Constructor and Description
CSVReaderBuilder()

Method Summary

Modifier and Type	Method and Description
CSVReaderBuilder	addIgnorePrefix(String prefix) Adds an ignore line prefix.
CSVReaderBuilder	containsHeader(boolean containsHeader) Specifies whether the resulting reader considers a header line default: true
static CSVReaderBuilder	create() Creates csv reader builder instance
DataContainer<CSVHeader,CSVRow>	fromFile(File f) Creates a data container from a file.
DataContainer<CSVHeader,CSVRow>	fromResource(String content, ClassLoader classLoader) Creates a data container from a resoruce
DataContainer<CSVHeader,CSVRow>	fromString(String content) Creates a data container from a string
String	getHeaderPrefix()
Character	getSeparator()
boolean	isContainsHeader()
CSVReader	load(File file) Creates a CSVReader for the specified file
CSVReader	load(String content) Creates a CSVReader for the specified csv content string
void	loadAttributes(Map<String,String> attributes) Sets all attributes using a map "separator" = csv column separator "headerPrefix" = header line prefix "containsHeader" = reader considers header line (true or false)
CSVReader	loadResource(String resourcePath) Creates a CSVReader for a specified resource.
CSVReader	loadResource(String resourcePath, ClassLoader classLoader) Creates a CSVReader for a specified resource.
CSVReaderBuilder	withHeaderPrefix(String headerPrefix) Sets the header prefix used by the resulting reader.
CSVReaderBuilder	withSeparator(Character separator) Sets the csv column separator char used by the resulting reader default: '\t'

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVReaderBuilder

public CSVReaderBuilder()

Method Detail

create

public static CSVReaderBuilder create()

Creates csv reader builder instance

Returns:

csv reader

withSeparator

public CSVReaderBuilder withSeparator(Character separator)

Sets the csv column separator char used by the resulting reader

default: '\t'

Parameters:

separator - csv column separator

Returns:

self for method chaining

containsHeader

public CSVReaderBuilder containsHeader(boolean containsHeader)

Specifies whether the resulting reader considers a header line

default: true

Parameters:

containsHeader - header line parameter

Returns:

self for method chaining

addIgnorePrefix

public CSVReaderBuilder addIgnorePrefix(String prefix)

Adds an ignore line prefix. Lines beginning with this prefix are ignored by the resulting reader

Parameters:

prefix - ignore line prefix

Returns:

self for method chaining

withHeaderPrefix

public CSVReaderBuilder withHeaderPrefix(String headerPrefix)

Sets the header prefix used by the resulting reader. Only important if header line exists.

default:#

Parameters:

headerPrefix - header line prefix

Returns:

self for method chaining

getSeparator

public Character getSeparator()

getHeaderPrefix

public String getHeaderPrefix()

isContainsHeader

public boolean isContainsHeader()

load

public CSVReader load(File file)

Creates a CSVReader for the specified file

Parameters:

file - source file

Returns:

csv reader for source file

load

public CSVReader load(String content)

Creates a CSVReader for the specified csv content string

Parameters:

content - csv content string

Returns:

csv reader for content string

loadResource

public CSVReader loadResource(String resourcePath,
                              ClassLoader classLoader)

Creates a CSVReader for a specified resource. The provided ClassLoader is used to load the resource.

Parameters:

resourcePath - path to csv resource

classLoader - ClassLoader used to load the resource

Returns:

csv reader for resource

loadResource

public CSVReader loadResource(String resourcePath)

Creates a CSVReader for a specified resource. The ClassLoader of CSVResourceReader is used to load the resource.

Parameters:

resourcePath - path to csv resource

Returns:

csv reader for resource

loadAttributes

public void loadAttributes(Map<String,String> attributes)
                    throws Exception

Sets all attributes using a map

"separator" = csv column separator

"headerPrefix" = header line prefix

"containsHeader" = reader considers header line (true or false)

Specified by:

loadAttributes in interface ReaderBuilder<CSVHeader,CSVRow>

Parameters:

attributes - map of attributes

Throws:

Exception - throws an exception if an attribute can not be correctly parsed

fromFile

public DataContainer<CSVHeader,CSVRow> fromFile(File f)

Description copied from interface: ReaderBuilder

Creates a data container from a file.

Specified by:

fromFile in interface ReaderBuilder<CSVHeader,CSVRow>

Parameters:

f - file to be read

Returns:

created data container

See Also:

load(File)

fromString

public DataContainer<CSVHeader,CSVRow> fromString(String content)

Description copied from interface: ReaderBuilder

Creates a data container from a string

Specified by:

fromString in interface ReaderBuilder<CSVHeader,CSVRow>

Parameters:

content - string content used to create the data container

Returns:

created data container

See Also:

load(String)

fromResource

public DataContainer<CSVHeader,CSVRow> fromResource(String content,
                                                    ClassLoader classLoader)

Description copied from interface: ReaderBuilder

Creates a data container from a resoruce

Specified by:

fromResource in interface ReaderBuilder<CSVHeader,CSVRow>

Parameters:

content - resource path

classLoader - class loader

Returns:

created data container

See Also:

loadResource(String, ClassLoader)