Package org.apache.lucene.search.join
Class ToParentBlockJoinSortField
java.lang.Object
org.apache.lucene.search.SortField
org.apache.lucene.search.join.ToParentBlockJoinSortField
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.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.search.SortField
SortField.Provider, SortField.Type -
Field Summary
Fields inherited from class org.apache.lucene.search.SortField
FIELD_DOC, FIELD_SCORE, missingValue, STRING_FIRST, STRING_LAST -
Constructor Summary
ConstructorsConstructorDescriptionToParentBlockJoinSortField(String field, SortField.Type type, boolean reverse, boolean order, BitSetProducer parentFilter, BitSetProducer childFilter) Create ToParentBlockJoinSortField.ToParentBlockJoinSortField(String field, SortField.Type type, boolean reverse, BitSetProducer parentFilter, BitSetProducer childFilter) Create ToParentBlockJoinSortField. -
Method Summary
Modifier and TypeMethodDescriptionbooleangetComparator(int numHits, Pruning pruning) inthashCode()Methods inherited from class org.apache.lucene.search.SortField
getBytesComparator, getComparatorSource, getField, getIndexSorter, getMissingValue, getOptimizeSortWithIndexedData, getOptimizeSortWithPoints, getReverse, getType, needsScores, readType, rewrite, setBytesComparator, setMissingValue, setOptimizeSortWithIndexedData, setOptimizeSortWithPoints, toString
-
Constructor Details
-
ToParentBlockJoinSortField
public ToParentBlockJoinSortField(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(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 Details