org.apache.lucene.search.join

Class ToParentBlockJoinFieldComparator.Highest

java.lang.Object

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

org.apache.lucene.search.join.ToParentBlockJoinFieldComparator

org.apache.lucene.search.join.ToParentBlockJoinFieldComparator.Highest

Enclosing class:

ToParentBlockJoinFieldComparator

public static final class ToParentBlockJoinFieldComparator.Highest
extends ToParentBlockJoinFieldComparator

Concrete implementation of ToParentBlockJoinSortField to sorts the parent docs with the highest values in the child / nested docs first.

Nested Class Summary

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

ToParentBlockJoinFieldComparator.Highest, ToParentBlockJoinFieldComparator.Lowest

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

FieldComparator.ByteComparator, FieldComparator.DocComparator, FieldComparator.DoubleComparator, FieldComparator.FloatComparator, FieldComparator.IntComparator, FieldComparator.LongComparator, FieldComparator.NumericComparator<T extends Number>, FieldComparator.RelevanceComparator, FieldComparator.ShortComparator, FieldComparator.TermOrdValComparator, FieldComparator.TermValComparator

Constructor Summary

Constructors

Constructor and Description
ToParentBlockJoinFieldComparator.Highest(FieldComparator<Object> wrappedComparator, Filter parentFilter, Filter childFilter, int spareSlot) Create ToParentBlockJoinFieldComparator.Highest

Method Summary

Methods

Modifier and Type	Method and Description
int	compareBottom(int parentDoc) Compare the bottom of the queue with this doc.
int	compareTop(int parentDoc) Compare the top value with this doc.
void	copy(int slot, int parentDoc) This method is called when a new hit is competitive.

Methods inherited from class org.apache.lucene.search.join.ToParentBlockJoinFieldComparator

compare, setBottom, setNextReader, setTopValue, value

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

compareValues, setScorer

Methods inherited from class java.lang.Object

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

Constructor Detail

ToParentBlockJoinFieldComparator.Highest

public ToParentBlockJoinFieldComparator.Highest(FieldComparator<Object> wrappedComparator,
                                        Filter parentFilter,
                                        Filter childFilter,
                                        int spareSlot)

Create ToParentBlockJoinFieldComparator.Highest

Parameters:

wrappedComparator - The FieldComparator on the child / nested level.

parentFilter - Filter (must produce FixedBitSet per-segment) that identifies the parent documents.

childFilter - Filter that defines which child / nested documents participates in sorting.

spareSlot - The extra slot inside the wrapped comparator that is used to compare which nested document inside the parent document scope is most competitive.

Method Detail

compareBottom

public int compareBottom(int parentDoc)
                  throws IOException

Description copied from class: FieldComparator

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

Specified by:

compareBottom in class FieldComparator<Object>

Parameters:

parentDoc - 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:

IOException

copy

public void copy(int slot,
        int parentDoc)
          throws IOException

Description copied from class: FieldComparator

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 class FieldComparator<Object>

Parameters:

slot - which slot to copy the hit to

parentDoc - docID relative to current reader

Throws:

IOException

compareTop

public int compareTop(int parentDoc)
               throws IOException

Description copied from class: FieldComparator

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

Specified by:

compareTop in class FieldComparator<Object>

Parameters:

parentDoc - 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:

IOException