Module org.elasticsearch.server

Package org.elasticsearch.lucene.comparators

Class XNumericComparator<T extends Number>

java.lang.Object

org.apache.lucene.search.FieldComparator<T>

org.elasticsearch.lucene.comparators.XNumericComparator<T>

Direct Known Subclasses:

XLongComparator

public abstract class XNumericComparator<T extends Number>
extends org.apache.lucene.search.FieldComparator<T>

Abstract numeric comparator for comparing numeric values. This comparator provides a skipping functionality – an iterator that can skip over non-competitive documents.

Parameter field provided in the constructor is used as a field name in the default implementations of the methods getNumericDocValues and getPointValues to retrieve doc values and points. You can pass a dummy value for a field name (e.g. when sorting by script), but in this case you must override both of these methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	XNumericComparator.CompetitiveDISIBuilder
class	XNumericComparator.NumericLeafComparator	Leaf comparator for NumericComparator that provides skipping functionality

Nested classes/interfaces inherited from class org.apache.lucene.search.FieldComparator

org.apache.lucene.search.FieldComparator.RelevanceComparator, org.apache.lucene.search.FieldComparator.TermValComparator

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	field
protected boolean	hitsThresholdReached
protected final T	missingValue
protected org.apache.lucene.search.Pruning	pruning
protected boolean	queueFull
protected final boolean	reverse
protected boolean	singleSort
protected boolean	topValueSet

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XNumericComparator(String field, T missingValue, boolean reverse, org.apache.lucene.search.Pruning pruning, int bytesCount)

Method Summary

Modifier and Type	Method	Description
void	disableSkipping()
protected abstract long	missingValueAsComparableLong()
void	setSingleSort()
void	setTopValue(T value)
protected abstract long	sortableBytesToLong(byte[] bytes)	Decode sortable bytes to long.

Methods inherited from class org.apache.lucene.search.FieldComparator

compare, compareValues, getLeafComparator, value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

missingValue

protected final T extends Number missingValue

field

protected final String field

reverse

protected final boolean reverse

topValueSet

protected boolean topValueSet

singleSort

protected boolean singleSort

hitsThresholdReached

protected boolean hitsThresholdReached

queueFull

protected boolean queueFull

pruning

protected org.apache.lucene.search.Pruning pruning

Constructor Details

XNumericComparator

protected XNumericComparator(String field,
 T missingValue,
 boolean reverse,
 org.apache.lucene.search.Pruning pruning,
 int bytesCount)

Method Details

setTopValue

public void setTopValue(T value)

Specified by:

setTopValue in class org.apache.lucene.search.FieldComparator<T extends Number>

setSingleSort

public void setSingleSort()

Overrides:

setSingleSort in class org.apache.lucene.search.FieldComparator<T extends Number>

disableSkipping

public void disableSkipping()

Overrides:

disableSkipping in class org.apache.lucene.search.FieldComparator<T extends Number>

missingValueAsComparableLong

protected abstract long missingValueAsComparableLong()

sortableBytesToLong

protected abstract long sortableBytesToLong(byte[] bytes)

Decode sortable bytes to long. It should be consistent with the codec that PointValues of this field is using.