org.apache.lucene.search

Class BooleanClause

public class BooleanClause extends Object implements Serializable

A clause in a BooleanQuery.

Nested Class Summary
static class	BooleanClause.Occur Specifies how terms may occur in matching documents.

Field Summary
boolean	prohibited If true, documents documents which do match this sub-query will not match the boolean query.
Query	query The query whose matching documents are combined by the boolean query.
boolean	required If true, documents documents which do not match this sub-query will not match the boolean query.

Constructor Summary
	BooleanClause(Query q, boolean r, boolean p) Constructs a BooleanClause with query `q`, required `r` and prohibited `p`.
	BooleanClause(Query query, BooleanClause.Occur occur) Constructs a BooleanClause.

Method Summary
boolean	equals(Object o) Returns true iff `o` is equal to this.
BooleanClause.Occur	getOccur()
Query	getQuery()
int	hashCode() Returns a hash code value for this object.
boolean	isProhibited()
boolean	isRequired()
void	setOccur(BooleanClause.Occur occur)
void	setQuery(Query query)
String	toString()

Field Detail

public boolean prohibited

Deprecated: use setOccur instead

If true, documents documents which do match this sub-query will not match the boolean query.

public Query query

Deprecated: use setQuery instead

The query whose matching documents are combined by the boolean query.

public boolean required

Deprecated: use setOccur instead

If true, documents documents which do not match this sub-query will not match the boolean query.

public BooleanClause(Query q, boolean r, boolean p)

Deprecated: use BooleanClause(Query, Occur) instead

For BooleanClause(query, true, false) use BooleanClause(query, BooleanClause.Occur.MUST)
For BooleanClause(query, false, false) use BooleanClause(query, BooleanClause.Occur.SHOULD)
For BooleanClause(query, false, true) use BooleanClause(query, BooleanClause.Occur.MUST_NOT)

Constructs a BooleanClause with query q, required r and prohibited p.