Module org.apache.lucene.core
Package org.apache.lucene.search

Class BooleanQuery

java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.search.BooleanQuery
All Implemented Interfaces:
Iterable<BooleanClause>
public class BooleanQuery extends Query implements Iterable<BooleanClause>
A Query that matches documents matching boolean combinations of other queries, e.g. TermQuerys, PhraseQuerys or other BooleanQuerys.

  • Field Details

  • Constructor Details

    • BooleanQuery

      private BooleanQuery(int minimumNumberShouldMatch, BooleanClause[] clauses)

  • Method Details

    • getMaxClauseCount

      @Deprecated public static int getMaxClauseCount()
      Deprecated.
      use IndexSearcher.getMaxClauseCount()
      Return the maximum number of clauses permitted, 1024 by default. Attempts to add more than the permitted number of clauses cause BooleanQuery.TooManyClauses to be thrown.
      See Also:

    • setMaxClauseCount

      @Deprecated public static void setMaxClauseCount(int maxClauseCount)
      Deprecated.
      use IndexSearcher.setMaxClauseCount(int)
      Set the maximum number of clauses permitted per BooleanQuery. Default value is 1024.

    • getMinimumNumberShouldMatch

      public int getMinimumNumberShouldMatch()
      Gets the minimum number of the optional BooleanClauses which must be satisfied.

    • clauses

      public List<BooleanClause> clauses()
      Return a list of the clauses of this BooleanQuery.

    • getClauses

      Collection<Query> getClauses(BooleanClause.Occur occur)
      Return the collection of queries for the given BooleanClause.Occur.

    • isPureDisjunction

      boolean isPureDisjunction()
      Whether this query is a pure disjunction, ie. it only has SHOULD clauses and it is enough for a single clause to match for this boolean query to match.

    • isTwoClausePureDisjunctionWithTerms

      boolean isTwoClausePureDisjunctionWithTerms()
      Whether this query is a two clause disjunction with two term query clauses.

    • rewriteTwoClauseDisjunctionWithTermsForCount

      Query[] rewriteTwoClauseDisjunctionWithTermsForCount(IndexSearcher indexSearcher) throws IOException
      Rewrite a single two clause disjunction query with terms to two term queries and a conjunction query using the inclusion–exclusion principle.
      Throws:
      IOException

    • iterator

      public final Iterator<BooleanClause> iterator()
      Returns an iterator on the clauses in this query. It implements the Iterable interface to make it possible to do: 
      for (BooleanClause clause : booleanQuery) {}
      Specified by:
      iterator in interface Iterable<BooleanClause>

    • rewriteNoScoring

      BooleanQuery rewriteNoScoring()

    • createWeight

      public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, 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 class Query
      Parameters:
      scoreMode - How the produced scorers will be consumed.
      boost - The boost that is propagated by the parent queries.
      Throws:
      IOException

    • rewrite

      public Query rewrite(IndexSearcher indexSearcher) throws 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 class Query
      Throws:
      IOException
      See Also:

    • visit

      public void visit(QueryVisitor visitor)
      Description copied from class: Query
      Recurse through the query tree, visiting any child queries.
      Specified by:
      visit in class Query
      Parameters:
      visitor - a QueryVisitor to be called by each query in the tree

    • toString

      public String toString(String field)
      Prints a user-readable version of this query.
      Specified by:
      toString in class Query

    • equals

      public boolean equals(Object o)
      Compares the specified object with this boolean query for equality. Returns true if and only if the provided object
      Specified by:
      equals in class Query
      See Also:

    • equalsTo

      private boolean equalsTo(BooleanQuery other)

    • computeHashCode

      private int computeHashCode()

    • hashCode

      public int hashCode()
      Description copied from class: Query
      Override and implement query hash code properly in a subclass. This is required so that QueryCache works properly.
      Specified by:
      hashCode in class Query
      See Also: