Qore FixedLengthUtil Module Reference  1.2.1
FixedLengthWriteDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
2 // Qore FixedLengthWriteDataProvider class definition
3 
4 /* FixedLengthWriteDataProvider.qc Copyright 2012 - 2020 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 FixedLengthUtil {
30 class FixedLengthWriteDataProvider : public DataProvider::AbstractDataProvider {
31 
32 public:
34  const ProviderInfo = ...;
35 
36 
38  const ConstructorOptions = ...;
39 
40 
42  const FixedLengthWriteOptionList = keys (ConstructorOptions - ("path", "stream", "spec"));
43 
44 protected:
47 
48 public:
49 
51 
57  constructor(string path, hash<auto> specs, *hash<auto> opts);
58 
59 
61 
67  constructor(OutputStream stream, hash<auto> specs, *hash<auto> opts);
68 
69 
71  string getName();
72 
73 
75  constructor(*hash<auto> options);
76 
77 
79 protected:
80  *hash<string, AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
81 public:
82 
83 
85 
90 protected:
91  *hash<auto> createRecordImpl(hash<auto> rec, *hash<auto> create_options);
92 public:
93 
94 
96 protected:
97  hash<DataProviderInfo> getStaticInfoImpl();
98 public:
99 
100 };
101 }; // FixedLengthUtil namespace
FixedLengthAbstractWriter writer
the writer object
Definition: FixedLengthWriteDataProvider.qc.dox.h:46
Provides a data provider for reading fixed-length files.
Definition: FixedLengthWriteDataProvider.qc.dox.h:30
const FixedLengthWriteOptionList
write option list
Definition: FixedLengthWriteDataProvider.qc.dox.h:42
const ConstructorOptions
Constructor options.
Definition: FixedLengthWriteDataProvider.qc.dox.h:38
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
The FixedLengthUtil namespace contains all the definitions in the FixedLengthUtil module...
Definition: FixedLengthAbstractIterator.qc.dox.h:27
constructor(string path, hash< auto > specs, *hash< auto > opts)
Creates the FixedLengthWriteDataProvider with the output path and optionally an option hash...
Structured abstract writer for fixed-length lines.
Definition: FixedLengthAbstractWriter.qc.dox.h:29
*hash< auto > createRecordImpl(hash< auto > rec, *hash< auto > create_options)
Creates the given record to the data provider.
const ProviderInfo
Provider info.
Definition: FixedLengthWriteDataProvider.qc.dox.h:34
*hash< string, AbstractDataField > getRecordTypeImpl(*hash< auto > search_options)
Returns the description of the record type, if any.
string getName()
Returns the object name.