Qore SaxDataProvider Module Reference 1.10
Loading...
Searching...
No Matches
SaxDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
2// Qore SaxDataProvider class definition
3
4/* SaxDataProvider.qc Copyright 2012 - 2022 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
26namespace SaxDataProvider {
28
33class SaxDataProvider : public DataProvider::AbstractDataProvider {
34
35public:
37 const ProviderInfo = ...;
38
39
41 const ConstructorOptions = ...;
42
43
45 const CsvIterationOptionList = keys (ConstructorOptions - ("path", "stream"));
46
47protected:
49 SaxIteratorWrapper i;
50
52 string location;
53
54public:
55
57 constructor(*hash<auto> options);
58
59
61 string getName();
62
63
65
68protected:
69 AbstractDataProviderRecordIterator searchRecordsImpl(*hash<auto> where_cond, *hash<auto> search_options);
70public:
71
72
74
77protected:
78 AbstractDataProviderRecordIterator searchRecordsImpl(*hash<DataProviderExpression> where_cond, *hash<auto> search_options);
79public:
80
81
83protected:
84 *hash<string, AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
85public:
86
87
89protected:
90 hash<DataProviderInfo> getStaticInfoImpl();
91public:
92
93};
94};
95
96// private namespace
97namespace Priv {
98class SaxIteratorWrapper : public AbstractIterator {
99
100public:
101protected:
102 SaxIterator i;
103
104public:
105
106 constructor(SaxIterator i);
107
108
109 bool next();
110
111
112 hash<auto> getValue();
113
114
115 bool valid();
116
117};
118};
AbstractDataProviderRecordIterator searchRecordsImpl(*hash< DataProviderExpression > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
SaxIteratorWrapper i
the iterator object
Definition SaxDataProvider.qc.dox.h:49
string location
the source location
Definition SaxDataProvider.qc.dox.h:52
AbstractDataProviderRecordIterator searchRecordsImpl(*hash< auto > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
string getName()
Returns the object name.
*hash< string, AbstractDataField > getRecordTypeImpl(*hash< auto > search_options)
Returns the description of the record type, if any.
constructor(*hash< auto > options)
Creates the object from constructor options.
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
The main namespace for the SaxDataProvider module.
Definition SaxDataProvider.qc.dox.h:26