public class ToParentBlockJoinCollector extends java.lang.Object implements Collector
IndexWriter.addDocuments(java.lang.Iterable<? extends java.lang.Iterable<? extends org.apache.lucene.index.IndexableField>>)
or IndexWriter.updateDocuments(org.apache.lucene.index.Term, java.lang.Iterable<? extends java.lang.Iterable<? extends org.apache.lucene.index.IndexableField>>)
). Ie, the join is computed
at index time.
This collector MUST be used with ToParentBlockJoinIndexSearcher
,
in order to work correctly.
The parent Sort must only use fields from the parent documents; sorting by field in the child documents is not supported.
You should only use this
collector if one or more of the clauses in the query is
a ToParentBlockJoinQuery
. This collector will find those query
clauses and record the matching child documents for the
top scoring parent documents.
Multiple joins (star join) and nested joins and a mix of the two are allowed, as long as in all cases the documents corresponding to a single row of each joined parent table were indexed as a doc block.
For the simple star join you can retrieve the
TopGroups
instance containing each ToParentBlockJoinQuery
's
matching child documents for the top parent groups,
using getTopGroups(org.apache.lucene.search.join.ToParentBlockJoinQuery, org.apache.lucene.search.Sort, int, int, int, boolean)
. Ie,
a single query, which will contain two or more
ToParentBlockJoinQuery
's as clauses representing the star join,
can then retrieve two or more TopGroups
instances.
For nested joins, the query will run correctly (ie,
match the right parent and child documents), however,
because TopGroups is currently unable to support nesting
(each group is not able to hold another TopGroups), you
are only able to retrieve the TopGroups of the first
join. The TopGroups of the nested joins will not be
correct.
See org.apache.lucene.search.join
for a code
sample.
Modifier and Type | Class and Description |
---|---|
private static class |
ToParentBlockJoinCollector.OneGroup |
Modifier and Type | Field and Description |
---|---|
private ToParentBlockJoinCollector.OneGroup |
bottom |
private FieldComparator<?>[] |
comparators |
private java.util.Map<Query,java.lang.Integer> |
joinQueryID |
private ToParentBlockJoinQuery.BlockJoinScorer[] |
joinScorers |
private float |
maxScore |
private int |
numParentHits |
private FieldValueHitQueue<ToParentBlockJoinCollector.OneGroup> |
queue |
private boolean |
queueFull |
private Sort |
sort |
private ToParentBlockJoinCollector.OneGroup[] |
sortedGroups |
private int |
totalHitCount |
private boolean |
trackMaxScore |
private boolean |
trackScores |
Constructor and Description |
---|
ToParentBlockJoinCollector(Sort sort,
int numParentHits,
boolean trackScores,
boolean trackMaxScore)
Creates a ToParentBlockJoinCollector.
|
Modifier and Type | Method and Description |
---|---|
private TopGroups<java.lang.Integer> |
accumulateGroups(int slot,
int offset,
int maxDocsPerGroup,
int withinGroupOffset,
Sort withinGroupSort,
boolean fillSortFields)
Accumulates groups for the BlockJoinQuery specified by its slot.
|
private void |
enroll(ToParentBlockJoinQuery query,
ToParentBlockJoinQuery.BlockJoinScorer scorer) |
LeafCollector |
getLeafCollector(LeafReaderContext context)
Create a new
collector to collect the given context. |
float |
getMaxScore()
Returns the highest score across all collected parent hits, as long as
trackMaxScores=true was passed
on
construction . |
TopGroups<java.lang.Integer> |
getTopGroups(ToParentBlockJoinQuery query,
Sort withinGroupSort,
int offset,
int maxDocsPerGroup,
int withinGroupOffset,
boolean fillSortFields)
Returns the TopGroups for the specified
BlockJoinQuery.
|
TopGroups<java.lang.Integer> |
getTopGroupsWithAllChildDocs(ToParentBlockJoinQuery query,
Sort withinGroupSort,
int offset,
int withinGroupOffset,
boolean fillSortFields)
Returns the TopGroups for the specified BlockJoinQuery.
|
boolean |
needsScores()
Indicates if document scores are needed by this collector.
|
private void |
sortQueue() |
private final Sort sort
private final java.util.Map<Query,java.lang.Integer> joinQueryID
private final int numParentHits
private final FieldValueHitQueue<ToParentBlockJoinCollector.OneGroup> queue
private final FieldComparator<?>[] comparators
private final boolean trackMaxScore
private final boolean trackScores
private ToParentBlockJoinQuery.BlockJoinScorer[] joinScorers
private boolean queueFull
private ToParentBlockJoinCollector.OneGroup bottom
private int totalHitCount
private float maxScore
private ToParentBlockJoinCollector.OneGroup[] sortedGroups
public ToParentBlockJoinCollector(Sort sort, int numParentHits, boolean trackScores, boolean trackMaxScore) throws java.io.IOException
java.io.IOException
public LeafCollector getLeafCollector(LeafReaderContext context) throws java.io.IOException
Collector
collector
to collect the given context.getLeafCollector
in interface Collector
context
- next atomic reader contextjava.io.IOException
private void enroll(ToParentBlockJoinQuery query, ToParentBlockJoinQuery.BlockJoinScorer scorer)
private void sortQueue()
public TopGroups<java.lang.Integer> getTopGroups(ToParentBlockJoinQuery query, Sort withinGroupSort, int offset, int maxDocsPerGroup, int withinGroupOffset, boolean fillSortFields) throws java.io.IOException
maxDocsPerGroup
and number of matched child documents for that group.
Returns null if no groups matched.query
- Search querywithinGroupSort
- Sort criteria within groupsoffset
- Parent docs offsetmaxDocsPerGroup
- Upper bound of documents per group numberwithinGroupOffset
- Offset within each group of child docsfillSortFields
- Specifies whether to add sort fields or notjava.io.IOException
- if there is a low-level I/O errorprivate TopGroups<java.lang.Integer> accumulateGroups(int slot, int offset, int maxDocsPerGroup, int withinGroupOffset, Sort withinGroupSort, boolean fillSortFields) throws java.io.IOException
slot
- Search query's slotoffset
- Parent docs offsetmaxDocsPerGroup
- Upper bound of documents per group numberwithinGroupOffset
- Offset within each group of child docswithinGroupSort
- Sort criteria within groupsfillSortFields
- Specifies whether to add sort fields or notjava.io.IOException
- if there is a low-level I/O errorpublic TopGroups<java.lang.Integer> getTopGroupsWithAllChildDocs(ToParentBlockJoinQuery query, Sort withinGroupSort, int offset, int withinGroupOffset, boolean fillSortFields) throws java.io.IOException
query
- Search querywithinGroupSort
- Sort criteria within groupsoffset
- Parent docs offsetwithinGroupOffset
- Offset within each group of child docsfillSortFields
- Specifies whether to add sort fields or notjava.io.IOException
- if there is a low-level I/O errorpublic float getMaxScore()
trackMaxScores=true
was passed
on
construction
. Else, this returns Float.NaN
public boolean needsScores()
Collector
needsScores
in interface Collector
true
if scores are needed.