Package com.broadleafcommerce.dataimport.processor.csv

Class CSVFileReader

java.lang.Object

com.broadleafcommerce.dataimport.processor.csv.CSVFileReader

All Implemented Interfaces:

FileReader<CSVFileReader.CSVFileReaderContext>

public class CSVFileReader
extends Object
implements FileReader<CSVFileReader.CSVFileReaderContext>

Author:

Phillip Verheyden (phillipuniverse)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CSVFileReader.CSVFileReaderContext

Constructor Summary

Constructors

Constructor	Description
CSVFileReader()

Method Summary

Modifier and Type	Method	Description
protected com.univocity.parsers.csv.CsvParser	buildParser()
protected com.univocity.parsers.csv.CsvParserSettings	buildSettings()
boolean	canHandle(String fileType)	Whether or not this reader is applicable for the current context
long	countTotalItems(InputStream file)	Counts all of the data records within the file.
CSVFileReader.CSVFileReaderContext	createParsingContext(InputStream fileStream, long dataLinesToSkip)	Creates a parsing context that is passed back throughout the rest of the parsing flows.
long	currentLineNumber(CSVFileReader.CSVFileReaderContext ctx)	The current line that the context is pointing to, 1-indexed
String[]	getHeaders(CSVFileReader.CSVFileReaderContext ctx)	Obtains the headers for the given context
boolean	hasNext(CSVFileReader.CSVFileReaderContext ctx)	Whether or not there are more data records to read as determined by context.
Map<String,String>	readNextLine(CSVFileReader.CSVFileReaderContext ctx)	Returns the next row of data.

Methods inherited from class java.lang.Object

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

Constructor Details

CSVFileReader

public CSVFileReader()

Method Details

canHandle

public boolean canHandle(String fileType)

Description copied from interface: FileReader

Whether or not this reader is applicable for the current context

Specified by:

canHandle in interface FileReader<CSVFileReader.CSVFileReaderContext>

Parameters:

fileType - type of the file that should be read

Returns:

whether or not this can handle the given file type

countTotalItems

public long countTotalItems(InputStream file)

Description copied from interface: FileReader

Counts all of the data records within the file. This should not include all of the physical lines within the file. For instance this should not include the header line or any lines that are denoted as comments

Specified by:

countTotalItems in interface FileReader<CSVFileReader.CSVFileReaderContext>

Parameters:

file - file to count records for

Returns:

the total number of data records in the file

buildParser

protected com.univocity.parsers.csv.CsvParser buildParser()

buildSettings

protected com.univocity.parsers.csv.CsvParserSettings buildSettings()

createParsingContext

public CSVFileReader.CSVFileReaderContext createParsingContext(InputStream fileStream,
 long dataLinesToSkip)
                                                        throws IOException

Description copied from interface: FileReader

Creates a parsing context that is passed back throughout the rest of the parsing flows. This must be invoked before attempting to invoke the parsing logic, but is not required for couting records in the file. Any data necessary to read off items, open additional resources, etc should be initialized here and stored within the returned context

Specified by:

createParsingContext in interface FileReader<CSVFileReader.CSVFileReaderContext>

Parameters:

fileStream - the underlying file that should be read from

dataLinesToSkip - how many lines should be skipped from the read in file. Assuming there is a header line, given a current line number the lines to skip should subtract 2

Returns:

a context with reader-specific variables passed back through the lifecycle of the processing flow

Throws:

IOException

getHeaders

public String[] getHeaders(CSVFileReader.CSVFileReaderContext ctx)

Description copied from interface: FileReader

Obtains the headers for the given context

Specified by:

getHeaders in interface FileReader<CSVFileReader.CSVFileReaderContext>

Parameters:

ctx - the context initialized by FileReader.createParsingContext(InputStream, long)

Returns:

the headers from the file

currentLineNumber

public long currentLineNumber(CSVFileReader.CSVFileReaderContext ctx)

Description copied from interface: FileReader

The current line that the context is pointing to, 1-indexed

Specified by:

currentLineNumber in interface FileReader<CSVFileReader.CSVFileReaderContext>

Parameters:

ctx - the context initialized by FileReader.createParsingContext(InputStream, long)

Returns:

the current line number that this reader is pointing to based on the context

readNextLine

public Map<String,String> readNextLine(CSVFileReader.CSVFileReaderContext ctx)

Description copied from interface: FileReader

Returns the next row of data. Keys correspond to the headers and values are the specific values for those headers

Specified by:

readNextLine in interface FileReader<CSVFileReader.CSVFileReaderContext>

Parameters:

ctx - the context initialized by FileReader.createParsingContext(InputStream, long)

Returns:

a row of data from the file specified by context

hasNext

public boolean hasNext(CSVFileReader.CSVFileReaderContext ctx)

Description copied from interface: FileReader

Whether or not there are more data records to read as determined by context. Should be used as a guard against FileReader.readNextLine(FileReaderContext) to protect against an attempt at reading too far

Specified by:

hasNext in interface FileReader<CSVFileReader.CSVFileReaderContext>

Parameters:

ctx - the context initialized by FileReader.createParsingContext(InputStream, long)

Returns:

whether or not there are more data records to read