FlatFileExecStream.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/flatfile/FlatFileExecStream.h#2 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2005-2009 The Eigenbase Project
// Copyright (C) 2009-2009 SQLstream, Inc.
// Copyright (C) 2004-2009 LucidEra, Inc.
// Portions Copyright (C) 2004-2009 John V. Sichi
//
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 2 of the License, or (at your option)
// any later version approved by The Eigenbase Project.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef Fennel_FlatFileExecStream_Included
#define Fennel_FlatFileExecStream_Included

#include "fennel/exec/SingleOutputExecStream.h"

FENNEL_BEGIN_NAMESPACE

enum FlatFileMode
{
    FLATFILE_MODE_QUERY = 0,
    FLATFILE_MODE_DESCRIBE,
    FLATFILE_MODE_SAMPLE,
    FLATFILE_MODE_QUERY_TEXT
};

struct FlatFileExecStreamParams : public SingleOutputExecStreamParams
{
    // TODO: Codepage support

    std::string dataFilePath;

    std::string errorFilePath;

    char fieldDelim;

    char rowDelim;

    char quoteChar;

    char escapeChar;

    bool header;

    int numRowsScan;

    std::string calcProgram;

    FlatFileMode mode;

    int errorMax;

    int errorLogMax;

    bool lenient;

    bool trim;

    bool mapped;

    std::vector<std::string> columnNames;

    explicit FlatFileExecStreamParams()
    {
        errorFilePath = "";
        fieldDelim = ',';
        rowDelim = '\n';
        quoteChar = '"';
        escapeChar = '\\';
        header = true;
        numRowsScan = 0;
        mode = FLATFILE_MODE_QUERY;
    }
};

class FENNEL_FLATFILE_EXPORT FlatFileExecStream
    : public SingleOutputExecStream
{
public:
    static FlatFileExecStream *newFlatFileExecStream();

    // implement ExecStream
    virtual void prepare(FlatFileExecStreamParams const &params) = 0;
};

FENNEL_END_NAMESPACE

#endif

// End FlatFileExecStream.h

---