| Qore FixedLengthUtil Module Reference 1.6

Loading...
Searching...
No Matches
FixedLengthReadDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
4/* FixedLengthReadDataProvider Copyright 2015 - 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
26 namespace FixedLengthUtil {
28
30 class FixedLengthReadDataProvider : public DataProvider::AbstractDataProvider {
31
32 public:
34 const ProviderInfo = ...;
35
36
38 const ConstructorOptions = ...;
39
40
42 const FixedLengthReadOptionList = keys (ConstructorOptions - ("path", "stream", "spec"));
43
44 protected:
46 FixedLengthAbstractIterator i;
47
48 public:
49
51
57 constructor(string path, hash<auto> spec, *hash<auto> opts);
58
59
61
67 constructor(StringInputStream stream, hash<auto> spec, *hash<auto> opts);
68
69
71
78 constructor(InputStream stream, *string encoding, hash<auto> spec, *hash<auto> opts);
79
80
82 constructor(*hash<auto> options);
83
84
86 string getName();
87
88
90
93 protected:
94 AbstractDataProviderRecordIterator searchRecordsImpl(*hash<auto> where_cond, *hash<auto> search_options);
95 public:
96
97
99
102 protected:
103 AbstractDataProviderRecordIterator searchRecordsImpl(*hash<DataProviderExpression> where_cond, *hash<auto> search_options);
104 public:
105
106
108 protected:
109 *hash<string, AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
110 public:
111
112
114 protected:
115 hash<DataProviderInfo> getStaticInfoImpl();
116 public:
117
118};
119};
FixedLengthUtil::FixedLengthAbstractIterator
Structured line iterator for abstract data allowing efficient "pipelined" processing.
Definition FixedLengthAbstractIterator.qc.dox.h:29
FixedLengthUtil::FixedLengthReadDataProvider
Provides a data provider for reading fixed-length files.
Definition FixedLengthReadDataProvider.qc.dox.h:30
FixedLengthUtil::FixedLengthReadDataProvider::FixedLengthReadOptionList
const FixedLengthReadOptionList
iteration option list
Definition FixedLengthReadDataProvider.qc.dox.h:42
FixedLengthUtil::FixedLengthReadDataProvider::constructor
constructor(StringInputStream stream, hash< auto > spec, *hash< auto > opts)
Creates the FixedLengthReadDataProvider with the string input data stream, the record specifications,...
FixedLengthUtil::FixedLengthReadDataProvider::constructor
constructor(InputStream stream, *string encoding, hash< auto > spec, *hash< auto > opts)
Creates the FixedLengthReadDataProvider from a binary input data stream, the record specifications,...
FixedLengthUtil::FixedLengthReadDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
FixedLengthUtil::FixedLengthReadDataProvider::getRecordTypeImpl
*hash< string, AbstractDataField > getRecordTypeImpl(*hash< auto > search_options)
Returns the description of the record type, if any.
FixedLengthUtil::FixedLengthReadDataProvider::searchRecordsImpl
AbstractDataProviderRecordIterator searchRecordsImpl(*hash< DataProviderExpression > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
FixedLengthUtil::FixedLengthReadDataProvider::getStaticInfoImpl
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
FixedLengthUtil::FixedLengthReadDataProvider::constructor
constructor(string path, hash< auto > spec, *hash< auto > opts)
Creates the FixedLengthReadDataProvider with the input data path, the record specifications,...
FixedLengthUtil::FixedLengthReadDataProvider::i
FixedLengthAbstractIterator i
The iterator object.
Definition FixedLengthReadDataProvider.qc.dox.h:46
FixedLengthUtil::FixedLengthReadDataProvider::ConstructorOptions
const ConstructorOptions
Constructor options.
Definition FixedLengthReadDataProvider.qc.dox.h:38
FixedLengthUtil::FixedLengthReadDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition FixedLengthReadDataProvider.qc.dox.h:34
FixedLengthUtil::FixedLengthReadDataProvider::searchRecordsImpl
AbstractDataProviderRecordIterator searchRecordsImpl(*hash< auto > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
FixedLengthUtil::FixedLengthReadDataProvider::getName
string getName()
Returns the object name.
FixedLengthUtil
The FixedLengthUtil namespace contains all the definitions in the FixedLengthUtil module.
Definition FixedLengthAbstractIterator.qc.dox.h:27