org.apache.lucene.search.join

Class ToParentBlockJoinFieldComparator.Highest

java.lang.Object

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

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

org.apache.lucene.search.join.ToParentBlockJoinFieldComparator

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

All Implemented Interfaces:

LeafFieldComparator

Enclosing class:

ToParentBlockJoinFieldComparator

public static final class ToParentBlockJoinFieldComparator.Highest
extends ToParentBlockJoinFieldComparator
implements LeafFieldComparator

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.DocComparator, FieldComparator.DoubleComparator, FieldComparator.FloatComparator, FieldComparator.IntComparator, FieldComparator.LongComparator, FieldComparator.NumericComparator<T extends Number>, FieldComparator.RelevanceComparator, FieldComparator.TermOrdValComparator, FieldComparator.TermValComparator

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	compareBottom(int parentDoc)
int	compareTop(int parentDoc)
void	copy(int slot, int parentDoc)

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

compare, doSetNextReader, setBottom, setTopValue, value

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

getLeafComparator, setScorer

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

compareValues

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

setBottom, setScorer

Constructor Detail

ToParentBlockJoinFieldComparator.Highest

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

Create ToParentBlockJoinFieldComparator.Highest

Parameters:

wrappedComparator - The LeafFieldComparator on the child / nested level.

parentFilter - Filter 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

Specified by:

compareBottom in interface LeafFieldComparator

Throws:

IOException

copy

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

Specified by:

copy in interface LeafFieldComparator

Throws:

IOException

compareTop

public int compareTop(int parentDoc)
               throws IOException

Specified by:

compareTop in interface LeafFieldComparator

Throws:

IOException