Class TermOrdValComparator
- java.lang.Object
-
- org.apache.lucene.search.FieldComparator<BytesRef>
-
- org.apache.lucene.search.comparators.TermOrdValComparator
-
public class TermOrdValComparator extends FieldComparator<BytesRef>
Sorts by field's natural Term sort order, using ordinals. This is functionally equivalent toFieldComparator.TermValComparator, but it first resolves the string to their relative ordinal positions (using the index returned byLeafReader.getSortedDocValues(String)), and does most comparisons using the ordinals. For medium to large results, this comparator will be much faster thanFieldComparator.TermValComparator. For very small result sets it may be slower.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.search.FieldComparator
FieldComparator.RelevanceComparator, FieldComparator.TermValComparator
-
-
Constructor Summary
Constructors Constructor Description TermOrdValComparator(int numHits, String field, boolean sortMissingLast, boolean reverse, Pruning pruning)Creates this, with control over how missing values are sorted.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intcompare(int slot1, int slot2)Compare hit at slot1 with hit at slot2.intcompareValues(BytesRef val1, BytesRef val2)Returns a negative integer if first is less than second, 0 if they are equal and a positive integer otherwise.voiddisableSkipping()Informs the comparator that the skipping of documents should be disabled.LeafFieldComparatorgetLeafComparator(LeafReaderContext context)Get a per-segmentLeafFieldComparatorto collect the givenLeafReaderContext.protected SortedDocValuesgetSortedDocValues(LeafReaderContext context, String field)Retrieves the SortedDocValues for the field in this segmentvoidsetSingleSort()Informs the comparator that sort is done on this single field.voidsetTopValue(BytesRef value)Record the top value, for future calls toLeafFieldComparator.compareTop(int).BytesRefvalue(int slot)Return the actual value in the slot.
-
-
-
Method Detail
-
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<BytesRef>
-
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<BytesRef>
-
compare
public int compare(int slot1, int slot2)Description copied from class:FieldComparatorCompare hit at slot1 with hit at slot2.- Specified by:
comparein classFieldComparator<BytesRef>- Parameters:
slot1- first slot to compareslot2- second slot to compare- Returns:
- any
N < 0if slot2's value is sorted after slot1, anyN > 0if the slot2's value is sorted before slot1 and0if they are equal
-
getSortedDocValues
protected SortedDocValues getSortedDocValues(LeafReaderContext context, String field) throws IOException
Retrieves the SortedDocValues for the field in this segment- Throws:
IOException
-
getLeafComparator
public LeafFieldComparator getLeafComparator(LeafReaderContext context) throws IOException
Description copied from class:FieldComparatorGet a per-segmentLeafFieldComparatorto collect the givenLeafReaderContext. All docIDs supplied to thisLeafFieldComparatorare relative to the current reader (you must add docBase if you need to map it to a top-level docID).- Specified by:
getLeafComparatorin classFieldComparator<BytesRef>- Parameters:
context- current reader context- Returns:
- the comparator to use for this segment
- Throws:
IOException- if there is a low-level IO error
-
setTopValue
public void setTopValue(BytesRef 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<BytesRef>
-
value
public BytesRef value(int slot)
Description copied from class:FieldComparatorReturn the actual value in the slot.- Specified by:
valuein classFieldComparator<BytesRef>- Parameters:
slot- the value- Returns:
- value in this slot
-
compareValues
public int compareValues(BytesRef val1, BytesRef val2)
Description copied from class:FieldComparatorReturns a negative integer if first is less than second, 0 if they are equal and a positive integer otherwise. Default impl to assume the type implements Comparable and invoke .compareTo; be sure to override this method if your FieldComparator's type isn't a Comparable or if your values may sometimes be null- Overrides:
compareValuesin classFieldComparator<BytesRef>
-
-