org.apache.lucene.search.join

Class ToParentBlockJoinFieldComparator

java.lang.Object

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

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

org.apache.lucene.search.join.ToParentBlockJoinFieldComparator

All Implemented Interfaces:

LeafFieldComparator

Direct Known Subclasses:

ToParentBlockJoinFieldComparator.Highest, ToParentBlockJoinFieldComparator.Lowest

public abstract class ToParentBlockJoinFieldComparator
extends SimpleFieldComparator<Object>
implements LeafFieldComparator

A field comparator that allows parent documents to be sorted by fields from the nested / child documents.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ToParentBlockJoinFieldComparator.Highest Concrete implementation of ToParentBlockJoinSortField to sorts the parent docs with the highest values in the child / nested docs first.
static class	ToParentBlockJoinFieldComparator.Lowest Concrete implementation of ToParentBlockJoinSortField to sorts the parent docs with the lowest values in the child / nested docs first.

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

Method Summary

Methods

Modifier and Type	Method and Description
int	compare(int slot1, int slot2)
protected void	doSetNextReader(LeafReaderContext context)
void	setBottom(int slot)
void	setTopValue(Object value)
Object	value(int slot)

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

compareBottom, compareTop, copy, setScorer

Method Detail

compare

public int compare(int slot1,
          int slot2)

Specified by:

compare in class FieldComparator<Object>

setBottom

public void setBottom(int slot)

Specified by:

setBottom in interface LeafFieldComparator

setTopValue

public void setTopValue(Object value)

Specified by:

setTopValue in class FieldComparator<Object>

doSetNextReader

protected void doSetNextReader(LeafReaderContext context)
                        throws IOException

Specified by:

doSetNextReader in class SimpleFieldComparator<Object>

Throws:

IOException

value

public Object value(int slot)

Specified by:

value in class FieldComparator<Object>