1 //
2 // AbstractPreparator.h
3 //
4 // Library: Data
5 // Package: DataCore
6 // Module: AbstractPreparator
7 //
8 // Definition of the AbstractPreparator class.
9 //
10 // Copyright (c) 2006, Applied Informatics Software Engineering GmbH.
11 // and Contributors.
12 //
13 // SPDX-License-Identifier: BSL-1.0
14 //
15
16
17 #ifndef Data_AbstractPreparator_INCLUDED
18 #define Data_AbstractPreparator_INCLUDED
19
20
21 #include "Poco/Data/Data.h"
22 #include "Poco/RefCountedObject.h"
23 #include "Poco/Data/LOB.h"
24 #include "Poco/UTFString.h"
25 #include <vector>
26 #include <deque>
27 #include <list>
28 #include <cstddef>
29
30
31 namespace Poco {
32
33
34 class DateTime;
35 class Any;
36
37 namespace Dynamic {
38 class Var;
39 }
40
41
42 namespace Data {
43
44
45 class Date;
46 class Time;
47
48
49 class Data_API AbstractPreparator
50 /// Interface used for database preparation where we first have to register all data types
51 /// (and memory output locations) before extracting data, e.g. ODBC.
52 /// Extract works as two-phase extract: first we call prepare once, then extract n-times.
53 /// There are cases (bulk operations using std::vector storage) when extract is called only once.
54 /// The value passed to a prepare() call is not used by the prepare, serving only as an indication
55 /// of the data type being prepared, thus all values are passed as const references.
56 /// Implementing this interface is not mandatory for a connector. Connectors that only extract data
57 /// after SQL execution (e.g. SQLite) do not need this functionality at all.
58 {
59 public:
60 using Ptr = SharedPtr<AbstractPreparator>;
61
62 AbstractPreparator(Poco::UInt32 length = 1u);
63 /// Creates the AbstractPreparator.
64
65 virtual ~AbstractPreparator();
66 /// Destroys the AbstractPreparator.
67
68 virtual void prepare(std::size_t pos, const Poco::Int8&) = 0;
69 /// Prepares an Int8.
70
71 virtual void prepare(std::size_t pos, const std::vector<Poco::Int8>& val);
72 /// Prepares an Int8 vector.
73
74 virtual void prepare(std::size_t pos, const std::deque<Poco::Int8>& val);
75 /// Prepares an Int8 deque.
76
77 virtual void prepare(std::size_t pos, const std::list<Poco::Int8>& val);
78 /// Prepares an Int8 list.
79
80 virtual void prepare(std::size_t pos, const Poco::UInt8&) = 0;
81 /// Prepares an UInt8.
82
83 virtual void prepare(std::size_t pos, const std::vector<Poco::UInt8>& val);
84 /// Prepares an UInt8 vector.
85
86 virtual void prepare(std::size_t pos, const std::deque<Poco::UInt8>& val);
87 /// Prepares an UInt8 deque.
88
89 virtual void prepare(std::size_t pos, const std::list<Poco::UInt8>& val);
90 /// Prepares an UInt8 list.
91
92 virtual void prepare(std::size_t pos, const Poco::Int16&) = 0;
93 /// Prepares an Int16.
94
95 virtual void prepare(std::size_t pos, const std::vector<Poco::Int16>& val);
96 /// Prepares an Int16 vector.
97
98 virtual void prepare(std::size_t pos, const std::deque<Poco::Int16>& val);
99 /// Prepares an Int16 deque.
100
101 virtual void prepare(std::size_t pos, const std::list<Poco::Int16>& val);
102 /// Prepares an Int16 list.
103
104 virtual void prepare(std::size_t pos, const Poco::UInt16&) = 0;
105 /// Prepares an UInt16.
106
107 virtual void prepare(std::size_t pos, const std::vector<Poco::UInt16>& val);
108 /// Prepares an UInt16 vector.
109
110 virtual void prepare(std::size_t pos, const std::deque<Poco::UInt16>& val);
111 /// Prepares an UInt16 deque.
112
113 virtual void prepare(std::size_t pos, const std::list<Poco::UInt16>& val);
114 /// Prepares an UInt16 list.
115
116 virtual void prepare(std::size_t pos, const Poco::Int32&) = 0;
117 /// Prepares an Int32.
118
119 virtual void prepare(std::size_t pos, const std::vector<Poco::Int32>& val);
120 /// Prepares an Int32 vector.
121
122 virtual void prepare(std::size_t pos, const std::deque<Poco::Int32>& val);
123 /// Prepares an Int32 deque.
124
125 virtual void prepare(std::size_t pos, const std::list<Poco::Int32>& val);
126 /// Prepares an Int32 list.
127
128 virtual void prepare(std::size_t pos, const Poco::UInt32&) = 0;
129 /// Prepares an UInt32.
130
131 virtual void prepare(std::size_t pos, const std::vector<Poco::UInt32>& val);
132 /// Prepares an UInt32 vector.
133
134 virtual void prepare(std::size_t pos, const std::deque<Poco::UInt32>& val);
135 /// Prepares an UInt32 deque.
136
137 virtual void prepare(std::size_t pos, const std::list<Poco::UInt32>& val);
138 /// Prepares an UInt32 list.
139
140 virtual void prepare(std::size_t pos, const Poco::Int64&) = 0;
141 /// Prepares an Int64.
142
143 virtual void prepare(std::size_t pos, const std::vector<Poco::Int64>& val);
144 /// Prepares an Int64 vector.
145
146 virtual void prepare(std::size_t pos, const std::deque<Poco::Int64>& val);
147 /// Prepares an Int64 deque.
148
149 virtual void prepare(std::size_t pos, const std::list<Poco::Int64>& val);
150 /// Prepares an Int64 list.
151
152 virtual void prepare(std::size_t pos, const Poco::UInt64&) = 0;
153 /// Prepares an UInt64.
154
155 virtual void prepare(std::size_t pos, const std::vector<Poco::UInt64>& val);
156 /// Prepares an UInt64 vector.
157
158 virtual void prepare(std::size_t pos, const std::deque<Poco::UInt64>& val);
159 /// Prepares an UInt64 deque.
160
161 virtual void prepare(std::size_t pos, const std::list<Poco::UInt64>& val);
162 /// Prepares an UInt64 list.
163
164 #ifndef POCO_INT64_IS_LONG
165 virtual void prepare(std::size_t pos, const long&) = 0;
166 /// Prepares a long.
167
168 virtual void prepare(std::size_t pos, const unsigned long&) = 0;
169 /// Prepares an unsigned long.
170
171 virtual void prepare(std::size_t pos, const std::vector<long>& val);
172 /// Prepares a long vector.
173
174 virtual void prepare(std::size_t pos, const std::deque<long>& val);
175 /// Prepares a long deque.
176
177 virtual void prepare(std::size_t pos, const std::list<long>& val);
178 /// Prepares a long list.
179 #endif
180
181 virtual void prepare(std::size_t pos, const bool&) = 0;
182 /// Prepares a boolean.
183
184 virtual void prepare(std::size_t pos, const std::vector<bool>& val);
185 /// Prepares a boolean vector.
186
187 virtual void prepare(std::size_t pos, const std::deque<bool>& val);
188 /// Prepares a boolean deque.
189
190 virtual void prepare(std::size_t pos, const std::list<bool>& val);
191 /// Prepares a boolean list.
192
193 virtual void prepare(std::size_t pos, const float&) = 0;
194 /// Prepares a float.
195
196 virtual void prepare(std::size_t pos, const std::vector<float>& val);
197 /// Prepares a float vector.
198
199 virtual void prepare(std::size_t pos, const std::deque<float>& val);
200 /// Prepares a float deque.
201
202 virtual void prepare(std::size_t pos, const std::list<float>& val);
203 /// Prepares a float list.
204
205 virtual void prepare(std::size_t pos, const double&) = 0;
206 /// Prepares a double.
207
208 virtual void prepare(std::size_t pos, const std::vector<double>& val);
209 /// Prepares a double vector.
210
211 virtual void prepare(std::size_t pos, const std::deque<double>& val);
212 /// Prepares a double deque.
213
214 virtual void prepare(std::size_t pos, const std::list<double>& val);
215 /// Prepares a double list.
216
217 virtual void prepare(std::size_t pos, const char&) = 0;
218 /// Prepares a single character.
219
220 virtual void prepare(std::size_t pos, const std::vector<char>& val);
221 /// Prepares a character vector.
222
223 virtual void prepare(std::size_t pos, const std::deque<char>& val);
224 /// Prepares a character deque.
225
226 virtual void prepare(std::size_t pos, const std::list<char>& val);
227 /// Prepares a character list.
228
229 virtual void prepare(std::size_t pos, const std::string&) = 0;
230 /// Prepares a string.
231
232 virtual void prepare(std::size_t pos, const std::vector<std::string>& val);
233 /// Prepares a string vector.
234
235 virtual void prepare(std::size_t pos, const std::deque<std::string>& val);
236 /// Prepares a string deque.
237
238 virtual void prepare(std::size_t pos, const std::list<std::string>& val);
239 /// Prepares a character list.
240
241 virtual void prepare(std::size_t pos, const UTF16String&);
242 /// Prepares a UTF16String.
243
244 virtual void prepare(std::size_t pos, const std::vector<UTF16String>& val);
245 /// Prepares a UTF16String vector.
246
247 virtual void prepare(std::size_t pos, const std::deque<UTF16String>& val);
248 /// Prepares a UTF16String deque.
249
250 virtual void prepare(std::size_t pos, const std::list<UTF16String>& val);
251 /// Prepares a UTF16String list.
252
253 virtual void prepare(std::size_t pos, const BLOB&) = 0;
254 /// Prepares a BLOB.
255
256 virtual void prepare(std::size_t pos, const CLOB&) = 0;
257 /// Prepares a CLOB.
258
259 virtual void prepare(std::size_t pos, const std::vector<BLOB>& val);
260 /// Prepares a BLOB vector.
261
262 virtual void prepare(std::size_t pos, const std::deque<BLOB>& val);
263 /// Prepares a BLOB deque.
264
265 virtual void prepare(std::size_t pos, const std::list<BLOB>& val);
266 /// Prepares a BLOB list.
267
268 virtual void prepare(std::size_t pos, const std::vector<CLOB>& val);
269 /// Prepares a CLOB vector.
270
271 virtual void prepare(std::size_t pos, const std::deque<CLOB>& val);
272 /// Prepares a CLOB deque.
273
274 virtual void prepare(std::size_t pos, const std::list<CLOB>& val);
275 /// Prepares a CLOB list.
276
277 virtual void prepare(std::size_t pos, const DateTime&) = 0;
278 /// Prepares a DateTime.
279
280 virtual void prepare(std::size_t pos, const std::vector<DateTime>& val);
281 /// Prepares a DateTime vector.
282
283 virtual void prepare(std::size_t pos, const std::deque<DateTime>& val);
284 /// Prepares a DateTime deque.
285
286 virtual void prepare(std::size_t pos, const std::list<DateTime>& val);
287 /// Prepares a DateTime list.
288
289 virtual void prepare(std::size_t pos, const Date&) = 0;
290 /// Prepares a Date.
291
292 virtual void prepare(std::size_t pos, const std::vector<Date>& val);
293 /// Prepares a Date vector.
294
295 virtual void prepare(std::size_t pos, const std::deque<Date>& val);
296 /// Prepares a Date deque.
297
298 virtual void prepare(std::size_t pos, const std::list<Date>& val);
299 /// Prepares a Date list.
300
301 virtual void prepare(std::size_t pos, const Time&) = 0;
302 /// Prepares a Time.
303
304 virtual void prepare(std::size_t pos, const std::vector<Time>& val);
305 /// Prepares a Time vector.
306
307 virtual void prepare(std::size_t pos, const std::deque<Time>& val);
308 /// Prepares a Time deque.
309
310 virtual void prepare(std::size_t pos, const std::list<Time>& val);
311 /// Prepares a Time list.
312
313 virtual void prepare(std::size_t pos, const Any&) = 0;
314 /// Prepares an Any.
315
316 virtual void prepare(std::size_t pos, const std::vector<Any>& val);
317 /// Prepares an Any vector.
318
319 virtual void prepare(std::size_t pos, const std::deque<Any>& val);
320 /// Prepares an Any deque.
321
322 virtual void prepare(std::size_t pos, const std::list<Any>& val);
323 /// Prepares an Any list.
324
325 virtual void prepare(std::size_t pos, const Poco::Dynamic::Var&) = 0;
326 /// Prepares a Var.
327
328 virtual void prepare(std::size_t pos, const std::vector<Poco::Dynamic::Var>& val);
329 /// Prepares a Var vector.
330
331 virtual void prepare(std::size_t pos, const std::deque<Poco::Dynamic::Var>& val);
332 /// Prepares a Var deque.
333
334 virtual void prepare(std::size_t pos, const std::list<Poco::Dynamic::Var>& val);
335 /// Prepares a Var list.
336
337 void setLength(Poco::UInt32 length);
338 /// Sets the length of prepared data.
339 /// Needed only for data lengths greater than 1 (i.e. for
340 /// bulk operations).
341
342 Poco::UInt32 getLength() const;
343 /// Returns the length of prepared data. Defaults to 1.
344 /// The length is greater than one for bulk operations.
345
346 void setBulk(bool bulkPrep = true);
347 /// Sets bulk operation flag (always false at object creation time)
348
349 bool isBulk() const;
350 /// Returns bulk operation flag.
351
352 private:
353 Poco::UInt32 _length;
354 bool _bulk;
355 };
356
357
358 ///
359 /// inlines
360 ///
setLength(Poco::UInt32 length)361 inline void AbstractPreparator::setLength(Poco::UInt32 length)
362 {
363 _length = length;
364 }
365
366
getLength()367 inline Poco::UInt32 AbstractPreparator::getLength() const
368 {
369 return _length;
370 }
371
372
setBulk(bool bulkPrep)373 inline void AbstractPreparator::setBulk(bool bulkPrep)
374 {
375 _bulk = bulkPrep;
376 }
377
378
isBulk()379 inline bool AbstractPreparator::isBulk() const
380 {
381 return _bulk;
382 }
383
384
385 } } // namespace Poco::Data
386
387
388 #endif // Data_AbstractPreparator_INCLUDED
389