- java.lang.Object
-
- org.apache.lucene.search.Query
-
- org.apache.lucene.search.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.TermQuery
s,PhraseQuery
s or other BooleanQuerys.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BooleanQuery.Builder
A builder for boolean queries.static class
BooleanQuery.TooManyClauses
Deprecated.
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<BooleanClause>
clauses
private java.util.Map<BooleanClause.Occur,java.util.Collection<Query>>
clauseSets
private int
hashCode
private int
minimumNumberShouldMatch
-
Constructor Summary
Constructors Modifier Constructor Description private
BooleanQuery(int minimumNumberShouldMatch, BooleanClause[] clauses)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.util.List<BooleanClause>
clauses()
Return a list of the clauses of thisBooleanQuery
.private int
computeHashCode()
Weight
createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)
Expert: Constructs an appropriate Weight implementation for this query.boolean
equals(java.lang.Object o)
Compares the specified object with this boolean query for equality.private boolean
equalsTo(BooleanQuery other)
(package private) java.util.Collection<Query>
getClauses(BooleanClause.Occur occur)
Return the collection of queries for the givenBooleanClause.Occur
.static int
getMaxClauseCount()
Deprecated.int
getMinimumNumberShouldMatch()
Gets the minimum number of the optional BooleanClauses which must be satisfied.int
hashCode()
Override and implement query hash code properly in a subclass.(package private) boolean
isPureDisjunction()
Whether this query is a pure disjunction, ie.(package private) boolean
isTwoClausePureDisjunctionWithTerms()
Whether this query is a two clause disjunction with two term query clauses.java.util.Iterator<BooleanClause>
iterator()
Returns an iterator on the clauses in this query.Query
rewrite(IndexSearcher indexSearcher)
Expert: called to re-write queries into primitive queries.(package private) BooleanQuery
rewriteNoScoring()
(package private) Query[]
rewriteTwoClauseDisjunctionWithTermsForCount(IndexSearcher indexSearcher)
Rewrite a single two clause disjunction query with terms to two term queries and a conjunction query using the inclusion–exclusion principle.static void
setMaxClauseCount(int maxClauseCount)
Deprecated.java.lang.String
toString(java.lang.String field)
Prints a user-readable version of this query.void
visit(QueryVisitor visitor)
Recurse through the query tree, visiting any child queries.-
Methods inherited from class org.apache.lucene.search.Query
classHash, rewrite, sameClassAs, toString
-
-
-
-
Field Detail
-
minimumNumberShouldMatch
private final int minimumNumberShouldMatch
-
clauses
private final java.util.List<BooleanClause> clauses
-
clauseSets
private final java.util.Map<BooleanClause.Occur,java.util.Collection<Query>> clauseSets
-
hashCode
private int hashCode
-
-
Constructor Detail
-
BooleanQuery
private BooleanQuery(int minimumNumberShouldMatch, BooleanClause[] clauses)
-
-
Method Detail
-
getMaxClauseCount
@Deprecated public static int getMaxClauseCount()
Deprecated.Return the maximum number of clauses permitted, 1024 by default. Attempts to add more than the permitted number of clauses causeBooleanQuery.TooManyClauses
to be thrown.- See Also:
IndexSearcher.setMaxClauseCount(int)
-
setMaxClauseCount
@Deprecated public static void setMaxClauseCount(int maxClauseCount)
Deprecated.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 java.util.List<BooleanClause> clauses()
Return a list of the clauses of thisBooleanQuery
.
-
getClauses
java.util.Collection<Query> getClauses(BooleanClause.Occur occur)
Return the collection of queries for the givenBooleanClause.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 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 theIterable
interface to make it possible to do:for (BooleanClause clause : booleanQuery) {}
- Specified by:
iterator
in interfacejava.lang.Iterable<BooleanClause>
-
rewriteNoScoring
BooleanQuery rewriteNoScoring()
-
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 classQuery
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 classQuery
- 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.
-
toString
public java.lang.String toString(java.lang.String field)
Prints a user-readable version of this query.
-
equals
public boolean equals(java.lang.Object o)
Compares the specified object with this boolean query for equality. Returns true if and only if the provided object- is also a
BooleanQuery
, - has the same value of
getMinimumNumberShouldMatch()
- has the same
BooleanClause.Occur.SHOULD
clauses, regardless of the order - has the same
BooleanClause.Occur.MUST
clauses, regardless of the order - has the same set of
BooleanClause.Occur.FILTER
clauses, regardless of the order and regardless of duplicates - has the same set of
BooleanClause.Occur.MUST_NOT
clauses, regardless of the order and regardless of duplicates
- Specified by:
equals
in classQuery
- See Also:
Query.sameClassAs(Object)
,Query.classHash()
- is also a
-
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 thatQueryCache
works properly.- Specified by:
hashCode
in classQuery
- See Also:
Query.equals(Object)
-
-