- java.lang.Object
-
- org.apache.lucene.search.Query
-
- org.apache.lucene.search.join.ToChildBlockJoinQuery
-
public class ToChildBlockJoinQuery extends Query
Just likeToParentBlockJoinQuery
, except this query joins in reverse: you provide a Query matching parent documents and it joins down to child documents.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static class
ToChildBlockJoinQuery.ToChildBlockJoinScorer
private static class
ToChildBlockJoinQuery.ToChildBlockJoinWeight
-
Field Summary
Fields Modifier and Type Field Description (package private) static java.lang.String
ILLEGAL_ADVANCE_ON_PARENT
(package private) static java.lang.String
INVALID_QUERY_MESSAGE
Message thrown fromToChildBlockJoinQuery.ToChildBlockJoinScorer.validateParentDoc()
on misuse, when the parent query incorrectly returns child docs.private Query
parentQuery
private BitSetProducer
parentsFilter
-
Constructor Summary
Constructors Constructor Description ToChildBlockJoinQuery(Query parentQuery, BitSetProducer parentsFilter)
Create a ToChildBlockJoinQuery.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Weight
createWeight(IndexSearcher searcher, ScoreMode scoreMode, 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(ToChildBlockJoinQuery other)
Query
getParentQuery()
Return our parent query.int
hashCode()
Override and implement query hash code properly in a subclass.Query
rewrite(IndexSearcher indexSearcher)
Expert: called to re-write queries into primitive queries.java.lang.String
toString(java.lang.String field)
Prints a query to a string, withfield
assumed to be the default field and omitted.void
visit(QueryVisitor visitor)
Recurse through the query tree, visiting any child queries.-
Methods inherited from class org.apache.lucene.search.Query
classHash, rewrite, sameClassAs, toString
-
-
-
-
Field Detail
-
INVALID_QUERY_MESSAGE
static final java.lang.String INVALID_QUERY_MESSAGE
Message thrown fromToChildBlockJoinQuery.ToChildBlockJoinScorer.validateParentDoc()
on misuse, when the parent query incorrectly returns child docs.- See Also:
- Constant Field Values
-
ILLEGAL_ADVANCE_ON_PARENT
static final java.lang.String ILLEGAL_ADVANCE_ON_PARENT
- See Also:
- Constant Field Values
-
parentsFilter
private final BitSetProducer parentsFilter
-
parentQuery
private final Query parentQuery
-
-
Constructor Detail
-
ToChildBlockJoinQuery
public ToChildBlockJoinQuery(Query parentQuery, BitSetProducer parentsFilter)
Create a ToChildBlockJoinQuery.- Parameters:
parentQuery
- Query that matches parent documentsparentsFilter
- Filter identifying the parent documents.
-
-
Method Detail
-
visit
public void visit(QueryVisitor visitor)
Description copied from class:Query
Recurse through the query tree, visiting any child queries.
-
createWeight
public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws java.io.IOException
Description copied from class:Query
Expert: Constructs an appropriate Weight implementation for this query.Only implemented by primitive queries, which re-write to themselves.
- Overrides:
createWeight
in classQuery
scoreMode
- How the produced scorers will be consumed.boost
- The boost that is propagated by the parent queries.- Throws:
java.io.IOException
-
getParentQuery
public Query getParentQuery()
Return our parent query.
-
rewrite
public Query rewrite(IndexSearcher indexSearcher) throws java.io.IOException
Description copied from class:Query
Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.Callers are expected to call
rewrite
multiple times if necessary, until the rewritten query is the same as the original query.The rewrite process may be able to make use of IndexSearcher's executor and be executed in parallel if the executor is provided.
However, if any of the intermediary queries do not satisfy the new API, parallel rewrite is not possible for any subsequent sub-queries. To take advantage of this API, the entire query tree must override this method.
- Overrides:
rewrite
in classQuery
- Throws:
java.io.IOException
- See Also:
IndexSearcher.rewrite(Query)
-
toString
public java.lang.String toString(java.lang.String field)
Description copied from class:Query
Prints a query to a string, withfield
assumed to be the default field and omitted.
-
equals
public boolean equals(java.lang.Object other)
Description copied from class:Query
Override and implement query instance equivalence properly in a subclass. This is required so thatQueryCache
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 to those of the other instance. Utility methods are provided for certain repetitive code.
- Specified by:
equals
in classQuery
- See Also:
Query.sameClassAs(Object)
,Query.classHash()
-
equalsTo
private boolean equalsTo(ToChildBlockJoinQuery other)
-
hashCode
public int hashCode()
Description copied from class:Query
Override and implement query hash code properly in a subclass. This is required so thatQueryCache
works properly.- Specified by:
hashCode
in classQuery
- See Also:
Query.equals(Object)
-
-