org.sindice.siren.search.node

Class NodeBooleanQuery

java.lang.Object

org.apache.lucene.search.Query

org.sindice.siren.search.node.NodeQuery

org.sindice.siren.search.node.NodeBooleanQuery

All Implemented Interfaces:

Cloneable

public class NodeBooleanQuery
extends NodeQuery

A NodeQuery that matches a boolean combination of primitive queries, e.g., NodeTermQuerys, NodePhraseQuerys, NodeBooleanQuerys, ...

Code taken from BooleanQuery and adapted for the Siren use case.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	NodeBooleanQuery.NodeBooleanWeight Expert: the Weight for NodeBooleanQuery, used to normalize, score and explain these queries.
static class	NodeBooleanQuery.TooManyClauses Thrown when an attempt is made to add more than getMaxClauseCount() clauses.

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<NodeBooleanClause>	clauses

Fields inherited from class org.sindice.siren.search.node.NodeQuery

ancestor, levelConstraint, lowerBound, upperBound

Constructor Summary

Constructors

Constructor and Description
NodeBooleanQuery() Constructs an empty boolean query.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(NodeBooleanClause clause) Adds a clause to a boolean query.
void	add(NodeQuery query, NodeBooleanClause.Occur occur) Adds a clause to a boolean query.
List<NodeBooleanClause>	clauses() Returns the list of clauses in this query.
org.apache.lucene.search.Query	clone()
org.apache.lucene.search.Weight	createWeight(org.apache.lucene.search.IndexSearcher searcher)
boolean	equals(Object o) Returns true iff o is equal to this.
void	extractTerms(Set<org.apache.lucene.index.Term> terms)
NodeBooleanClause[]	getClauses() Returns the set of clauses in this query.
static int	getMaxClauseCount() Return the maximum number of clauses permitted, 1024 by default.
int	hashCode() Returns a hash code value for this object.
Iterator<NodeBooleanClause>	iterator() Returns an iterator on the clauses in this query.
org.apache.lucene.search.Query	rewrite(org.apache.lucene.index.IndexReader reader)
protected void	setAncestorPointer(NodeQuery ancestor) Expert: Add a pointer to the node query ancestor
void	setLevelConstraint(int levelConstraint) Set a constraint on the node's level
static void	setMaxClauseCount(int maxClauseCount) Set the maximum number of clauses permitted per BooleanQuery.
void	setNodeConstraint(int lowerBound, int upperBound) Set an index interval constraint for a node.
String	toString(String field) Prints a user-readable version of this query.

Methods inherited from class org.sindice.siren.search.node.NodeQuery

getDocsNodesAndPositionsEnum, getLevelConstraint, getNodeConstraint, setNodeConstraint

Methods inherited from class org.apache.lucene.search.Query

getBoost, setBoost, toString

Methods inherited from class java.lang.Object

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

Field Detail

clauses

protected ArrayList<NodeBooleanClause> clauses

Constructor Detail

NodeBooleanQuery

public NodeBooleanQuery()

Constructs an empty boolean query.

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 NodeBooleanQuery.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.

setLevelConstraint

public void setLevelConstraint(int levelConstraint)

Description copied from class: NodeQuery

Set a constraint on the node's level

Given that the root of the tree (level 0) is the document id, the node level constraint ranges from 1 to Integer.MAX_VALUE. A node level constraint of 0 will always return false.

Overrides:

setLevelConstraint in class NodeQuery

setNodeConstraint

public void setNodeConstraint(int lowerBound,
                     int upperBound)

Description copied from class: NodeQuery

Set an index interval constraint for a node. These constraints are inclusives.

Overrides:

setNodeConstraint in class NodeQuery

setAncestorPointer

protected void setAncestorPointer(NodeQuery ancestor)

Description copied from class: NodeQuery

Expert: Add a pointer to the node query ancestor

The pointer to node query ancestor is used to retrieve node constraints from ancestors.

Overrides:

setAncestorPointer in class NodeQuery

add

public void add(NodeQuery query,
       NodeBooleanClause.Occur occur)

Adds a clause to a boolean query.

Throws:

NodeBooleanQuery.TooManyClauses - if the new number of clauses exceeds the maximum clause number

See Also:

getMaxClauseCount()

add

public void add(NodeBooleanClause clause)

Adds a clause to a boolean query.

Throws:

NodeBooleanQuery.TooManyClauses - if the new number of clauses exceeds the maximum clause number

See Also:

getMaxClauseCount()

getClauses

public NodeBooleanClause[] getClauses()

Returns the set of clauses in this query.

clauses

public List<NodeBooleanClause> clauses()

Returns the list of clauses in this query.

iterator

public final Iterator<NodeBooleanClause> iterator()

Returns an iterator on the clauses in this query. It implements the Iterable interface to make it possible to do:

for (SirenBooleanClause clause : booleanQuery) {}

createWeight

public org.apache.lucene.search.Weight createWeight(org.apache.lucene.search.IndexSearcher searcher)
                                             throws IOException

Overrides:

createWeight in class org.apache.lucene.search.Query

Throws:

IOException

rewrite

public org.apache.lucene.search.Query rewrite(org.apache.lucene.index.IndexReader reader)
                                       throws IOException

Overrides:

rewrite in class org.apache.lucene.search.Query

Throws:

IOException

extractTerms

public void extractTerms(Set<org.apache.lucene.index.Term> terms)

Overrides:

extractTerms in class org.apache.lucene.search.Query

clone

public org.apache.lucene.search.Query clone()

Overrides:

clone in class org.apache.lucene.search.Query

toString

public String toString(String field)

Prints a user-readable version of this query.

Specified by:

toString in class org.apache.lucene.search.Query

equals

public boolean equals(Object o)

Returns true iff o is equal to this.

Overrides:

equals in class org.apache.lucene.search.Query

hashCode

public int hashCode()

Returns a hash code value for this object.

Overrides:

hashCode in class org.apache.lucene.search.Query