Class BooleanQuery

  • All Implemented Interfaces:
    java.lang.Iterable<BooleanClause>

    public class BooleanQuery
    extends Query
    implements java.lang.Iterable<BooleanClause>
    A Query that matches documents matching boolean combinations of other queries, e.g. TermQuerys, PhraseQuerys or other BooleanQuerys.
    • Field Detail

      • minimumNumberShouldMatch

        private final int minimumNumberShouldMatch
      • hashCode

        private int hashCode
    • Constructor Detail

      • BooleanQuery

        private BooleanQuery​(int minimumNumberShouldMatch,
                             BooleanClause[] clauses)
    • Method Detail

      • setMaxClauseCount

        @Deprecated
        public static void setMaxClauseCount​(int maxClauseCount)
        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.
      • 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 java.io.IOException
        Rewrite a single two clause disjunction query with terms to two term queries and a conjunction query using the inclusion–exclusion principle.
        Throws:
        java.io.IOException
      • iterator

        public final java.util.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 java.lang.Iterable<BooleanClause>
      • 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 class Query
        scoreMode - How the produced scorers will be consumed.
        boost - The boost that is propagated by the parent queries.
        Throws:
        java.io.IOException
      • 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 class Query
        Throws:
        java.io.IOException
        See Also:
        IndexSearcher.rewrite(Query)
      • 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 java.lang.String toString​(java.lang.String field)
        Prints a user-readable version of this query.
        Specified by:
        toString in class Query
      • 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:
        Query.equals(Object)