-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
IndexQuery.java
487 lines (429 loc) · 14.5 KB
/
IndexQuery.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
/*
* Copyright (c) 2002-2017 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.kernel.api.schema;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;
import java.util.function.Predicate;
import org.neo4j.kernel.api.ReadOperations;
import org.neo4j.kernel.api.schema.index.IndexDescriptor;
import org.neo4j.kernel.impl.api.PropertyValueComparison;
import org.neo4j.values.Value;
import org.neo4j.values.Values;
public abstract class IndexQuery implements Predicate<Object>
{
/**
* Searches the index for all entries that has the given property.
*
* @param propertyKeyId the property ID to match.
* @return an {@link IndexQuery} instance to be passed to {@link ReadOperations#indexQuery(IndexDescriptor,
* IndexQuery...)}
*/
public static ExistsPredicate exists( int propertyKeyId )
{
return new ExistsPredicate( propertyKeyId );
}
/**
* Searches the index for a certain value.
*
* @param propertyKeyId the property ID to match.
* @param value the property value to search for.
* @return an {@link IndexQuery} instance to be passed to {@link ReadOperations#indexQuery(IndexDescriptor,
* IndexQuery...)}
*/
public static ExactPredicate exact( int propertyKeyId, Object value )
{
return new ExactPredicate( propertyKeyId, value );
}
/**
* Searches the index for numeric values between {@code from} and {@code to}.
*
* @param propertyKeyId the property ID to match.
* @param from the lower bound of the property value.
* @param fromInclusive the lower bound is inclusive if true.
* @param to the upper bound of the property value.
* @param toInclusive the upper bound is inclusive if true.
* @return an {@link IndexQuery} instance to be passed to {@link ReadOperations#indexQuery(IndexDescriptor,
* IndexQuery...)}
*/
public static NumberRangePredicate range( int propertyKeyId, Number from, boolean fromInclusive, Number to,
boolean toInclusive )
{
return new NumberRangePredicate( propertyKeyId, from, fromInclusive, to, toInclusive );
}
/**
* Searches the index for string values between {@code from} and {@code to}.
*
* @param propertyKeyId the property ID to match.
* @param from the lower bound of the property value.
* @param fromInclusive the lower bound is inclusive if true.
* @param to the upper bound of the property value.
* @param toInclusive the upper bound is inclusive if true.
* @return an {@link IndexQuery} instance to be passed to {@link ReadOperations#indexQuery(IndexDescriptor,
* IndexQuery...)}
*/
public static StringRangePredicate range( int propertyKeyId, String from, boolean fromInclusive, String to,
boolean toInclusive )
{
return new StringRangePredicate( propertyKeyId, from, fromInclusive, to, toInclusive );
}
/**
* Searches the index string values starting with {@code prefix}.
*
* @param propertyKeyId the property ID to match.
* @param prefix the string prefix to search for.
* @return an {@link IndexQuery} instance to be passed to {@link ReadOperations#indexQuery(IndexDescriptor,
* IndexQuery...)}
*/
public static StringPrefixPredicate stringPrefix( int propertyKeyId, String prefix )
{
return new StringPrefixPredicate( propertyKeyId, prefix );
}
/**
* Searches the index for string values containing the exact search string.
*
* @param propertyKeyId the property ID to match.
* @param contains the string to search for.
* @return an {@link IndexQuery} instance to be passed to {@link ReadOperations#indexQuery(IndexDescriptor,
* IndexQuery...)}
*/
public static StringContainsPredicate stringContains( int propertyKeyId, String contains )
{
return new StringContainsPredicate( propertyKeyId, contains );
}
/**
* Searches the index string values ending with {@code suffix}.
*
* @param propertyKeyId the property ID to match.
* @param suffix the string suffix to search for.
* @return an {@link IndexQuery} instance to be passed to {@link ReadOperations#indexQuery(IndexDescriptor,
* IndexQuery...)}
*/
public static StringSuffixPredicate stringSuffix( int propertyKeyId, String suffix )
{
return new StringSuffixPredicate( propertyKeyId, suffix );
}
private final int propertyKeyId;
protected IndexQuery( int propertyKeyId )
{
this.propertyKeyId = propertyKeyId;
}
public abstract IndexQueryType type();
@SuppressWarnings( "EqualsWhichDoesntCheckParameterClass" )
@Override
public final boolean equals( Object other )
{
// equals() and hashcode() are only used for testing so we don't care that they are a bit slow.
return EqualsBuilder.reflectionEquals( this, other );
}
@Override
public final int hashCode()
{
// equals() and hashcode() are only used for testing so we don't care that they are a bit slow.
return HashCodeBuilder.reflectionHashCode( this, false );
}
@Override
public final String toString()
{
// Only used to debugging, it's okay to be a bit slow.
return ToStringBuilder.reflectionToString( this, ToStringStyle.SHORT_PREFIX_STYLE );
}
public final int propertyKeyId()
{
return propertyKeyId;
}
public abstract boolean test( Object value );
public enum IndexQueryType
{
exists,
exact,
rangeString,
rangeNumeric,
stringPrefix,
stringSuffix,
stringContains
}
public static final class ExistsPredicate extends IndexQuery
{
ExistsPredicate( int propertyKeyId )
{
super( propertyKeyId );
}
@Override
public IndexQueryType type()
{
return IndexQueryType.exists;
}
@Override
public boolean test( Object value )
{
return value != null;
}
}
public static final class ExactPredicate extends IndexQuery
{
private final Value exactValue;
ExactPredicate( int propertyKeyId, Object value )
{
super( propertyKeyId );
this.exactValue = value instanceof Value ? (Value)value : Values.of( value );
}
@Override
public IndexQueryType type()
{
return IndexQueryType.exact;
}
@Override
public boolean test( Object value )
{
Value typed = value instanceof Value ? (Value)value : Values.of( value );
return exactValue.equals( typed );
}
public Object value()
{
return exactValue.asPublic();
}
}
public static final class NumberRangePredicate extends IndexQuery
{
private final Value from;
private final boolean fromInclusive;
private final Value to;
private final boolean toInclusive;
NumberRangePredicate( int propertyKeyId, Number from, boolean fromInclusive, Number to, boolean toInclusive )
{
super( propertyKeyId );
this.from = Values.numberValue( from );
this.fromInclusive = fromInclusive;
this.to = Values.numberValue( to );
this.toInclusive = toInclusive;
}
@Override
public IndexQueryType type()
{
return IndexQueryType.rangeNumeric;
}
@Override
public boolean test( Object value )
{
if ( value == null )
{
return false;
}
if ( Values.isNumberValue( value ) )
{
Value number = (Value) value;
if ( from != Values.NO_VALUE )
{
int compare = Values.VALUE_COMPARATOR.compare( number, from );
if ( compare < 0 || !fromInclusive && compare == 0 )
{
return false;
}
}
if ( to != Values.NO_VALUE )
{
int compare = Values.VALUE_COMPARATOR.compare( number, to );
if ( compare > 0 || !toInclusive && compare == 0 )
{
return false;
}
}
return true;
}
if ( value instanceof Number )
{
Number number = (Number) value;
if ( from != Values.NO_VALUE )
{
Number from = (Number) this.from.asPublic();
int compare = PropertyValueComparison.COMPARE_NUMBERS.compare( number, from );
if ( compare < 0 || !fromInclusive && compare == 0 )
{
return false;
}
}
if ( to != Values.NO_VALUE )
{
Number to = (Number) this.to.asPublic();
int compare = PropertyValueComparison.COMPARE_NUMBERS.compare( number, to );
if ( compare > 0 || !toInclusive && compare == 0 )
{
return false;
}
}
return true;
}
return false;
}
public Number from()
{
return (Number)from.asPublic();
}
public Number to()
{
return (Number)to.asPublic();
}
public boolean fromInclusive()
{
return fromInclusive;
}
public boolean toInclusive()
{
return toInclusive;
}
}
public static final class StringRangePredicate extends IndexQuery
{
private final String from;
private final boolean fromInclusive;
private final String to;
private final boolean toInclusive;
StringRangePredicate( int propertyKeyId, String from, boolean fromInclusive, String to, boolean toInclusive )
{
super( propertyKeyId );
this.from = from;
this.fromInclusive = fromInclusive;
this.to = to;
this.toInclusive = toInclusive;
}
@Override
public IndexQueryType type()
{
return IndexQueryType.rangeString;
}
@Override
public boolean test( Object value )
{
if ( value == null )
{
return false;
}
if ( !(value instanceof String) )
{
return false;
}
String str = (String) value;
if ( from != null )
{
int compare = PropertyValueComparison.COMPARE_STRINGS.compare( str, from );
if ( compare < 0 || !fromInclusive && compare == 0 )
{
return false;
}
}
if ( to != null )
{
int compare = PropertyValueComparison.COMPARE_STRINGS.compare( str, to );
if ( compare > 0 || !toInclusive && compare == 0 )
{
return false;
}
}
return true;
}
public String from()
{
return from;
}
public boolean fromInclusive()
{
return fromInclusive;
}
public String to()
{
return to;
}
public boolean toInclusive()
{
return toInclusive;
}
}
public static final class StringPrefixPredicate extends IndexQuery
{
private final String prefix;
StringPrefixPredicate( int propertyKeyId, String prefix )
{
super( propertyKeyId );
this.prefix = prefix;
}
@Override
public IndexQueryType type()
{
return IndexQueryType.stringPrefix;
}
@Override
public boolean test( Object value )
{
return value != null && value instanceof String && ((String)value).startsWith( prefix );
}
public String prefix()
{
return prefix;
}
}
public static final class StringContainsPredicate extends IndexQuery
{
private final String contains;
StringContainsPredicate( int propertyKeyId, String contains )
{
super( propertyKeyId );
this.contains = contains;
}
@Override
public IndexQueryType type()
{
return IndexQueryType.stringContains;
}
@Override
public boolean test( Object value )
{
return value != null && value instanceof String && ((String)value).contains( contains );
}
public String contains()
{
return contains;
}
}
public static final class StringSuffixPredicate extends IndexQuery
{
private final String suffix;
StringSuffixPredicate( int propertyKeyId, String suffix )
{
super( propertyKeyId );
this.suffix = suffix;
}
@Override
public IndexQueryType type()
{
return IndexQueryType.stringSuffix;
}
@Override
public boolean test( Object value )
{
return value != null && value instanceof String && ((String)value).endsWith( suffix );
}
public String suffix()
{
return suffix;
}
}
}