org.apache.lucene.search

Class BooleanQuery

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. TermQuerys, PhraseQuerys or other BooleanQuerys.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BooleanQuery.Builder A builder for boolean queries.
static class	BooleanQuery.TooManyClauses Thrown when an attempt is made to add more than getMaxClauseCount() clauses.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<BooleanClause>	clauses
private java.util.Map<BooleanClause.Occur,java.util.Collection<Query>>	clauseSets
private int	hashCode
private static int	maxClauseCount
private int	minimumNumberShouldMatch

Constructor Summary

Constructors

Modifier	Constructor and Description
private	BooleanQuery(int minimumNumberShouldMatch, BooleanClause[] clauses)

Method Summary

Modifier and Type	Method and Description
java.util.List<BooleanClause>	clauses() Return a list of the clauses of this BooleanQuery.
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 given BooleanClause.Occur.
static int	getMaxClauseCount() Return the maximum number of clauses permitted, 1024 by default.
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.
java.util.Iterator<BooleanClause>	iterator() Returns an iterator on the clauses in this query.
Query	rewrite(IndexReader reader) Expert: called to re-write queries into primitive queries.
private BooleanQuery	rewriteNoScoring()
static void	setMaxClauseCount(int maxClauseCount) Set the maximum number of clauses permitted per BooleanQuery.
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, sameClassAs, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

maxClauseCount

private static int maxClauseCount

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

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.

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 this BooleanQuery.

getClauses

java.util.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.

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>

rewriteNoScoring

private 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 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(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

visit

public void visit(QueryVisitor visitor)

Description copied from class: Query

Recurse through the query tree, visiting any child queries

Overrides:

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

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 class Query

See Also:

Query.sameClassAs(Object), Query.classHash()

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)