org.apache.lucene.search

Class BooleanClause

java.lang.Object

org.apache.lucene.search.BooleanClause

public final class BooleanClause
extends java.lang.Object

A clause in a BooleanQuery.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BooleanClause.Occur Specifies how clauses are to occur in matching documents.

Field Summary

Fields

Modifier and Type	Field and Description
private BooleanClause.Occur	occur
private Query	query The query whose matching documents are combined by the boolean query.

Constructor Summary

Constructors

Constructor and Description
BooleanClause(Query query, BooleanClause.Occur occur) Constructs a BooleanClause.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Returns true if o is equal to this.
BooleanClause.Occur	getOccur()
Query	getQuery()
int	hashCode() Returns a hash code value for this object.
boolean	isProhibited()
boolean	isRequired()
boolean	isScoring()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

query

private final Query query

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

occur

private final BooleanClause.Occur occur

Constructor Detail

BooleanClause

public BooleanClause(Query query,
                     BooleanClause.Occur occur)

Constructs a BooleanClause.

Method Detail

getOccur

public BooleanClause.Occur getOccur()

getQuery

public Query getQuery()

isProhibited

public boolean isProhibited()

isRequired

public boolean isRequired()

isScoring

public boolean isScoring()

equals

public boolean equals(java.lang.Object o)

Returns true if o is equal to this.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Returns a hash code value for this object.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object