Package org.apache.lucene.search
Class FieldComparator.DoubleComparator
- java.lang.Object
-
- org.apache.lucene.search.FieldComparator<T>
-
- org.apache.lucene.search.FieldComparator.NumericComparator<java.lang.Double>
-
- org.apache.lucene.search.FieldComparator.DoubleComparator
-
- Enclosing class:
- FieldComparator<T>
public static final class FieldComparator.DoubleComparator extends FieldComparator.NumericComparator<java.lang.Double>
Parses field's values as double (usingFieldCache.getDoubles(org.apache.lucene.index.AtomicReader, java.lang.String, boolean)
and sorts by ascending value
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.search.FieldComparator
FieldComparator.ByteComparator, FieldComparator.DocComparator, FieldComparator.DoubleComparator, FieldComparator.FloatComparator, FieldComparator.IntComparator, FieldComparator.LongComparator, FieldComparator.NumericComparator<T extends java.lang.Number>, FieldComparator.RelevanceComparator, FieldComparator.ShortComparator, FieldComparator.TermOrdValComparator, FieldComparator.TermValComparator
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
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
setBottom(int bottom)
Set the bottom slot, ie the "weakest" (sorted last) entry in the queue.FieldComparator<java.lang.Double>
setNextReader(AtomicReaderContext context)
Set a newAtomicReaderContext
.void
setTopValue(java.lang.Double value)
Record the top value, for future calls toFieldComparator.compareTop(int)
.java.lang.Double
value(int slot)
Return the actual value in the slot.-
Methods inherited from class org.apache.lucene.search.FieldComparator
compareValues, setScorer
-
-
-
-
Method Detail
-
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<java.lang.Double>
- Parameters:
slot1
- first slot to compareslot2
- second slot to compare- Returns:
- any N < 0 if slot2's value is sorted after slot1, any N > 0 if the slot2's value is sorted before slot1 and 0 if they are equal
-
compareBottom
public int compareBottom(int doc)
Description copied from class:FieldComparator
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).
- Specified by:
compareBottom
in classFieldComparator<java.lang.Double>
- Parameters:
doc
- that was hit- Returns:
- any N < 0 if the doc's value is sorted after the bottom entry (not competitive), any N > 0 if the doc's value is sorted before the bottom entry and 0 if they are equal.
-
copy
public void copy(int slot, int doc)
Description copied from class:FieldComparator
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.- Specified by:
copy
in classFieldComparator<java.lang.Double>
- Parameters:
slot
- which slot to copy the hit todoc
- docID relative to current reader
-
setNextReader
public FieldComparator<java.lang.Double> setNextReader(AtomicReaderContext context) throws java.io.IOException
Description copied from class:FieldComparator
Set a newAtomicReaderContext
. All subsequent docIDs are relative to the current reader (you must add docBase if you need to map it to a top-level docID).- Overrides:
setNextReader
in classFieldComparator.NumericComparator<java.lang.Double>
- Parameters:
context
- current reader context- Returns:
- the comparator to use for this segment; most comparators can just return "this" to reuse the same comparator across segments
- Throws:
java.io.IOException
- if there is a low-level IO error
-
setBottom
public void setBottom(int bottom)
Description copied from class:FieldComparator
Set the bottom slot, ie the "weakest" (sorted last) entry in the queue. WhenFieldComparator.compareBottom(int)
is called, you should compare against this slot. This will always be called beforeFieldComparator.compareBottom(int)
.- Specified by:
setBottom
in classFieldComparator<java.lang.Double>
- Parameters:
bottom
- the currently weakest (sorted last) slot in the queue
-
setTopValue
public void setTopValue(java.lang.Double value)
Description copied from class:FieldComparator
Record the top value, for future calls toFieldComparator.compareTop(int)
. This is only called for searches that use searchAfter (deep paging), and is called before any calls toFieldComparator.setNextReader(org.apache.lucene.index.AtomicReaderContext)
.- Specified by:
setTopValue
in classFieldComparator<java.lang.Double>
-
value
public java.lang.Double value(int slot)
Description copied from class:FieldComparator
Return the actual value in the slot.- Specified by:
value
in classFieldComparator<java.lang.Double>
- Parameters:
slot
- the value- Returns:
- value in this slot
-
compareTop
public int compareTop(int doc)
Description copied from class:FieldComparator
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).- Specified by:
compareTop
in classFieldComparator<java.lang.Double>
- Parameters:
doc
- that was hit- Returns:
- any N < 0 if the doc's value is sorted after the bottom entry (not competitive), any N > 0 if the doc's value is sorted before the bottom entry and 0 if they are equal.
-
-