-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
SelectionOperators.java
424 lines (373 loc) · 10.5 KB
/
SelectionOperators.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
/*
* Copyright 2022 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.mongodb.core.aggregation;
import java.util.Arrays;
import java.util.Collections;
import org.springframework.data.domain.Sort;
/**
* Gateway to {@literal selection operators} such as {@literal $bottom}.
*
* @author Christoph Strobl
* @since 4.0
*/
public class SelectionOperators {
/**
* {@link AbstractAggregationExpression} to return the bottom element according to the specified {@link #sortBy(Sort)
* order}.
*/
public static class Bottom extends AbstractAggregationExpression {
private Bottom(Object value) {
super(value);
}
/**
* In case a limit value ({@literal n}) is present {@literal $bottomN} is used instead of {@literal $bottom}.
*
* @return
*/
@Override
protected String getMongoMethod() {
return get("n") == null ? "$bottom" : "$bottomN";
}
/**
* @return new instance of {@link Bottom}.
*/
public static Bottom bottom() {
return new Bottom(Collections.emptyMap());
}
/**
* @param numberOfResults Limits the number of returned elements to the given value.
* @return new instance of {@link Bottom}.
*/
public static Bottom bottom(int numberOfResults) {
return bottom().limit(numberOfResults);
}
/**
* Limits the number of returned elements to the given value.
*
* @param numberOfResults
* @return new instance of {@link Bottom}.
*/
public Bottom limit(int numberOfResults) {
return limit((Object) numberOfResults);
}
/**
* Limits the number of returned elements to the value defined by the given {@link AggregationExpression
* expression}.
*
* @param expression must not be {@literal null}.
* @return new instance of {@link Bottom}.
*/
public Bottom limit(AggregationExpression expression) {
return limit((Object) expression);
}
private Bottom limit(Object value) {
return new Bottom(append("n", value));
}
/**
* Define result ordering.
*
* @param sort must not be {@literal null}.
* @return new instance of {@link Bottom}.
*/
public Bottom sortBy(Sort sort) {
return new Bottom(append("sortBy", sort));
}
/**
* Define result ordering.
*
* @param out must not be {@literal null}.
* @return new instance of {@link Bottom}.
*/
public Bottom output(Fields out) {
return new Bottom(append("output", out));
}
/**
* Define fields included in the output for each element.
*
* @param fieldNames must not be {@literal null}.
* @return new instance of {@link Bottom}.
* @see #output(Fields)
*/
public Bottom output(String... fieldNames) {
return output(Fields.fields(fieldNames));
}
/**
* Define expressions building the value included in the output for each element.
*
* @param out must not be {@literal null}.
* @return new instance of {@link Bottom}.
* @see #output(Fields)
*/
public Bottom output(AggregationExpression... out) {
return new Bottom(append("output", Arrays.asList(out)));
}
}
/**
* {@link AbstractAggregationExpression} to return the top element according to the specified {@link #sortBy(Sort)
* order}.
*/
public static class Top extends AbstractAggregationExpression {
private Top(Object value) {
super(value);
}
/**
* In case a limit value ({@literal n}) is present {@literal $topN} is used instead of {@literal $top}.
*
* @return
*/
@Override
protected String getMongoMethod() {
return get("n") == null ? "$top" : "$topN";
}
/**
* @return new instance of {@link Top}.
*/
public static Top top() {
return new Top(Collections.emptyMap());
}
/**
* @param numberOfResults Limits the number of returned elements to the given value.
* @return new instance of {@link Top}.
*/
public static Top top(int numberOfResults) {
return top().limit(numberOfResults);
}
/**
* Limits the number of returned elements to the given value.
*
* @param numberOfResults
* @return new instance of {@link Top}.
*/
public Top limit(int numberOfResults) {
return limit((Object) numberOfResults);
}
/**
* Limits the number of returned elements to the value defined by the given {@link AggregationExpression
* expression}.
*
* @param expression must not be {@literal null}.
* @return new instance of {@link Top}.
*/
public Top limit(AggregationExpression expression) {
return limit((Object) expression);
}
private Top limit(Object value) {
return new Top(append("n", value));
}
/**
* Define result ordering.
*
* @param sort must not be {@literal null}.
* @return new instance of {@link Top}.
*/
public Top sortBy(Sort sort) {
return new Top(append("sortBy", sort));
}
/**
* Define result ordering.
*
* @param out must not be {@literal null}.
* @return new instance of {@link Top}.
*/
public Top output(Fields out) {
return new Top(append("output", out));
}
/**
* Define fields included in the output for each element.
*
* @param fieldNames must not be {@literal null}.
* @return new instance of {@link Top}.
* @see #output(Fields)
*/
public Top output(String... fieldNames) {
return output(Fields.fields(fieldNames));
}
/**
* Define expressions building the value included in the output for each element.
*
* @param out must not be {@literal null}.
* @return new instance of {@link Top}.
* @see #output(Fields)
*/
public Top output(AggregationExpression... out) {
return new Top(append("output", Arrays.asList(out)));
}
}
/**
* {@link AbstractAggregationExpression} to return the {@literal $firstN} elements.
*/
public static class First extends AbstractAggregationExpression {
protected First(Object value) {
super(value);
}
/**
* @return new instance of {@link First}.
*/
public static First first() {
return new First(Collections.emptyMap());
}
/**
* @return new instance of {@link First}.
*/
public static First first(int numberOfResults) {
return first().limit(numberOfResults);
}
/**
* Limits the number of returned elements to the given value.
*
* @param numberOfResults
* @return new instance of {@link Bottom}.
*/
public First limit(int numberOfResults) {
return limit((Object) numberOfResults);
}
/**
* Limits the number of returned elements to the value defined by the given {@link AggregationExpression
* expression}.
*
* @param expression must not be {@literal null}.
* @return new instance of {@link Bottom}.
*/
public First limit(AggregationExpression expression) {
return limit((Object) expression);
}
private First limit(Object value) {
return new First(append("n", value));
}
/**
* Define the field to serve as source.
*
* @param fieldName must not be {@literal null}.
* @return new instance of {@link Bottom}.
*/
public First of(String fieldName) {
return input(fieldName);
}
/**
* Define the expression building the value to serve as source.
*
* @param expression must not be {@literal null}.
* @return new instance of {@link Bottom}.
*/
public First of(AggregationExpression expression) {
return input(expression);
}
/**
* Define the field to serve as source.
*
* @param fieldName must not be {@literal null}.
* @return new instance of {@link Bottom}.
*/
public First input(String fieldName) {
return new First(append("input", Fields.field(fieldName)));
}
/**
* Define the expression building the value to serve as source.
*
* @param expression must not be {@literal null}.
* @return new instance of {@link Bottom}.
*/
public First input(AggregationExpression expression) {
return new First(append("input", expression));
}
@Override
protected String getMongoMethod() {
return "$firstN";
}
}
/**
* {@link AbstractAggregationExpression} to return the {@literal $lastN} elements.
*/
public static class Last extends AbstractAggregationExpression {
protected Last(Object value) {
super(value);
}
/**
* @return new instance of {@link Last}.
*/
public static Last last() {
return new Last(Collections.emptyMap());
}
/**
* @return new instance of {@link Last}.
*/
public static Last last(int numberOfResults) {
return last().limit(numberOfResults);
}
/**
* Limits the number of returned elements to the given value.
*
* @param numberOfResults
* @return new instance of {@link Bottom}.
*/
public Last limit(int numberOfResults) {
return limit((Object) numberOfResults);
}
/**
* Limits the number of returned elements to the value defined by the given {@link AggregationExpression
* expression}.
*
* @param expression must not be {@literal null}.
* @return new instance of {@link Bottom}.
*/
public Last limit(AggregationExpression expression) {
return limit((Object) expression);
}
private Last limit(Object value) {
return new Last(append("n", value));
}
/**
* Define the field to serve as source.
*
* @param fieldName must not be {@literal null}.
* @return new instance of {@link Bottom}.
*/
public Last of(String fieldName) {
return input(fieldName);
}
/**
* Define the expression building the value to serve as source.
*
* @param expression must not be {@literal null}.
* @return new instance of {@link Bottom}.
*/
public Last of(AggregationExpression expression) {
return input(expression);
}
/**
* Define the field to serve as source.
*
* @param fieldName must not be {@literal null}.
* @return new instance of {@link Bottom}.
*/
public Last input(String fieldName) {
return new Last(append("input", Fields.field(fieldName)));
}
/**
* Define the expression building the value to serve as source.
*
* @param expression must not be {@literal null}.
* @return new instance of {@link Bottom}.
*/
public Last input(AggregationExpression expression) {
return new Last(append("input", expression));
}
@Override
protected String getMongoMethod() {
return "$lastN";
}
}
}