Package org.apache.lucene.document

Class FeatureSortField.FeatureComparator

java.lang.Object

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

org.apache.lucene.search.SimpleFieldComparator<java.lang.Float>

org.apache.lucene.document.FeatureSortField.FeatureComparator

All Implemented Interfaces:

LeafFieldComparator

Enclosing class:

FeatureSortField

class FeatureSortField.FeatureComparator
extends SimpleFieldComparator<java.lang.Float>

Parses a feature field's values as float and sorts by descending value

Nested Class Summary

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

FieldComparator.RelevanceComparator, FieldComparator.TermOrdValComparator, FieldComparator.TermValComparator

Field Summary

Fields

Modifier and Type	Field	Description
private float	bottom
private PostingsEnum	currentReaderPostingsValues
private BytesRef	featureName
private java.lang.String	field
private float	topValue
private float[]	values

Constructor Summary

Constructors

Constructor	Description
FeatureComparator(int numHits, java.lang.String field, java.lang.String featureName)	Creates a new comparator based on relevance for numHits.

Method Summary

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.
protected void	doSetNextReader(LeafReaderContext context)	This method is called before collecting context.
private float	getValueForDoc(int doc)
void	setBottom(int bottom)	Set the bottom slot, ie the "weakest" (sorted last) entry in the queue.
void	setTopValue(java.lang.Float value)	Record the top value, for future calls to LeafFieldComparator.compareTop(int).
java.lang.Float	value(int slot)	Return the actual value in the slot.

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

getLeafComparator, setScorer

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

compareValues, disableSkipping, setSingleSort

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.search.LeafFieldComparator

competitiveIterator, setHitsThresholdReached

Field Detail

field

private final java.lang.String field

featureName

private final BytesRef featureName

values

private final float[] values

bottom

private float bottom

topValue

private float topValue

currentReaderPostingsValues

private PostingsEnum currentReaderPostingsValues

Constructor Detail

FeatureComparator

public FeatureComparator(int numHits,
                         java.lang.String field,
                         java.lang.String featureName)

Creates a new comparator based on relevance for numHits.

Method Detail

doSetNextReader

protected void doSetNextReader(LeafReaderContext context)
                        throws java.io.IOException

Description copied from class: SimpleFieldComparator

This method is called before collecting context.

Specified by:

doSetNextReader in class SimpleFieldComparator<java.lang.Float>

Throws:

java.io.IOException

getValueForDoc

private float getValueForDoc(int doc)
                      throws java.io.IOException

Throws:

java.io.IOException

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 class FieldComparator<java.lang.Float>

Parameters:

slot1 - first slot to compare

slot2 - 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)
                  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 as 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).

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.

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.

Parameters:

slot - which slot to copy the hit to

doc - docID relative to current reader

Throws:

java.io.IOException

setBottom

public void setBottom(int bottom)

Description copied from interface: LeafFieldComparator

Set the bottom slot, ie the "weakest" (sorted last) entry in the queue. When LeafFieldComparator.compareBottom(int) is called, you should compare against this slot. This will always be called before LeafFieldComparator.compareBottom(int).

Parameters:

bottom - the currently weakest (sorted last) slot in the queue

setTopValue

public void setTopValue(java.lang.Float value)

Description copied from class: FieldComparator

Record the top value, for future calls to LeafFieldComparator.compareTop(int). This is only called for searches that use searchAfter (deep paging), and is called before any calls to FieldComparator.getLeafComparator(LeafReaderContext).

Specified by:

setTopValue in class FieldComparator<java.lang.Float>

value

public java.lang.Float value(int slot)

Description copied from class: FieldComparator

Return the actual value in the slot.

Specified by:

value in class FieldComparator<java.lang.Float>

Parameters:

slot - the value

Returns:

value in this slot

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 as 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).

Parameters:

doc - that was hit

Returns:

any N < 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.

Throws:

java.io.IOException