Class ValueSource.ValueSourceComparator
java.lang.Object
org.apache.lucene.search.FieldComparator<T>
org.apache.lucene.search.SimpleFieldComparator<Double>
org.apache.lucene.queries.function.ValueSource.ValueSourceComparator
- All Implemented Interfaces:
LeafFieldComparator
- Enclosing class:
- ValueSource
Implement a
FieldComparator
that works off of the FunctionValues
for a ValueSource instead of the normal Lucene FieldComparator that works off
of a FieldCache.-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.search.FieldComparator
FieldComparator.RelevanceComparator, FieldComparator.TermOrdValComparator, FieldComparator.TermValComparator
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
compare
(int slot1, int slot2) Compare hit at slot1 with hit at slot2.int
compareBottom
(int doc) Compare the bottom of the queue with this doc.int
compareTop
(int doc) Compare the top value with this doc.void
copy
(int slot, int doc) This method is called when a new hit is competitive.void
doSetNextReader
(LeafReaderContext context) This method is called before collectingcontext
.void
setBottom
(int bottom) Set the bottom slot, ie the "weakest" (sorted last) entry in the queue.void
setTopValue
(Double value) Record the top value, for future calls toLeafFieldComparator.compareTop(int)
.value
(int slot) Return the actual value in the slot.Methods inherited from class org.apache.lucene.search.SimpleFieldComparator
getLeafComparator, setScorer
Methods inherited from class org.apache.lucene.search.FieldComparator
compareValues, disableSkipping, setSingleSort
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.lucene.search.LeafFieldComparator
competitiveIterator, setHitsThresholdReached
-
Field Details
-
values
private final double[] values -
docVals
-
bottom
private double bottom -
fcontext
-
topValue
private double topValue
-
-
Constructor Details
-
ValueSourceComparator
-
-
Method Details
-
compare
public int compare(int slot1, int slot2) Description copied from class:FieldComparator
Compare hit at slot1 with hit at slot2.- Specified by:
compare
in classFieldComparator<Double>
- Parameters:
slot1
- first slot to compareslot2
- second slot to compare- Returns:
- any
N < 0
if slot2's value is sorted after slot1, anyN > 0
if the slot2's value is sorted before slot1 and0
if they are equal
-
compareBottom
Description copied from interface:LeafFieldComparator
Compare the bottom of the queue with this doc. This will only invoked after setBottom has been called. This should return the same result asFieldComparator.compare(int,int)
} as if bottom were slot1 and the new document were slot 2.For a search that hits many results, this method will be the hotspot (invoked by far the most frequently).
- Parameters:
doc
- that was hit- Returns:
- any
N < 0
if the doc's value is sorted after the bottom entry (not competitive), anyN > 0
if the doc's value is sorted before the bottom entry and0
if they are equal. - Throws:
IOException
-
copy
Description copied from interface:LeafFieldComparator
This method is called when a new hit is competitive. You should copy any state associated with this document that will be required for future comparisons, into the specified slot.- Parameters:
slot
- which slot to copy the hit todoc
- docID relative to current reader- Throws:
IOException
-
doSetNextReader
Description copied from class:SimpleFieldComparator
This method is called before collectingcontext
.- Specified by:
doSetNextReader
in classSimpleFieldComparator<Double>
- Throws:
IOException
-
setBottom
public void setBottom(int bottom) Description copied from interface:LeafFieldComparator
Set the bottom slot, ie the "weakest" (sorted last) entry in the queue. WhenLeafFieldComparator.compareBottom(int)
is called, you should compare against this slot. This will always be called beforeLeafFieldComparator.compareBottom(int)
.- Parameters:
bottom
- the currently weakest (sorted last) slot in the queue
-
setTopValue
Description copied from class:FieldComparator
Record 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:
setTopValue
in classFieldComparator<Double>
-
value
Description copied from class:FieldComparator
Return the actual value in the slot.- Specified by:
value
in classFieldComparator<Double>
- Parameters:
slot
- the value- Returns:
- value in this slot
-
compareTop
Description copied from interface:LeafFieldComparator
Compare the top value with this doc. This will only invoked after setTopValue has been called. This should return the same result asFieldComparator.compare(int,int)
} as if topValue were slot1 and the new document were slot 2. This is only called for searches that use searchAfter (deep paging).- Parameters:
doc
- that was hit- Returns:
- any
N < 0
if the doc's value is sorted after the top entry (not competitive), anyN > 0
if the doc's value is sorted before the top entry and0
if they are equal. - Throws:
IOException
-