Package org.apache.lucene.search.join

Class ParentChildrenBlockJoinQuery

java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.search.join.ParentChildrenBlockJoinQuery
public class ParentChildrenBlockJoinQuery extends org.apache.lucene.search.Query
A query that returns all the matching child documents for a specific parent document indexed together in the same block. The provided child query determines which matching child doc is being returned.
WARNING: This API is experimental and might change in incompatible ways in the next release.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ParentChildrenBlockJoinQuery(BitSetProducer parentFilter, org.apache.lucene.search.Query childQuery, int parentDocId)
    Creates a ParentChildrenBlockJoinQuery instance

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.lucene.search.Weight
    createWeight(org.apache.lucene.search.IndexSearcher searcher, org.apache.lucene.search.ScoreMode scoreMode, float boost)
     
    boolean
    equals(Object obj)
     
    int
    hashCode()
     
    org.apache.lucene.search.Query
    rewrite(org.apache.lucene.index.IndexReader reader)
     
    String
    toString(String field)
     
    void
    visit(org.apache.lucene.search.QueryVisitor visitor)
     

    Methods inherited from class org.apache.lucene.search.Query

    classHash, sameClassAs, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ParentChildrenBlockJoinQuery

      public ParentChildrenBlockJoinQuery(BitSetProducer parentFilter, org.apache.lucene.search.Query childQuery, int parentDocId)
      Creates a ParentChildrenBlockJoinQuery instance
      Parameters:
      parentFilter - A filter identifying parent documents.
      childQuery - A child query that determines which child docs are matching
      parentDocId - The top level doc id of that parent to return children documents for

  • Method Details

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in class org.apache.lucene.search.Query

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in class org.apache.lucene.search.Query

    • toString

      public String toString(String field)
      Specified by:
      toString in class org.apache.lucene.search.Query

    • visit

      public void visit(org.apache.lucene.search.QueryVisitor visitor)
      Specified by:
      visit in class org.apache.lucene.search.Query

    • rewrite

      public org.apache.lucene.search.Query rewrite(org.apache.lucene.index.IndexReader reader) throws IOException
      Overrides:
      rewrite in class org.apache.lucene.search.Query
      Throws:
      IOException

    • createWeight

      public org.apache.lucene.search.Weight createWeight(org.apache.lucene.search.IndexSearcher searcher, org.apache.lucene.search.ScoreMode scoreMode, float boost) throws IOException
      Overrides:
      createWeight in class org.apache.lucene.search.Query
      Throws:
      IOException