Module org.apache.lucene.core
Class TermOrdValComparator.TermOrdValLeafComparator
- java.lang.Object
-
- org.apache.lucene.search.comparators.TermOrdValComparator.TermOrdValLeafComparator
-
- All Implemented Interfaces:
LeafFieldComparator
- Enclosing class:
- TermOrdValComparator
private class TermOrdValComparator.TermOrdValLeafComparator extends java.lang.Object implements LeafFieldComparator
-
-
Field Summary
Fields Modifier and Type Field Description (package private) int
bottomOrd
(package private) boolean
bottomSameReader
private TermOrdValComparator.CompetitiveIterator
competitiveIterator
private boolean
dense
(package private) int
missingOrd
Which ordinal to use for a missing value.(package private) SortedDocValues
termsIndex
(package private) int
topOrd
(package private) boolean
topSameReader
-
Constructor Summary
Constructors Constructor Description TermOrdValLeafComparator(LeafReaderContext context, SortedDocValues values)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareBottom(int doc)
Compare the bottom of the queue with this doc.int
compareTop(int doc)
Compare the top value with this doc.DocIdSetIterator
competitiveIterator()
Returns a competitive iteratorvoid
copy(int slot, int doc)
This method is called when a new hit is competitive.private int
getOrdForDoc(int doc)
void
setBottom(int bottom)
Set the bottom slot, ie the "weakest" (sorted last) entry in the queue.void
setHitsThresholdReached()
Informs this leaf comparator that hits threshold is reached.void
setScorer(Scorable scorer)
Sets the Scorer to use in case a document's score is needed.private void
updateCompetitiveIterator()
-
-
-
Field Detail
-
termsIndex
final SortedDocValues termsIndex
-
bottomSameReader
boolean bottomSameReader
-
bottomOrd
int bottomOrd
-
topSameReader
final boolean topSameReader
-
topOrd
final int topOrd
-
missingOrd
final int missingOrd
Which ordinal to use for a missing value.
-
competitiveIterator
private final TermOrdValComparator.CompetitiveIterator competitiveIterator
-
dense
private final boolean dense
-
-
Constructor Detail
-
TermOrdValLeafComparator
TermOrdValLeafComparator(LeafReaderContext context, SortedDocValues values) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
getOrdForDoc
private int getOrdForDoc(int doc) throws java.io.IOException
- Throws:
java.io.IOException
-
setHitsThresholdReached
public void setHitsThresholdReached() throws java.io.IOException
Description copied from interface:LeafFieldComparator
Informs this leaf comparator that hits threshold is reached. This method is called from a collector when hits threshold is reached.- Specified by:
setHitsThresholdReached
in interfaceLeafFieldComparator
- Throws:
java.io.IOException
-
compareBottom
public int compareBottom(int doc) throws java.io.IOException
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).
- Specified by:
compareBottom
in interfaceLeafFieldComparator
- 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:
java.io.IOException
-
copy
public void copy(int slot, int doc) throws java.io.IOException
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.- Specified by:
copy
in interfaceLeafFieldComparator
- Parameters:
slot
- which slot to copy the hit todoc
- docID relative to current reader- Throws:
java.io.IOException
-
setBottom
public void setBottom(int bottom) throws java.io.IOException
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)
.- Specified by:
setBottom
in interfaceLeafFieldComparator
- Parameters:
bottom
- the currently weakest (sorted last) slot in the queue- Throws:
java.io.IOException
-
compareTop
public int compareTop(int doc) throws java.io.IOException
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).- Specified by:
compareTop
in interfaceLeafFieldComparator
- 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:
java.io.IOException
-
setScorer
public void setScorer(Scorable scorer)
Description copied from interface:LeafFieldComparator
Sets the Scorer to use in case a document's score is needed.- Specified by:
setScorer
in interfaceLeafFieldComparator
- Parameters:
scorer
- Scorer instance that you should use to obtain the current hit's score, if necessary.
-
updateCompetitiveIterator
private void updateCompetitiveIterator() throws java.io.IOException
- Throws:
java.io.IOException
-
competitiveIterator
public DocIdSetIterator competitiveIterator()
Description copied from interface:LeafFieldComparator
Returns a competitive iterator- Specified by:
competitiveIterator
in interfaceLeafFieldComparator
- Returns:
- an iterator over competitive docs that are stronger than already collected docs or
null
if such an iterator is not available for the current comparator or segment.
-
-