Package org.apache.lucene.search

Class BooleanQuery

  • All Implemented Interfaces:
    java.lang.Cloneable, 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.

    • Constructor Detail

      • BooleanQuery

        public BooleanQuery()
        Constructs an empty boolean query.

      • BooleanQuery

        public BooleanQuery​(boolean disableCoord)
        Constructs an empty boolean query. Similarity.coord(int,int) may be disabled in scoring, as appropriate. For example, this score factor does not make sense for most automatically generated queries, like WildcardQuery and FuzzyQuery.
        Parameters:
        disableCoord - disables Similarity.coord(int,int) in scoring.

    • Method Detail

      • getMaxClauseCount

        public static int 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(int)

      • setMaxClauseCount

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

      • setMinimumNumberShouldMatch

        public void setMinimumNumberShouldMatch​(int min)
        Specifies a minimum number of the optional BooleanClauses which must be satisfied.

        By default no optional clauses are necessary for a match (unless there are no required clauses). If this method is used, then the specified number of clauses is required.

        Use of this method is totally independent of specifying that any specific clauses are required (or prohibited). This number will only be compared against the number of matching optional clauses.

        Parameters:
        min - the number of optional clauses that must match

      • getMinimumNumberShouldMatch

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

      • getClauses

        public BooleanClause[] getClauses()
        Returns the set of clauses in this query.

      • clauses

        public java.util.List<BooleanClause> clauses()
        Returns the list of clauses in this query.

      • 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)
                    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
        Throws:
        java.io.IOException

      • rewrite

        public Query rewrite​(IndexReader reader)
              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.
        Overrides:
        rewrite in class Query
        Throws:
        java.io.IOException

      • extractTerms

        public void extractTerms​(java.util.Set<Term> terms)
        Description copied from class: Query
        Expert: adds all terms occurring in this query to the terms set. Only works if this query is in its rewritten form.
        Overrides:
        extractTerms in class Query

      • clone

        public BooleanQuery clone()
        Description copied from class: Query
        Returns a clone of this query.
        Overrides:
        clone in class Query

      • toString

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

      • equals

        public boolean equals​(java.lang.Object o)
        Returns true iff o is equal to this.
        Overrides:
        equals in class Query

      • hashCode

        public int hashCode()
        Returns a hash code value for this object.
        Overrides:
        hashCode in class Query