Class ToParentBlockJoinQuery
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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class
private static class
private static class
private static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Query
private final BitSetProducer
private final ScoreMode
-
Constructor Summary
ConstructorsConstructorDescriptionToParentBlockJoinQuery
(Query childQuery, BitSetProducer parentsFilter, ScoreMode scoreMode) Create a ToParentBlockJoinQuery. -
Method Summary
Modifier and TypeMethodDescriptioncreateWeight
(IndexSearcher searcher, ScoreMode weightScoreMode, float boost) Expert: Constructs an appropriate Weight implementation for this query.boolean
Override and implement query instance equivalence properly in a subclass.private boolean
equalsTo
(ToParentBlockJoinQuery other) Return our child query.int
hashCode()
Override and implement query hash code properly in a subclass.rewrite
(IndexReader reader) Expert: called to re-write queries into primitive queries.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 queriesMethods inherited from class org.apache.lucene.search.Query
classHash, sameClassAs, toString
-
Field Details
-
parentsFilter
-
childQuery
-
scoreMode
-
-
Constructor Details
-
ToParentBlockJoinQuery
Create a ToParentBlockJoinQuery.- Parameters:
childQuery
- Query matching child documents.parentsFilter
- Filter identifying the parent documents.scoreMode
- How to aggregate multiple child scores into a single parent score.
-
-
Method Details
-
visit
Description copied from class:Query
Recurse through the query tree, visiting any child queries -
createWeight
public Weight createWeight(IndexSearcher searcher, ScoreMode weightScoreMode, float boost) throws 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
weightScoreMode
- How the produced scorers will be consumed.boost
- The boost that is propagated by the parent queries.- Throws:
IOException
-
getChildQuery
Return our child query. -
rewrite
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.- Overrides:
rewrite
in classQuery
- Throws:
IOException
- See Also:
-
toString
Description copied from class:Query
Prints a query to a string, withfield
assumed to be the default field and omitted. -
equals
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 that other instance. Utility methods are provided for certain repetitive code.
-
equalsTo
-
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.
-