Qore FixedLengthUtil Module Reference  1.2
FixedLengthReadDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
4 /* FixedLengthReadDataProvider Copyright 2015 - 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 
27 namespace FixedLengthUtil {
29 class FixedLengthReadDataProvider : public DataProvider::AbstractDataProvider {
30 
31 public:
33  const ProviderInfo = <DataProviderInfo>{
34  "type": "FixedLengthReadDataProvider",
35  "supports_read": True,
36  "has_record": True,
37  "constructor_options": ConstructorOptions,
38  };
39 
42  "path": <DataProviderOptionInfo>{
43  "type": AbstractDataProviderType::get(StringType),
44  "desc": "the path to the fixed-length data; mutually exclusive with \"stream\"",
45  },
46  "stream": <DataProviderOptionInfo>{
47  "type": AbstractDataProviderType::get(new Type("InputStream")),
48  "desc": "the input stream for fixed-length data; mutually exclusive with \"path\"",
49  },
50  "spec": <DataProviderOptionInfo>{
51  "type": AbstractDataProviderType::get(AutoHashType),
52  "desc": "the fixed-length record specification hash",
53  "required": True,
54  },
55  "opts": <DataProviderOptionInfo>{
56  "type": AbstractDataProviderType::get(AutoHashType),
57  "desc": "fixed-length parsing options",
58  },
59  };
60 
61 protected:
64 
65 public:
66 
68 
74  constructor(string path, hash<auto> spec, *hash<auto> opts);
75 
76 
78 
84  constructor(StringInputStream stream, hash<auto> spec, *hash<auto> opts);
85 
86 
88 
95  constructor(InputStream stream, *string encoding, hash<auto> spec, *hash<auto> opts);
96 
97 
99  constructor(*hash<auto> options);
100 
101 
103  string getName();
104 
105 
107 
110 protected:
111  AbstractDataProviderRecordIterator searchRecordsImpl(*hash<auto> where_cond, *hash<auto> search_options);
112 public:
113 
114 
116 protected:
117  *hash<string, AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
118 public:
119 
120 
122 protected:
123  hash<DataProviderInfo> getStaticInfoImpl();
124 public:
125 
126 };
127 };
Structured line iterator for abstract data allowing efficient "pipelined" processing.
Definition: FixedLengthAbstractIterator.qc.dox.h:29
AbstractDataProviderRecordIterator searchRecordsImpl(*hash< auto > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
string getName()
Returns the object name.
*hash< string, AbstractDataField > getRecordTypeImpl(*hash< auto > search_options)
Returns the description of the record type, if any.
const True
FixedLengthAbstractIterator i
The iterator object.
Definition: FixedLengthReadDataProvider.qc.dox.h:63
const ConstructorOptions
Constructor options.
Definition: FixedLengthReadDataProvider.qc.dox.h:41
The FixedLengthUtil namespace contains all the definitions in the FixedLengthUtil module.
Definition: FixedLengthAbstractIterator.qc.dox.h:27
Provides a data provider for reading fixed-length files.
Definition: FixedLengthReadDataProvider.qc.dox.h:29
constructor(string path, hash< auto > spec, *hash< auto > opts)
Creates the FixedLengthReadDataProvider with the input data path, the record specifications,...
const ProviderInfo
Provider info.
Definition: FixedLengthReadDataProvider.qc.dox.h:33