sella::file::GZCSVPathReader Class Reference

A GZIP compressed CSV path reader class. More...

#include <GZCSVPathReader.h>

Public Member Functions
	STANDARD_TYPEDEF (sella::file::GZCSVPathReader)
	GZCSVPathReader (const std::string &path, char delimiter=DefaultDelimiter, char seperator=DefaultSeperator) THROWS(IOException)
void	read (std::vector< std::vector< std::string >> &data) THROWS(IOException)

Static Public Attributes
static const char *	FileSuffix = ".csv.gz"
	The file suffix for matching files in the directory for reading.
static const char	DefaultDelimiter = 0x1e
	The default delimiter used between the fields of a record; the ASCII record seperator character.
static const char	DefaultSeperator = 0x1d
	The default seperator used between the records of a file; the ASCII group seperator character.

Static Protected Member Functions
static int	filter (const struct dirent *file) NO_EXCEPTIONS

Detailed Description

A GZIP compressed CSV path reader class.

Definition at line 34 of file GZCSVPathReader.h.

Constructor & Destructor Documentation

GZCSVPathReader::GZCSVPathReader	(	const std::string &	path,
		char	delimiter = DefaultDelimiter,
		char	seperator = DefaultSeperator
	)

The base constructor for a path reader.

Parameters

[in]	path	The full path to write files to.
[in]	delimiter	The field delimiter character for files.
[in]	seperator	The record seperator character for files.

Exceptions

IOException

if the path cannot be opened for reading.

Definition at line 31 of file GZCSVPathReader.cpp.

                                                                                                           :
        path(path),

        delimiter(delimiter),
        seperator(seperator)
{
        /* Ensure the supplied path is valid. */
        DIR * directory = ::opendir(this->path.c_str());

        if (directory == NULL) {
                THROW(IOException, "failed to open directory '%s' for reading", this->path.c_str());
        }
        ::closedir(directory);

        /* Remove any trailing slash characters from the path. */
        while (*(this->path.rbegin()) == '/') {
                this->path.erase(this->path.length() - 1, 1);
        }
}

Member Function Documentation

int GZCSVPathReader::filter ( const struct dirent *  file )

staticprotected

Filter files from the path based on their name.

Parameters

[in]

file

The direct structure for a single file.

Returns

1 if the file matches the desired patter, or 0 if it does not.

Definition at line 93 of file GZCSVPathReader.cpp.

References FileSuffix.

Referenced by read().

                                                                    {
        static size_t base = ::strlen(GZCSVPathReader::FileSuffix);
        size_t        size = ::strlen(file->d_name);
        
        if ((size >= base) && (::strncmp(&(file->d_name[size - base]), GZCSVPathReader::FileSuffix, base) == 0)) {
                return 1;
        }
        return 0;
}

void GZCSVPathReader::read

(

std::vector< std::vector< std::string >> &

data

)

Read all files in the path defined for this instance.

Parameters

[in]

data

The vector to which all data will be written; if not empty this function will clear the vector before writing data.

Exceptions

IOException

if unabled to read the directory for any reason.

Definition at line 59 of file GZCSVPathReader.cpp.

References sella::file::GZCSVFileReader::close(), filter(), and sella::file::GZCSVFileReader::read().

                                                                                     {
        struct dirent ** file;
        int              n;

        /* Clear the result set before reading. */
        if (data.empty() == false) {
                data.clear();
        }

        /* Read all record entries from all files. */
        if ((n = ::scandir(this->path.c_str(), &file, GZCSVPathReader::filter, ::alphasort)) >= 0) {
                for (int i = 0; i < n; i++) {
                        try {
                                GZCSVFileReader reader(std::string(this->path).append("/").append(file[i]->d_name), this->delimiter, this->seperator);

                                reader.read(data);
                                reader.close();
                        } catch (IOException & e) { /* IGNORE */ }

                        ::free(file[i]);
                }
                ::free(file);
        } else {
                THROW(IOException, "failed to open directory '%s' for reading", this->path.c_str());
        }
}

---

The documentation for this class was generated from the following files:

• /home/sella/digitalgenesis/libutil++/releases/rpm/BUILD/libutil++-1.9.3/src/sella/file/GZCSVPathReader.h
• /home/sella/digitalgenesis/libutil++/releases/rpm/BUILD/libutil++-1.9.3/src/sella/file/GZCSVPathReader.cpp