org.apache.lucene.search
Class BooleanClause

java.lang.Object
  extended by org.apache.lucene.search.BooleanClause
All Implemented Interfaces:
Serializable

public class BooleanClause
extends Object
implements Serializable

A clause in a BooleanQuery.

See Also:
Serialized Form

Nested Class Summary
static class BooleanClause.Occur
          Specifies how terms may occur in matching documents.
 
Field Summary
 boolean prohibited
          Deprecated. use setOccur(BooleanClause.Occur) instead
 Query query
          Deprecated. use setQuery(Query) instead
 boolean required
          Deprecated. use setOccur(BooleanClause.Occur) instead
 
Constructor Summary
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)
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()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

query

public Query query
Deprecated. use setQuery(Query) instead
The query whose matching documents are combined by the boolean query.


required

public boolean required
Deprecated. use setOccur(BooleanClause.Occur) instead
If true, documents documents which do not match this sub-query will not match the boolean query.


prohibited

public boolean prohibited
Deprecated. use setOccur(BooleanClause.Occur) instead
If true, documents documents which do match this sub-query will not match the boolean query.

Constructor Detail

BooleanClause

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.


BooleanClause

public BooleanClause(Query query,
                     BooleanClause.Occur occur)
Constructs a BooleanClause.

Method Detail

getOccur

public BooleanClause.Occur getOccur()

setOccur

public void setOccur(BooleanClause.Occur occur)

getQuery

public Query getQuery()

setQuery

public void setQuery(Query query)

isProhibited

public boolean isProhibited()

isRequired

public boolean isRequired()

equals

public boolean equals(Object o)
Returns true iff o is equal to this.

Overrides:
equals in class Object

hashCode

public int hashCode()
Returns a hash code value for this object.

Overrides:
hashCode in class Object

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.