Class NumericComparator<T extends Number>
- java.lang.Object
-
- org.apache.lucene.search.FieldComparator<T>
-
- org.apache.lucene.search.comparators.NumericComparator<T>
-
- Direct Known Subclasses:
DoubleComparator,FloatComparator,IntComparator,LongComparator
public abstract class NumericComparator<T extends Number> extends FieldComparator<T>
Abstract numeric comparator for comparing numeric values. This comparator provides a skipping functionality – an iterator that can skip over non-competitive documents.Parameter
fieldprovided in the constructor is used as a field name in the default implementations of the methodsgetNumericDocValuesandgetPointValuesto retrieve doc values and points. You can pass a dummy value for a field name (e.g. when sorting by script), but in this case you must override both of these methods.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classNumericComparator.NumericLeafComparatorLeaf comparator forNumericComparatorthat provides skipping functionality-
Nested classes/interfaces inherited from class org.apache.lucene.search.FieldComparator
FieldComparator.RelevanceComparator, FieldComparator.TermValComparator
-
-
Field Summary
Fields Modifier and Type Field Description protected Stringfieldprotected booleanhitsThresholdReachedprotected TmissingValueprotected Pruningpruningprotected booleanqueueFullprotected booleanreverseprotected booleansingleSortprotected booleantopValueSet
-
Constructor Summary
Constructors Modifier Constructor Description protectedNumericComparator(String field, T missingValue, boolean reverse, Pruning pruning, int bytesCount)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddisableSkipping()Informs the comparator that the skipping of documents should be disabled.voidsetSingleSort()Informs the comparator that sort is done on this single field.voidsetTopValue(T value)Record the top value, for future calls toLeafFieldComparator.compareTop(int).-
Methods inherited from class org.apache.lucene.search.FieldComparator
compare, compareValues, getLeafComparator, value
-
-
-
-
Field Detail
-
field
protected final String field
-
reverse
protected final boolean reverse
-
topValueSet
protected boolean topValueSet
-
singleSort
protected boolean singleSort
-
hitsThresholdReached
protected boolean hitsThresholdReached
-
queueFull
protected boolean queueFull
-
pruning
protected Pruning pruning
-
-
Method Detail
-
setTopValue
public void setTopValue(T value)
Description copied from class:FieldComparatorRecord the top value, for future calls toLeafFieldComparator.compareTop(int). This is only called for searches that use searchAfter (deep paging), and is called before any calls toFieldComparator.getLeafComparator(LeafReaderContext).- Specified by:
setTopValuein classFieldComparator<T extends Number>
-
setSingleSort
public void setSingleSort()
Description copied from class:FieldComparatorInforms the comparator that sort is done on this single field. This is useful to enable some optimizations for skipping non-competitive documents.- Overrides:
setSingleSortin classFieldComparator<T extends Number>
-
disableSkipping
public void disableSkipping()
Description copied from class:FieldComparatorInforms the comparator that the skipping of documents should be disabled. This function is called by TopFieldCollector in cases when the skipping functionality should not be applied or not necessary. An example could be when search sort is a part of the index sort, and can be already efficiently handled by TopFieldCollector, and doing extra work for skipping in the comparator is redundant.- Overrides:
disableSkippingin classFieldComparator<T extends Number>
-
-