Qore CsvUtil Module Reference 1.11
Loading...
Searching...
No Matches
CsvWriteDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
2// Qore CsvWriteDataProvider class definition
3
4/* CsvWriteDataProvider.qc Copyright 2012 - 2024 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
28namespace CsvUtil {
31
32public:
34 const ProviderInfo = ...;
35
36
38 const ConstructorOptions = ...;
39
40
42 const CsvGenerationOptionList = keys (ConstructorOptions - ("path", "stream"));
43
44protected:
47
48public:
49
51
56 constructor(string path, *hash<auto> opts);
57
58
60
65 constructor(OutputStream stream, *hash<auto> opts);
66
67
69 string getName();
70
71
73 constructor(*hash<auto> options);
74
75
77protected:
78 *hash<string, AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
79public:
80
81
83
88protected:
89 *hash<auto> createRecordImpl(hash<auto> rec, *hash<auto> create_options);
90public:
91
92
94protected:
95 hash<DataProviderInfo> getStaticInfoImpl();
96public:
97
98};
99}; // CsvUtil namespace
The AbstractCsvWriter class provides a parent for all CSV writers.
Definition AbstractCsvWriter.qc.dox.h:139
Provides a data provider for reading CSV files.
Definition CsvWriteDataProvider.qc.dox.h:30
const ConstructorOptions
Constructor options.
Definition CsvWriteDataProvider.qc.dox.h:38
const ProviderInfo
Provider info.
Definition CsvWriteDataProvider.qc.dox.h:34
AbstractCsvWriter writer
the writer object
Definition CsvWriteDataProvider.qc.dox.h:46
constructor(OutputStream stream, *hash< auto > opts)
Creates the CsvWriteDataProvider with the output data stream where data will be writeen and an option...
*hash< string, AbstractDataField > getRecordTypeImpl(*hash< auto > search_options)
Returns the description of the record type, if any.
const CsvGenerationOptionList
CSV generation option list.
Definition CsvWriteDataProvider.qc.dox.h:42
constructor(*hash< auto > options)
Creates the object from constructor options.
string getName()
Returns the object name.
*hash< auto > createRecordImpl(hash< auto > rec, *hash< auto > create_options)
Creates the given record to the data provider.
constructor(string path, *hash< auto > opts)
Creates the CsvWriteDataProvider with the output path and optionally an option hash.
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
the CsvUtil namespace. All classes used in the CsvUtil module should be inside this namespace
Definition AbstractCsvIterator.qc.dox.h:28