org.apache.lucene.search.join

Class ToParentBlockJoinSortField

java.lang.Object

org.apache.lucene.search.SortField

org.apache.lucene.search.join.ToParentBlockJoinSortField

public class ToParentBlockJoinSortField
extends SortField

A special sort field that allows sorting parent docs based on nested / child level fields. Based on the sort order it either takes the document with the lowest or highest field value into account.

Nested Class Summary

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

SortField.Type

Field Summary

Fields inherited from class org.apache.lucene.search.SortField

FIELD_DOC, FIELD_SCORE, missingValue, STRING_FIRST, STRING_LAST

Constructor Summary

Constructors

Constructor and Description
ToParentBlockJoinSortField(java.lang.String field, SortField.Type type, boolean reverse, BitSetProducer parentFilter, BitSetProducer childFilter) Create ToParentBlockJoinSortField.
ToParentBlockJoinSortField(java.lang.String field, SortField.Type type, boolean reverse, boolean order, BitSetProducer parentFilter, BitSetProducer childFilter) Create ToParentBlockJoinSortField.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns true if o is equal to this.
FieldComparator<?>	getComparator(int numHits, int sortPos) Returns the FieldComparator to use for sorting.
int	hashCode() Returns a hash code for this SortField instance.

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

getBytesComparator, getComparatorSource, getField, getMissingValue, getReverse, getType, needsScores, rewrite, setBytesComparator, setMissingValue, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ToParentBlockJoinSortField

public ToParentBlockJoinSortField(java.lang.String field,
                                  SortField.Type type,
                                  boolean reverse,
                                  BitSetProducer parentFilter,
                                  BitSetProducer childFilter)

Create ToParentBlockJoinSortField. The parent document ordering is based on child document ordering (reverse).

Parameters:

field - The sort field on the nested / child level.

type - The sort type on the nested / child level.

reverse - Whether natural order should be reversed on the nested / child level.

parentFilter - Filter that identifies the parent documents.

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

ToParentBlockJoinSortField

public ToParentBlockJoinSortField(java.lang.String field,
                                  SortField.Type type,
                                  boolean reverse,
                                  boolean order,
                                  BitSetProducer parentFilter,
                                  BitSetProducer childFilter)

Create ToParentBlockJoinSortField.

Parameters:

field - The sort field on the nested / child level.

type - The sort type on the nested / child level.

reverse - Whether natural order should be reversed on the nested / child document level.

order - Whether natural order should be reversed on the parent level.

parentFilter - Filter that identifies the parent documents.

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

Method Detail

getComparator

public FieldComparator<?> getComparator(int numHits,
                                        int sortPos)

Description copied from class: SortField

Returns the FieldComparator to use for sorting.

Overrides:

getComparator in class SortField

Parameters:

numHits - number of top hits the queue will store

sortPos - position of this SortField within Sort. The comparator is primary if sortPos==0, secondary if sortPos==1, etc. Some comparators can optimize themselves when they are the primary sort.

Returns:

FieldComparator to use when sorting

hashCode

public int hashCode()

Description copied from class: SortField

Returns a hash code for this SortField instance. If a FieldComparatorSource was provided, it must properly implement hashCode (unless a singleton is always used).

Overrides:

hashCode in class SortField

equals

public boolean equals(java.lang.Object obj)

Description copied from class: SortField

Returns true if o is equal to this. If a FieldComparatorSource was provided, it must properly implement equals (unless a singleton is always used).

Overrides:

equals in class SortField