public class ToParentBlockJoinQuery extends Query
IndexWriter.addDocuments()
or IndexWriter.updateDocuments()
API. In each block, the
child 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 BitSet
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 ToChildBlockJoinQuery
if you need to join
in the reverse order.
The child documents must be orthogonal to the parent documents: the wrapped child query must never return a parent document.
See org.apache.lucene.search.join
for an
overview.
Modifier and Type | Class and Description |
---|---|
(package private) static class |
ToParentBlockJoinQuery.BlockJoinScorer |
private static class |
ToParentBlockJoinQuery.BlockJoinWeight |
private static class |
ToParentBlockJoinQuery.ParentApproximation |
private static class |
ToParentBlockJoinQuery.ParentTwoPhase |
Modifier and Type | Field and Description |
---|---|
private Query |
childQuery |
private BitSetProducer |
parentsFilter |
private ScoreMode |
scoreMode |
Constructor and Description |
---|
ToParentBlockJoinQuery(Query childQuery,
BitSetProducer parentsFilter,
ScoreMode scoreMode)
Create a ToParentBlockJoinQuery.
|
Modifier and Type | Method and Description |
---|---|
Weight |
createWeight(IndexSearcher searcher,
ScoreMode weightScoreMode,
float boost)
Expert: Constructs an appropriate Weight implementation for this query.
|
boolean |
equals(java.lang.Object other)
Override and implement query instance equivalence properly in a subclass.
|
private boolean |
equalsTo(ToParentBlockJoinQuery other) |
Query |
getChildQuery()
Return our child query.
|
int |
hashCode()
Override and implement query hash code properly in a subclass.
|
Query |
rewrite(IndexReader reader)
Expert: called to re-write queries into primitive queries.
|
java.lang.String |
toString(java.lang.String field)
Prints a query to a string, with
field assumed to be the
default field and omitted. |
void |
visit(QueryVisitor visitor)
Recurse through the query tree, visiting any child queries
|
classHash, sameClassAs, toString
private final BitSetProducer parentsFilter
private final Query childQuery
private final ScoreMode scoreMode
public ToParentBlockJoinQuery(Query childQuery, BitSetProducer parentsFilter, ScoreMode scoreMode)
childQuery
- Query matching child documents.parentsFilter
- Filter identifying the parent documents.scoreMode
- How to aggregate multiple child scores
into a single parent score.public void visit(QueryVisitor visitor)
Query
public Weight createWeight(IndexSearcher searcher, ScoreMode weightScoreMode, float boost) throws java.io.IOException
Query
Only implemented by primitive queries, which re-write to themselves.
createWeight
in class Query
weightScoreMode
- How the produced scorers will be consumed.boost
- The boost that is propagated by the parent queries.java.io.IOException
public Query getChildQuery()
public Query rewrite(IndexReader reader) throws java.io.IOException
Query
public java.lang.String toString(java.lang.String field)
Query
field
assumed to be the
default field and omitted.public boolean equals(java.lang.Object other)
Query
QueryCache
works properly.
Typically a query will be equal to another only if it's an instance of
the same class and its document-filtering properties are identical that other
instance. Utility methods are provided for certain repetitive code.equals
in class Query
Query.sameClassAs(Object)
,
Query.classHash()
private boolean equalsTo(ToParentBlockJoinQuery other)
public int hashCode()
Query
QueryCache
works properly.hashCode
in class Query
Query.equals(Object)