FlatFileExecStream.h

Go to the documentation of this file.
00001 /*
00002 // $Id: //open/dev/fennel/flatfile/FlatFileExecStream.h#2 $
00003 // Fennel is a library of data storage and processing components.
00004 // Copyright (C) 2005-2009 The Eigenbase Project
00005 // Copyright (C) 2009-2009 SQLstream, Inc.
00006 // Copyright (C) 2004-2009 LucidEra, Inc.
00007 // Portions Copyright (C) 2004-2009 John V. Sichi
00008 //
00009 // This program is free software; you can redistribute it and/or modify it
00010 // under the terms of the GNU General Public License as published by the Free
00011 // Software Foundation; either version 2 of the License, or (at your option)
00012 // any later version approved by The Eigenbase Project.
00013 //
00014 // This program is distributed in the hope that it will be useful,
00015 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00016 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00017 // GNU General Public License for more details.
00018 //
00019 // You should have received a copy of the GNU General Public License
00020 // along with this program; if not, write to the Free Software
00021 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00022 */
00023 
00024 #ifndef Fennel_FlatFileExecStream_Included
00025 #define Fennel_FlatFileExecStream_Included
00026 
00027 #include "fennel/exec/SingleOutputExecStream.h"
00028 
00029 FENNEL_BEGIN_NAMESPACE
00030 
00034 enum FlatFileMode
00035 {
00036     FLATFILE_MODE_QUERY = 0,
00037     FLATFILE_MODE_DESCRIBE,
00038     FLATFILE_MODE_SAMPLE,
00039     FLATFILE_MODE_QUERY_TEXT
00040 };
00041 
00053 struct FlatFileExecStreamParams : public SingleOutputExecStreamParams
00054 {
00055     // TODO: Codepage support
00056 
00061     std::string dataFilePath;
00062 
00068     std::string errorFilePath;
00069 
00074     char fieldDelim;
00075 
00080     char rowDelim;
00081 
00088     char quoteChar;
00089 
00097     char escapeChar;
00098 
00104     bool header;
00105 
00109     int numRowsScan;
00110 
00114     std::string calcProgram;
00115 
00119     FlatFileMode mode;
00120 
00125     int errorMax;
00126 
00131     int errorLogMax;
00132 
00138     bool lenient;
00139 
00143     bool trim;
00144 
00150     bool mapped;
00151 
00155     std::vector<std::string> columnNames;
00156 
00157     explicit FlatFileExecStreamParams()
00158     {
00159         errorFilePath = "";
00160         fieldDelim = ',';
00161         rowDelim = '\n';
00162         quoteChar = '"';
00163         escapeChar = '\\';
00164         header = true;
00165         numRowsScan = 0;
00166         mode = FLATFILE_MODE_QUERY;
00167     }
00168 };
00169 
00182 class FENNEL_FLATFILE_EXPORT FlatFileExecStream
00183     : public SingleOutputExecStream
00184 {
00185 public:
00191     static FlatFileExecStream *newFlatFileExecStream();
00192 
00193     // implement ExecStream
00194     virtual void prepare(FlatFileExecStreamParams const &params) = 0;
00195 };
00196 
00197 FENNEL_END_NAMESPACE
00198 
00199 #endif
00200 
00201 // End FlatFileExecStream.h

Generated on Mon Jun 22 04:00:19 2009 for Fennel by  doxygen 1.5.1