CSVReader Class Reference

#include <ored/utilities/csvfilereader.hpp>

Inheritance diagram for CSVReader:

Collaboration diagram for CSVReader:

Public Member Functions
	CSVReader (const bool firstLineContainsHeaders, const std::string &delimiters=",;\t", const std::string &escapeCharacters="\\", const std::string &quoteCharacters="\"", const char eolMarker='\n')
virtual	~CSVReader ()
void	setStream (std::istream *stream)
const std::vector< std::string > &	fields () const
const bool	hasField (const std::string &field) const
Size	numberOfColumns () const
bool	next ()
Size	currentLine () const
std::string	get (const std::string &field) const
std::string	get (const Size column) const
virtual void	close ()

Private Attributes
std::istream *	stream_
const bool	hasHeaders_
const char	eolMarker_
Size	currentLine_
Size	numberOfColumns_
boost::tokenizer< boost::escaped_list_separator< char > >	tokenizer_
std::vector< std::string >	headers_
std::vector< std::string >	data_

Detailed Description

Definition at line 38 of file csvfilereader.hpp.

Constructor & Destructor Documentation

CSVReader()

CSVReader	(	const bool	firstLineContainsHeaders,
		const std::string &	delimiters = ",;\t",
		const std::string &	escapeCharacters = "\\",
		const std::string &	quoteCharacters = "\"",
		const char	eolMarker = '\n'
	)

Ctor

Definition at line 31 of file csvfilereader.cpp.

    : hasHeaders_(firstLineContainsHeaders), eolMarker_(eolMarker), currentLine_(Null<Size>()),
      numberOfColumns_(Null<Size>()),
      tokenizer_(std::string(), boost::escaped_list_separator<char>(escapeCharacters, delimiters, quoteCharacters)) {
}

~CSVReader()

virtual ~CSVReader ( )

virtual

Definition at line 45 of file csvfilereader.hpp.

{} // Declare virtual destructor

Member Function Documentation

setStream()

void setStream

(

std::istream *

stream

)

Set stream for function

Definition at line 38 of file csvfilereader.cpp.

                                            { 
     // set stream 
     stream_ = stream;
 
     if (hasHeaders_) {
         QL_REQUIRE(!stream_->eof(), "CSVReader: stream is empty");
         std::string line;
         getline(*stream_, line, eolMarker_);
         boost::trim(line);
         tokenizer_.assign(line);
         std::copy(tokenizer_.begin(), tokenizer_.end(), std::back_inserter(headers_));
         numberOfColumns_ = headers_.size();
     }
}

Here is the caller graph for this function:

fields()

const std::vector< std::string > & fields

(

)

const

Returns the fields, if a header line is present, otherwise throws

Definition at line 52 of file csvfilereader.cpp.

                                                    {
    //QL_REQUIRE(hasHeaders_, "CSVFileReader: no headers were specified for \"" << fileName_ << "\"");
    return headers_;
}

Here is the caller graph for this function:

hasField()

const bool hasField

(

const std::string &

field

)

const

Return true if a field is present

Definition at line 57 of file csvfilereader.cpp.

                                                           {
    return std::find(fields().begin(), fields().end(), field) != fields().end();
}

Here is the call graph for this function:

numberOfColumns()

Size numberOfColumns

(

)

const

Returns the number of columns

Definition at line 61 of file csvfilereader.cpp.

                                      {
    QL_REQUIRE(numberOfColumns_ != Null<Size>(), "CSVFileReader: number of columns not known (need call to next())");
    return numberOfColumns_;
}

Here is the caller graph for this function:

next()

bool next

(

)

Go to next line in file, returns false if there are no more lines

Definition at line 66 of file csvfilereader.cpp.

                     {
    //QL_REQUIRE(stream_->is_open(), "CSVFileReader: file is not open, can not move to next line");
    std::string line = "";
    // skip empty lines
    while (line.size() == 0 && !stream_->eof()) {
        getline(*stream_, line, eolMarker_);
        boost::trim(line);
    }
    if (stream_->eof() && line.empty()) {
        close();
        return false;
    }
    if (currentLine_ == Null<Size>())
        currentLine_ = 0;
    else
        ++currentLine_;
    tokenizer_.assign(line);
    data_.clear();
    std::copy(tokenizer_.begin(), tokenizer_.end(), std::back_inserter(data_));
    if (numberOfColumns_ == Null<Size>())
        numberOfColumns_ = data_.size();
    else
        QL_REQUIRE(data_.size() == numberOfColumns_, "CSVFileReader: data line #"
                                                         << currentLine_ << " has " << data_.size()
                                                         << " fields, expected " << numberOfColumns_);
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

currentLine()

Size currentLine

(

)

const

Number of the current data line

Definition at line 94 of file csvfilereader.cpp.

                                  {
    QL_REQUIRE(currentLine_ != Null<Size>(), "CSVFileReader: current line not known (need call to next())");
    return currentLine_;
}

get() [1/2]

std::string get

(

const std::string &

field

)

const

Get content of field in current data line, throws if field is not present

Definition at line 99 of file csvfilereader.cpp.

                                                     {
    QL_REQUIRE(hasHeaders_, "CSVFileReader: can not get data by field, file does not have headers");
    QL_REQUIRE(currentLine_ != Null<Size>(), "CSVFileReader: can not get data, need call to next() first");
    Size index = std::find(headers_.begin(), headers_.end(), field) - headers_.begin();
    QL_REQUIRE(index < headers_.size(), "CSVFileReader: field \"" << field << "\" not found.");
    QL_REQUIRE(index < data_.size(), "CSVFileReader: unexpected data size (" << data_.size() << "), required at least "
                                                                             << index + 1 << ", while reading field \""
                                                                             << field << "\"");
    return data_[index];
}

Here is the caller graph for this function:

get() [2/2]

std::string get

(

const Size

column

)

const

Get content of column in current data line, throws if column is out of range

Definition at line 110 of file csvfilereader.cpp.

                                                {
    QL_REQUIRE(column < numberOfColumns_,
               "CSVFileReader: column " << column << " out of bounds 0..." << (numberOfColumns_ - 1));
    QL_REQUIRE(column < data_.size(),
               "CSVFileReader: unexpected data size (" << data_.size() << "), while reading column " << column);
    return data_[column];
}

close()

virtual void close ( )

virtual

Close the file

Reimplemented in CSVFileReader.

Definition at line 65 of file csvfilereader.hpp.

{}

Here is the caller graph for this function:

Member Data Documentation

stream_

std::istream* stream_

private

Definition at line 68 of file csvfilereader.hpp.

hasHeaders_

const bool hasHeaders_

private

Definition at line 69 of file csvfilereader.hpp.

eolMarker_

const char eolMarker_

private

Definition at line 70 of file csvfilereader.hpp.

currentLine_

Size currentLine_

private

Definition at line 71 of file csvfilereader.hpp.

numberOfColumns_

Size numberOfColumns_

private

Definition at line 71 of file csvfilereader.hpp.

tokenizer_

boost::tokenizer<boost::escaped_list_separator<char> > tokenizer_

private

Definition at line 72 of file csvfilereader.hpp.

headers_

std::vector<std::string> headers_

private

Definition at line 73 of file csvfilereader.hpp.

data_

std::vector<std::string> data_

private

Definition at line 73 of file csvfilereader.hpp.