public static final class FieldComparator.RelevanceComparator extends FieldComparator<Float> implements LeafFieldComparator
TopScoreDocCollector
directly (which IndexSearcher.search(org.apache.lucene.search.Query, int)
uses when no Sort
is
specified).FieldComparator.DocComparator, FieldComparator.DoubleComparator, FieldComparator.FloatComparator, FieldComparator.IntComparator, FieldComparator.LongComparator, FieldComparator.NumericComparator<T extends Number>, FieldComparator.RelevanceComparator, FieldComparator.TermOrdValComparator, FieldComparator.TermValComparator
Constructor and Description |
---|
RelevanceComparator(int numHits)
Creates a new comparator based on relevance for
numHits . |
Modifier and Type | Method and 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.
|
int |
compareValues(Float first,
Float second)
Returns a negative integer if first is less than second,
0 if they are equal and a positive integer otherwise.
|
void |
copy(int slot,
int doc)
This method is called when a new hit is competitive.
|
LeafFieldComparator |
getLeafComparator(LeafReaderContext context)
Get a per-segment
LeafFieldComparator to collect the given
LeafReaderContext . |
void |
setBottom(int bottom)
Set the bottom slot, ie the "weakest" (sorted last)
entry in the queue.
|
void |
setScorer(Scorable scorer)
Sets the Scorer to use in case a document's score is
needed.
|
void |
setTopValue(Float value)
Record the top value, for future calls to
LeafFieldComparator.compareTop(int) . |
Float |
value(int slot)
Return the actual value in the slot.
|
public RelevanceComparator(int numHits)
numHits
.public int compare(int slot1, int slot2)
FieldComparator
compare
in class FieldComparator<Float>
slot1
- first slot to compareslot2
- second slot to compareN < 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 equalpublic int compareBottom(int doc) throws IOException
LeafFieldComparator
FieldComparator.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).
compareBottom
in interface LeafFieldComparator
doc
- that was hitN < 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.IOException
public void copy(int slot, int doc) throws IOException
LeafFieldComparator
copy
in interface LeafFieldComparator
slot
- which slot to copy the hit todoc
- docID relative to current readerIOException
public LeafFieldComparator getLeafComparator(LeafReaderContext context)
FieldComparator
LeafFieldComparator
to collect the given
LeafReaderContext
. All docIDs supplied to
this LeafFieldComparator
are relative to the current reader (you
must add docBase if you need to map it to a top-level docID).getLeafComparator
in class FieldComparator<Float>
context
- current reader contextpublic void setBottom(int bottom)
LeafFieldComparator
LeafFieldComparator.compareBottom(int)
is
called, you should compare against this slot. This
will always be called before LeafFieldComparator.compareBottom(int)
.setBottom
in interface LeafFieldComparator
bottom
- the currently weakest (sorted last) slot in the queuepublic void setTopValue(Float value)
FieldComparator
LeafFieldComparator.compareTop(int)
. This is only called for searches that
use searchAfter (deep paging), and is called before any
calls to FieldComparator.getLeafComparator(LeafReaderContext)
.setTopValue
in class FieldComparator<Float>
public void setScorer(Scorable scorer)
LeafFieldComparator
setScorer
in interface LeafFieldComparator
scorer
- Scorer instance that you should use to
obtain the current hit's score, if necessary.public Float value(int slot)
FieldComparator
value
in class FieldComparator<Float>
slot
- the valuepublic int compareValues(Float first, Float second)
FieldComparator
compareValues
in class FieldComparator<Float>
public int compareTop(int doc) throws IOException
LeafFieldComparator
FieldComparator.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).compareTop
in interface LeafFieldComparator
doc
- that was hitN < 0
if the doc's value is sorted after
the top entry (not competitive), any N > 0
if the
doc's value is sorted before the top entry and 0
if
they are equal.IOException
Copyright © 2000-2019 Apache Software Foundation. All Rights Reserved.