$darkmode

| Qore CsvUtil Module Reference 1.10

AbstractCsvWriter.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
2// Qore AbstractCsvWriter class definition
3
4/* AbstractCsvWriter.qc Copyright 2012 - 2023 Qore Technologies, s.r.o.
5
6 Permission is hereby granted, free of charge, to any person obtaining a
7 copy of this software and associated documentation files (the "Software"),
8 to deal in the Software without restriction, including without limitation
9 the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 and/or sell copies of the Software, and to permit persons to whom the
11 Software is furnished to do so, subject to the following conditions:
12
13 The above copyright notice and this permission notice shall be included in
14 all copies or substantial portions of the Software.
15
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 DEALINGS IN THE SOFTWARE.
23*/
24
25// assume local var scope, do not use "$" for vars, members, and method calls
26
28 namespace CsvUtil {
30
139 class AbstractCsvWriter : protected CsvHelper {
140
141 public:
142 protected:
144 const Options = {
145 "block": C_OPT1|C_OPT2,
146 "datamap": C_OPT1,
147 "date_format": C_OPT1|C_OPT2,
148 "date-format": C_OPT1|C_OPT2,
149 "encoding": C_OPT1|C_OPT2,
150 "eol": C_OPT1|C_OPT2,
151 "fields": C_OPT1,
152 "headers": C_OPT1,
153 "header_reorder": C_OPT1,
154 "info_log": C_OPT1|C_OPT2,
155 "number_format": C_OPT1|C_OPT2,
156 "optimal_quotes": C_OPT1|C_OPT2,
157 "optimal-quotes": C_OPT1|C_OPT2,
158 "quote": C_OPT1|C_OPT2,
159 "quote_escape": C_OPT1|C_OPT2,
160 "separator": C_OPT1|C_OPT2,
161 "verify_columns": C_OPT1|C_OPT2,
162 "verify-columns": C_OPT1|C_OPT2,
163 "write_headers": C_OPT1|C_OPT2,
164 "write-headers": C_OPT1|C_OPT2,
165 };
166
168 string encoding;
169
171 string separator = ",";
172
174 string quote = "\"";
175
177 string m_quoteEscapeChar = "\\";
178
180 string eol = EOL_UNIX;
181
183 bool checkElementCounts = False;
184
186 int lineNo = 0;
187
189 int block = 1000;
190
192 string baseTemplate;
193
195 bool write_headers = True;
196
198 bool optimal_quotes = True;
199
201 *code info_log;
202
204 hash m_out_by_name;
205
207 hash m_out_by_idx;
208
209 public:
210
212
218 constructor(string n_errname, *hash<auto> n_opts);
219
220
222
230 constructor(string n_errname, hash<auto> spec, hash<auto> n_opts);
231
232
234 *hash<string, AbstractDataField> getRecordType();
235
236
238 protected:
239 processCommonOptions(*hash<auto> n_opts, int C_OPTx);
240 public:
241
242
244 protected:
245 processSpec();
246 public:
247
248
250 protected:
251 writeHeaders();
252 public:
253
254
256
261 writeLine(list<auto> values);
262
263
265
270 writeLine(hash<auto> values);
271
272
274
280 writeLine(string type, list<auto> values);
281
282
284
290 writeLine(string type, hash<auto> values);
291
292
294
301 write(Qore::AbstractIterator iterator);
302
303
305
312 write(Qore::SQL::SQLStatement iterator);
313
314
316
323 write(list<auto> l);
324
325
327 protected:
328 abstract writeRawLine(list<auto> values);
329 public:
330
332
337 protected:
338 string prepareRawLine(list<auto> values);
339 public:
340
341
342 protected:
343 string prepareRawLineIntern(list<auto> values);
344 public:
345
346
347 }; // AbstractCsvWriter class
348}; // CsvUtil namespace
CsvUtil::AbstractCsvWriter
The AbstractCsvWriter class provides a parent for all CSV writers.
Definition: AbstractCsvWriter.qc.dox.h:139
CsvUtil::AbstractCsvWriter::baseTemplate
string baseTemplate
base template for value format
Definition: AbstractCsvWriter.qc.dox.h:192
CsvUtil::AbstractCsvWriter::write
write(Qore::AbstractIterator iterator)
Stream an iterator into the output.
CsvUtil::AbstractCsvWriter::writeRawLine
abstract writeRawLine(list< auto > values)
This method must be overridden in child classes to provide the output implementation.
CsvUtil::AbstractCsvWriter::writeLine
writeLine(hash< auto > values)
Write a line with headers-values hash.
CsvUtil::AbstractCsvWriter::writeLine
writeLine(string type, hash< auto > values)
Write a line for a specific record from a hash to the output.
CsvUtil::AbstractCsvWriter::prepareRawLine
string prepareRawLine(list< auto > values)
Prepare a string (line with EOF) with formatting and escaping.
CsvUtil::AbstractCsvWriter::constructor
constructor(string n_errname, hash< auto > spec, hash< auto > n_opts)
Creates the AbstractCsvWriter in single-type mode.
CsvUtil::AbstractCsvWriter::write
write(list< auto > l)
Stream the contents of the list into the output.
CsvUtil::AbstractCsvWriter::write
write(Qore::SQL::SQLStatement iterator)
Stream an iterator into the output.
CsvUtil::AbstractCsvWriter::block
int block
block size for bulk DML
Definition: AbstractCsvWriter.qc.dox.h:189
CsvUtil::AbstractCsvWriter::getRecordType
*hash< string, AbstractDataField > getRecordType()
Returns the description of the record type, if any.
CsvUtil::AbstractCsvWriter::encoding
string encoding
output file character encoding
Definition: AbstractCsvWriter.qc.dox.h:168
CsvUtil::AbstractCsvWriter::m_out_by_name
hash m_out_by_name
mapping output field by name
Definition: AbstractCsvWriter.qc.dox.h:204
CsvUtil::AbstractCsvWriter::quote
string quote
field content delimiter
Definition: AbstractCsvWriter.qc.dox.h:174
CsvUtil::AbstractCsvWriter::eol
string eol
end of line sequence
Definition: AbstractCsvWriter.qc.dox.h:180
CsvUtil::AbstractCsvWriter::writeHeaders
writeHeaders()
Write csv headers.
CsvUtil::AbstractCsvWriter::write_headers
bool write_headers
this flag determines if any stored headers are output
Definition: AbstractCsvWriter.qc.dox.h:195
CsvUtil::AbstractCsvWriter::info_log
*code info_log
a closure/call reference for informational logging when using write(SQLStatement)
Definition: AbstractCsvWriter.qc.dox.h:201
CsvUtil::AbstractCsvWriter::optimal_quotes
bool optimal_quotes
stores the optimal quotes option
Definition: AbstractCsvWriter.qc.dox.h:198
CsvUtil::AbstractCsvWriter::m_quoteEscapeChar
string m_quoteEscapeChar
quote escape character
Definition: AbstractCsvWriter.qc.dox.h:177
CsvUtil::AbstractCsvWriter::Options
const Options
valid options for the object (a hash for quick lookups of valid keys)
Definition: AbstractCsvWriter.qc.dox.h:144
CsvUtil::AbstractCsvWriter::checkElementCounts
bool checkElementCounts
verify the column count for every row; if a row does not match, then throw a CSVFILEITERATOR-DATA-ERR...
Definition: AbstractCsvWriter.qc.dox.h:183
CsvUtil::AbstractCsvWriter::separator
string separator
field separator
Definition: AbstractCsvWriter.qc.dox.h:171
CsvUtil::AbstractCsvWriter::lineNo
int lineNo
the latest line number
Definition: AbstractCsvWriter.qc.dox.h:186
CsvUtil::AbstractCsvWriter::constructor
constructor(string n_errname, *hash< auto > n_opts)
Creates the AbstractCsvWriter in single-type mode.
CsvUtil::AbstractCsvWriter::m_out_by_idx
hash m_out_by_idx
mapping output field by index
Definition: AbstractCsvWriter.qc.dox.h:207
CsvUtil::AbstractCsvWriter::writeLine
writeLine(string type, list< auto > values)
Write a line with headers-values list.
CsvUtil::AbstractCsvWriter::writeLine
writeLine(list< auto > values)
Write a line with a list of values; data are checked against column rules.
CsvUtil::AbstractCsvWriter::processCommonOptions
processCommonOptions(*hash< auto > n_opts, int C_OPTx)
Process options and set internal variables.
CsvUtil::AbstractCsvWriter::processSpec
processSpec()
Process specification and set internal variable for mapping.
Qore::AbstractIterator
Qore::SQL::SQLStatement
True
const True
False
const False
type
string type(auto arg)
hash
hash< auto > hash(object obj)
CsvUtil
the CsvUtil namespace. All classes used in the CsvUtil module should be inside this namespace
Definition: AbstractCsvIterator.qc.dox.h:28
CsvUtil::EOL_UNIX
const EOL_UNIX
Unix end of line character sequence (for new OS X too)
Definition: CsvUtil.qm.dox.h:337