forked from elastic/elasticsearch
/
FilterBuilders.java
563 lines (497 loc) · 18.6 KB
/
FilterBuilders.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
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
/*
* Licensed to ElasticSearch and Shay Banon under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. ElasticSearch licenses this
* file to you 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
*
* http://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.elasticsearch.index.query;
import org.elasticsearch.common.Nullable;
import org.elasticsearch.common.geo.GeoPoint;
import org.elasticsearch.common.geo.ShapeRelation;
import org.elasticsearch.common.geo.builders.ShapeBuilder;
/**
* A static factory for simple "import static" usage.
*/
public abstract class FilterBuilders {
/**
* A filter that matches all documents.
*/
public static MatchAllFilterBuilder matchAllFilter() {
return new MatchAllFilterBuilder();
}
/**
* A filter that limits the results to the provided limit value (per shard!).
*/
public static LimitFilterBuilder limitFilter(int limit) {
return new LimitFilterBuilder(limit);
}
public static NestedFilterBuilder nestedFilter(String path, QueryBuilder query) {
return new NestedFilterBuilder(path, query);
}
public static NestedFilterBuilder nestedFilter(String path, FilterBuilder filter) {
return new NestedFilterBuilder(path, filter);
}
/**
* Creates a new ids filter with the provided doc/mapping types.
*
* @param types The types to match the ids against.
*/
public static IdsFilterBuilder idsFilter(@Nullable String... types) {
return new IdsFilterBuilder(types);
}
/**
* A filter based on doc/mapping type.
*/
public static TypeFilterBuilder typeFilter(String type) {
return new TypeFilterBuilder(type);
}
/**
* A filter for a field based on a term.
*
* @param name The field name
* @param value The term value
*/
public static TermFilterBuilder termFilter(String name, String value) {
return new TermFilterBuilder(name, value);
}
/**
* A filter for a field based on a term.
*
* @param name The field name
* @param value The term value
*/
public static TermFilterBuilder termFilter(String name, int value) {
return new TermFilterBuilder(name, value);
}
/**
* A filter for a field based on a term.
*
* @param name The field name
* @param value The term value
*/
public static TermFilterBuilder termFilter(String name, long value) {
return new TermFilterBuilder(name, value);
}
/**
* A filter for a field based on a term.
*
* @param name The field name
* @param value The term value
*/
public static TermFilterBuilder termFilter(String name, float value) {
return new TermFilterBuilder(name, value);
}
/**
* A filter for a field based on a term.
*
* @param name The field name
* @param value The term value
*/
public static TermFilterBuilder termFilter(String name, double value) {
return new TermFilterBuilder(name, value);
}
/**
* A filter for a field based on a term.
*
* @param name The field name
* @param value The term value
*/
public static TermFilterBuilder termFilter(String name, Object value) {
return new TermFilterBuilder(name, value);
}
/**
* A filer for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public static TermsFilterBuilder termsFilter(String name, String... values) {
return new TermsFilterBuilder(name, values);
}
/**
* A filer for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public static TermsFilterBuilder termsFilter(String name, int... values) {
return new TermsFilterBuilder(name, values);
}
/**
* A filer for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public static TermsFilterBuilder termsFilter(String name, long... values) {
return new TermsFilterBuilder(name, values);
}
/**
* A filer for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public static TermsFilterBuilder termsFilter(String name, float... values) {
return new TermsFilterBuilder(name, values);
}
/**
* A filer for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public static TermsFilterBuilder termsFilter(String name, double... values) {
return new TermsFilterBuilder(name, values);
}
/**
* A filer for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public static TermsFilterBuilder termsFilter(String name, Object... values) {
return new TermsFilterBuilder(name, values);
}
/**
* A filer for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public static TermsFilterBuilder termsFilter(String name, Iterable<?> values) {
return new TermsFilterBuilder(name, values);
}
/**
* A terms lookup filter for the provided field name. A lookup terms filter can
* extract the terms to filter by from another doc in an index.
*/
public static TermsLookupFilterBuilder termsLookupFilter(String name) {
return new TermsLookupFilterBuilder(name);
}
/**
* A filer for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public static TermsFilterBuilder inFilter(String name, String... values) {
return new TermsFilterBuilder(name, values);
}
/**
* A filer for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public static TermsFilterBuilder inFilter(String name, int... values) {
return new TermsFilterBuilder(name, values);
}
/**
* A filer for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public static TermsFilterBuilder inFilter(String name, long... values) {
return new TermsFilterBuilder(name, values);
}
/**
* A filer for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public static TermsFilterBuilder inFilter(String name, float... values) {
return new TermsFilterBuilder(name, values);
}
/**
* A filer for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public static TermsFilterBuilder inFilter(String name, double... values) {
return new TermsFilterBuilder(name, values);
}
/**
* A filer for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public static TermsFilterBuilder inFilter(String name, Object... values) {
return new TermsFilterBuilder(name, values);
}
/**
* A filter that restricts search results to values that have a matching prefix in a given
* field.
*
* @param name The field name
* @param prefix The prefix
*/
public static PrefixFilterBuilder prefixFilter(String name, String prefix) {
return new PrefixFilterBuilder(name, prefix);
}
/**
* A filter that restricts search results to field values that match a given regular expression.
*
* @param name The field name
* @param regexp The regular expression
*/
public static RegexpFilterBuilder regexpFilter(String name, String regexp) {
return new RegexpFilterBuilder(name, regexp);
}
/**
* A filter that restricts search results to values that are within the given range.
*
* @param name The field name
*/
public static RangeFilterBuilder rangeFilter(String name) {
return new RangeFilterBuilder(name);
}
/**
* A filter that restricts search results to values that are within the given numeric range. Uses the
* field data cache (loading all the values for the specified field into memory)
*
* @param name The field name
* @deprecated The numeric_range filter will be removed at some point in time in favor for the range filter with
* the execution mode <code>fielddata</code>.
*/
@Deprecated
public static NumericRangeFilterBuilder numericRangeFilter(String name) {
return new NumericRangeFilterBuilder(name);
}
/**
* A filter that simply wraps a query.
*
* @param queryBuilder The query to wrap as a filter
*/
public static QueryFilterBuilder queryFilter(QueryBuilder queryBuilder) {
return new QueryFilterBuilder(queryBuilder);
}
/**
* A builder for filter based on a script.
*
* @param script The script to filter by.
*/
public static ScriptFilterBuilder scriptFilter(String script) {
return new ScriptFilterBuilder(script);
}
/**
* A filter to filter based on a specific distance from a specific geo location / point.
*
* @param name The location field name.
*/
public static GeoDistanceFilterBuilder geoDistanceFilter(String name) {
return new GeoDistanceFilterBuilder(name);
}
/**
* A filter to filter based on a specific range from a specific geo location / point.
*
* @param name The location field name.
*/
public static GeoDistanceRangeFilterBuilder geoDistanceRangeFilter(String name) {
return new GeoDistanceRangeFilterBuilder(name);
}
/**
* A filter to filter based on a bounding box defined by top left and bottom right locations / points
*
* @param name The location field name.
*/
public static GeoBoundingBoxFilterBuilder geoBoundingBoxFilter(String name) {
return new GeoBoundingBoxFilterBuilder(name);
}
/**
* A filter based on a bounding box defined by geohash. The field this filter is applied to
* must have <code>{"type":"geo_point", "geohash":true}</code>
* to work.
*
* @param fieldname The geopoint field name.
*/
public static GeohashFilter.Builder geoHashFilter(String fieldname) {
return new GeohashFilter.Builder(fieldname);
}
/**
* A filter based on a bounding box defined by geohash. The field this filter is applied to
* must have <code>{"type":"geo_point", "geohash":true}</code>
* to work.
*
* @param fieldname The geopoint field name.
* @param geohash The Geohash to filter
*/
public static GeohashFilter.Builder geoHashFilter(String fieldname, String geohash) {
return new GeohashFilter.Builder(fieldname, geohash);
}
/**
* A filter based on a bounding box defined by geohash. The field this filter is applied to
* must have <code>{"type":"geo_point", "geohash":true}</code>
* to work.
*
* @param fieldname The geopoint field name.
* @param point a geopoint within the geohash bucket
*/
public static GeohashFilter.Builder geoHashFilter(String fieldname, GeoPoint point) {
return new GeohashFilter.Builder(fieldname, point);
}
/**
* A filter based on a bounding box defined by geohash. The field this filter is applied to
* must have <code>{"type":"geo_point", "geohash":true}</code>
* to work.
*
* @param fieldname The geopoint field name
* @param geohash The Geohash to filter
* @param neighbors should the neighbor cell also be filtered
*/
public static GeohashFilter.Builder geoHashFilter(String fieldname, String geohash, boolean neighbors) {
return new GeohashFilter.Builder(fieldname, geohash, neighbors);
}
/**
* A filter to filter based on a polygon defined by a set of locations / points.
*
* @param name The location field name.
*/
public static GeoPolygonFilterBuilder geoPolygonFilter(String name) {
return new GeoPolygonFilterBuilder(name);
}
/**
* A filter based on the relationship of a shape and indexed shapes
*
* @param name The shape field name
* @param shape Shape to use in the filter
* @param relation relation of the shapes
*/
public static GeoShapeFilterBuilder geoShapeFilter(String name, ShapeBuilder shape, ShapeRelation relation) {
return new GeoShapeFilterBuilder(name, shape, relation);
}
public static GeoShapeFilterBuilder geoShapeFilter(String name, String indexedShapeId, String indexedShapeType, ShapeRelation relation) {
return new GeoShapeFilterBuilder(name, indexedShapeId, indexedShapeType, relation);
}
/**
* A filter to filter indexed shapes intersecting with shapes
*
* @param name The shape field name
* @param shape Shape to use in the filter
*/
public static GeoShapeFilterBuilder geoIntersectionFilter(String name, ShapeBuilder shape) {
return geoShapeFilter(name, shape, ShapeRelation.INTERSECTS);
}
public static GeoShapeFilterBuilder geoIntersectionFilter(String name, String indexedShapeId, String indexedShapeType) {
return geoShapeFilter(name, indexedShapeId, indexedShapeType, ShapeRelation.INTERSECTS);
}
/**
* A filter to filter indexed shapes that are contained by a shape
*
* @param name The shape field name
* @param shape Shape to use in the filter
*/
public static GeoShapeFilterBuilder geoWithinFilter(String name, ShapeBuilder shape) {
return geoShapeFilter(name, shape, ShapeRelation.WITHIN);
}
public static GeoShapeFilterBuilder geoWithinFilter(String name, String indexedShapeId, String indexedShapeType) {
return geoShapeFilter(name, indexedShapeId, indexedShapeType, ShapeRelation.WITHIN);
}
/**
* A filter to filter indexed shapes that are not intersection with the query shape
*
* @param name The shape field name
* @param shape Shape to use in the filter
*/
public static GeoShapeFilterBuilder geoDisjointFilter(String name, ShapeBuilder shape) {
return geoShapeFilter(name, shape, ShapeRelation.DISJOINT);
}
public static GeoShapeFilterBuilder geoDisjointFilter(String name, String indexedShapeId, String indexedShapeType) {
return geoShapeFilter(name, indexedShapeId, indexedShapeType, ShapeRelation.DISJOINT);
}
/**
* A filter to filter only documents where a field exists in them.
*
* @param name The name of the field
*/
public static ExistsFilterBuilder existsFilter(String name) {
return new ExistsFilterBuilder(name);
}
/**
* A filter to filter only documents where a field does not exists in them.
*
* @param name The name of the field
*/
public static MissingFilterBuilder missingFilter(String name) {
return new MissingFilterBuilder(name);
}
/**
* Constructs a child filter, with the child type and the query to run against child documents, with
* the result of the filter being the *parent* documents.
*
* @param type The child type
* @param query The query to run against the child type
*/
public static HasChildFilterBuilder hasChildFilter(String type, QueryBuilder query) {
return new HasChildFilterBuilder(type, query);
}
/**
* Constructs a child filter, with the child type and the filter to run against child documents, with
* the result of the filter being the *parent* documents.
*
* @param type The child type
* @param filter The query to run against the child type
*/
public static HasChildFilterBuilder hasChildFilter(String type, FilterBuilder filter) {
return new HasChildFilterBuilder(type, filter);
}
/**
* Constructs a parent filter, with the parent type and the query to run against parent documents, with
* the result of the filter being the *child* documents.
*
* @param parentType The parent type
* @param query The query to run against the parent type
*/
public static HasParentFilterBuilder hasParentFilter(String parentType, QueryBuilder query) {
return new HasParentFilterBuilder(parentType, query);
}
/**
* Constructs a parent filter, with the parent type and the filter to run against parent documents, with
* the result of the filter being the *child* documents.
*
* @param parentType The parent type
* @param filter The filter to run against the parent type
*/
public static HasParentFilterBuilder hasParentFilter(String parentType, FilterBuilder filter) {
return new HasParentFilterBuilder(parentType, filter);
}
public static BoolFilterBuilder boolFilter() {
return new BoolFilterBuilder();
}
public static AndFilterBuilder andFilter(FilterBuilder... filters) {
return new AndFilterBuilder(filters);
}
public static OrFilterBuilder orFilter(FilterBuilder... filters) {
return new OrFilterBuilder(filters);
}
public static NotFilterBuilder notFilter(FilterBuilder filter) {
return new NotFilterBuilder(filter);
}
public static IndicesFilterBuilder indicesFilter(FilterBuilder filter, String... indices) {
return new IndicesFilterBuilder(filter, indices);
}
public static WrapperFilterBuilder wrapperFilter(String filter) {
return new WrapperFilterBuilder(filter);
}
public static WrapperFilterBuilder wrapperFilter(byte[] data, int offset, int length) {
return new WrapperFilterBuilder(data, offset, length);
}
private FilterBuilders() {
}
}