This query requires that you index children and parent docs as a single block, using the {@link IndexWriter#addDocuments IndexWriter.addDocuments()} or {@link IndexWriter#updateDocuments IndexWriter.updateDocuments()} API. In each block, thechild documents must appear first, ending with the parent document. At search time you provide a Filter identifying the parents, however this Filter must provide an {@link FixedBitSet} per sub-reader.
Once the block index is built, use this query to wrap any sub-query matching only child docs and join matches in that child document space up to the parent document space. You can then use this Query as a clause with other queries in the parent document space.
See {@link ToChildBlockJoinQuery} if you need to joinin the reverse order.
The child documents must be orthogonal to the parent documents: the wrapped child query must never return a parent document.
If you'd like to retrieve {@link TopGroups} for theresulting query, use the {@link ToParentBlockJoinCollector}. Note that this is not necessary, ie, if you simply want to collect the parent documents and don't need to see which child documents matched under that parent, then you can use any collector.
NOTE: If the overall query contains parent-only matches, for example you OR a parent-only query with a joined child-only query, then the resulting collected documents will be correct, however the {@link TopGroups} you getfrom {@link ToParentBlockJoinCollector} will not contain everychild for parents that had matched.
See {@link org.apache.lucene.search.join} for anoverview.
@lucene.experimental