-
Notifications
You must be signed in to change notification settings - Fork 25
/
QueryMapper.java
495 lines (421 loc) · 15.6 KB
/
QueryMapper.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
/*
* Copyright (c) 2023 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the Eclipse
* Public License v. 2.0 are satisfied: GNU General Public License, version 2
* with the GNU Classpath Exception which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.nosql;
import java.util.List;
import java.util.Optional;
import java.util.stream.Stream;
/**
* This interface holds the interfaces that compose the Fluent API for selecting and deleting NoSQL entities.
*/
public interface QueryMapper {
/**
* Represents the first step in the delete query fluent API
*/
interface MapperDeleteFrom extends MapperDeleteQueryBuild {
/**
* Starts a new delete condition by a column name
*
* @param name the column name
* @return a new {@link MapperDeleteNameCondition}
* @throws NullPointerException when name is null
*/
MapperDeleteNameCondition where(String name);
}
/**
* Represents a delete condition based on a column name
*/
interface MapperDeleteNameCondition {
/**
* Creates a delete condition where the column name provided is equal to the provided value
*
* @param value the value to the condition
* @param <T> the type
* @return the {@link MapperDeleteWhere}
* @throws NullPointerException when value is null
*/
<T> MapperDeleteWhere eq(T value);
/**
* Creates a delete condition where the column name provided is like to the provided value
*
* @param value the value to the condition
* @return the {@link MapperDeleteWhere}
* @throws NullPointerException when value is null
*/
MapperDeleteWhere like(String value);
/**
* Creates a delete condition where the column name provided is greater than to the provided value
*
* @param value the value to the condition
* @param <T> the type
* @return the {@link MapperDeleteWhere}
* @throws NullPointerException when value is null
*/
<T> MapperDeleteWhere gt(T value);
/**
* Creates a delete condition where the column name provided is greater than or equal to the provided value
*
* @param <T> the type
* @param value the value to the condition
* @return the {@link MapperDeleteWhere}
* @throws NullPointerException when value is null
*/
<T> MapperDeleteWhere gte(T value);
/**
* Creates a delete condition where the column name provided is less than the provided value
*
* @param <T> the type
* @param value the value to the condition
* @return the {@link MapperDeleteWhere}
* @throws NullPointerException when value is null
*/
<T> MapperDeleteWhere lt(T value);
/**
* Creates a delete condition where the column name provided is less than or equal to the provided value
*
* @param <T> the type
* @param value the value to the condition
* @return the {@link MapperDeleteWhere}
* @throws NullPointerException when value is null
*/
<T> MapperDeleteWhere lte(T value);
/**
* Creates a delete condition where the column name provided is between the provided values
*
* @param <T> the type
* @param valueA the values within a given range
* @param valueB the values within a given range
* @return the {@link MapperDeleteWhere}
* @throws NullPointerException when either valueA or valueB are null
*/
<T> MapperDeleteWhere between(T valueA, T valueB);
/**
* Creates a delete condition where the column name provided is in the provided iterable values
*
* @param values the values
* @param <T> the type
* @return the {@link MapperDeleteWhere}
* @throws NullPointerException when value is null
*/
<T> MapperDeleteWhere in(Iterable<T> values);
/**
* Creates a NOT delete condition for the column name provided
*
* @return {@link MapperDeleteNotCondition}
*/
MapperDeleteNotCondition not();
}
/**
* Represents a NOT delete condition in the delete query fluent API
*/
interface MapperDeleteNotCondition extends MapperDeleteNameCondition {
}
/**
* Represents the last step of the delete query fluent API execution
*/
interface MapperDeleteQueryBuild {
/**
* Executes the query
*/
void execute();
}
/**
* Represents a step where it's possible to perform a logical conjunction or disjunction adding one more delete condition or end up performing the built query
*/
interface MapperDeleteWhere extends MapperDeleteQueryBuild {
/**
* Create a new delete condition performing logical conjunction (AND) by giving a column name
*
* @param name the column name
* @return the same {@link MapperDeleteNameCondition} with the delete condition appended
* @throws NullPointerException when name is null
*/
MapperDeleteNameCondition and(String name);
/**
* Create a new delete condition performing logical disjunction (OR) by giving a column name
*
* @param name the column name
* @return the same {@link MapperDeleteNameCondition} with the delete condition appended
* @throws NullPointerException when name is null
*/
MapperDeleteNameCondition or(String name);
}
/**
* Represents the first step in the query fluent API
*/
interface MapperFrom extends MapperQueryBuild {
/**
* Starts a new condition by given a column name
*
* @param name the column name
* @return a new {@link MapperNameCondition}
* @throws NullPointerException when name is null
*/
MapperNameCondition where(String name);
/**
* Defines the position of the first result to retrieve.
*
* @param skip the first result to retrieve
* @return a query with first result defined
*/
MapperSkip skip(long skip);
/**
* Defines the maximum number of results to retrieve.
*
* @param limit the limit
* @return a query with the limit defined
*/
MapperLimit limit(long limit);
/**
* Add the order how the result will return
*
* @param name the name to be ordered
* @return a query with the sort defined
* @throws NullPointerException when name is null
*/
MapperOrder orderBy(String name);
}
/**
* Represents the step in the query fluent API where it's possible to define the maximum number of results to retrieve or to perform the query execution
*/
interface MapperLimit extends MapperQueryBuild {
/**
* Defines the position of the first result to retrieve.
*
* @param skip the number of elements to skip
* @return a query with first result defined
*/
MapperSkip skip(long skip);
}
/**
* Represents a condition based on a column name
*/
interface MapperNameCondition {
/**
* Creates a condition where the column name provided is equal to the provided value
*
* @param value the value to the condition
* @param <T> the type
* @return the {@link MapperWhere}
* @throws NullPointerException when value is null
*/
<T> MapperWhere eq(T value);
/**
* Creates a condition where the column name provided is like to the provided value
*
* @param value the value to the condition
* @return the {@link MapperWhere}
* @throws NullPointerException when value is null
*/
MapperWhere like(String value);
/**
* Creates a condition where the column name provided is greater than to the provided value
*
* @param <T> the type
* @param value the value to the condition
* @return the {@link MapperWhere}
* @throws NullPointerException when value is null
*/
<T> MapperWhere gt(T value);
/**
* Creates a condition where the column name provided is greater than or equal to the provided value
*
* @param <T> the type
* @param value the value to the condition
* @return the {@link MapperWhere}
* @throws NullPointerException when value is null
*/
<T> MapperWhere gte(T value);
/**
* Creates a condition where the column name provided is less than the provided value
*
* @param <T> the type
* @param value the value to the condition
* @return the {@link MapperWhere}
* @throws NullPointerException when value is null
*/
<T> MapperWhere lt(T value);
/**
* Creates a condition where the column name provided is less than or equal to the provided value
*
* @param <T> the type
* @param value the value to the condition
* @return the {@link MapperWhere}
* @throws NullPointerException when value is null
*/
<T> MapperWhere lte(T value);
/**
* Creates a condition where the column name provided is between the provided values
*
* @param <T> the type
* @param valueA the values within a given range
* @param valueB the values within a given range
* @return the {@link MapperWhere}
* @throws NullPointerException when either valueA or valueB are null
*/
<T> MapperWhere between(T valueA, T valueB);
/**
* Creates a condition where the column name provided is in the provided iterable values
*
* @param values the values
* @param <T> the type
* @return the {@link MapperWhere}
* @throws NullPointerException when value is null
*/
<T> MapperWhere in(Iterable<T> values);
/**
* Creates a NOT condition for the column name provided.
*
* @return {@link MapperNotCondition}
*/
MapperNotCondition not();
}
/**
* Represents the step in the query fluent API where it's possible to:
* <lu>
* <li>define the order of the results</li>
* <li>or define the position of the first result</li>
* <li>or define the maximum number of results to retrieve</li>
* <li>or to perform the query execution</li>
* </lu>
*/
interface MapperNameOrder extends MapperQueryBuild {
/**
* Add the order of how the result will return based on a given column name
*
* @param name the column name to be ordered
* @return a query with the sort defined
* @throws NullPointerException when name is null
*/
MapperOrder orderBy(String name);
/**
* Defines the position of the first result to retrieve.
*
* @param skip the first result to retrieve
* @return a query with first result defined
*/
MapperSkip skip(long skip);
/**
* Defines the maximum number of results to retrieve.
*
* @param limit the limit
* @return a query with the limit defined
*/
MapperLimit limit(long limit);
}
/**
* Represents a NOT condition in the delete query fluent API
*/
interface MapperNotCondition extends MapperNameCondition {
}
/**
* Represents the step in the query fluent API where it's possible to define the order of the results or to perform the query execution
*/
interface MapperOrder {
/**
* Defines the order ascending
*
* @return the {@link MapperNameOrder} instance
*/
MapperNameOrder asc();
/**
* Defines the order as descending
*
* @return the {@link MapperNameOrder} instance
*/
MapperNameOrder desc();
}
/**
* Represents the last step of the query fluent API execution
*/
interface MapperQueryBuild {
/**
* Executes the query and it returns as a {@link List}
*
* @param <T> the entity type
* @return the result of the query
*/
<T> List<T> result();
/**
* Executes the query and it returns as a {@link Stream}
*
* @param <T> the entity type
* @return the result of the query
*/
<T> Stream<T> stream();
/**
* Executes the query and returns the result as a single element otherwise it will return an {@link Optional#empty()}
*
* @param <T> the entity type
* @return the result of the query that may have one or empty result
*/
<T> Optional<T> singleResult();
}
/**
* Represents the step in the query fluent API where it's possible to define the position of the first result to retrieve or to perform the query execution
*/
interface MapperSkip extends MapperQueryBuild {
/**
* Defines the maximum number of results to retrieve.
*
* @param limit the limit
* @return a query with the limit defined
*/
MapperLimit limit(long limit);
}
/**
* Represents a step where it's possible to perform a logical conjunction or disjunction adding one more condition or end up performing the built query
*/
interface MapperWhere extends MapperQueryBuild {
/**
* Create a new condition performing logical conjunction (AND) by giving a column name
*
* @param name the column name
* @return the same {@link MapperNameCondition} with the condition appended
* @throws NullPointerException when name is null
*/
MapperNameCondition and(String name);
/**
* Create a new condition performing logical disjunction (OR) by giving a column name
*
* @param name the column name
* @return the same {@link MapperNameCondition} with the condition appended
* @throws NullPointerException when name is null
*/
MapperNameCondition or(String name);
/**
* Defines the position of the first result to retrieve.
*
* @param skip the first result to retrieve
* @return a query with first result defined
*/
MapperSkip skip(long skip);
/**
* Defines the maximum number of results to retrieve.
*
* @param limit the limit
* @return a query with the limit defined
*/
MapperLimit limit(long limit);
/**
* Add the order how the result will return
*
* @param name the name to order
* @return a query with the sort defined
* @throws NullPointerException when name is null
*/
MapperOrder orderBy(String name);
}
}