public class

FilteredQuery

extends Query
java.lang.Object
   ↳ org.apache.lucene.search.Query
     ↳ org.apache.lucene.search.FilteredQuery

Class Overview

A query that applies a filter to the results of another query.

Note: the bits are retrieved from the filter each time this query is used in a search - use a CachingWrapperFilter to avoid regenerating the bits every time.

Created: Apr 20, 2004 8:58:29 AM

See Also

Summary

Public Constructors
FilteredQuery(Query query, Filter filter)
Constructs a new query which applies a filter to the results of the original query.
Public Methods
Weight createWeight(Searcher searcher)
Returns a Weight that applies the filter to the enclosed query's Weight.
boolean equals(Object o)
Returns true iff o is equal to this.
void extractTerms(Set<Term> terms)
Expert: adds all terms occurring in this query to the terms set.
Filter getFilter()
Query getQuery()
int hashCode()
Returns a hash code value for this object.
Query rewrite(IndexReader reader)
Rewrites the wrapped query.
String toString(String s)
Prints a user-readable version of this query.
[Expand]
Inherited Methods
From class org.apache.lucene.search.Query
From class java.lang.Object

Public Constructors

public FilteredQuery (Query query, Filter filter)

Constructs a new query which applies a filter to the results of the original query. Filter.getDocIdSet() will be called every time this query is used in a search.

Parameters
query Query to be filtered, cannot be null.
filter Filter to apply to query results, cannot be null.

Public Methods

public Weight createWeight (Searcher searcher)

Returns a Weight that applies the filter to the enclosed query's Weight. This is accomplished by overriding the Scorer returned by the Weight.

Throws
IOException

public boolean equals (Object o)

Returns true iff o is equal to this.

public void extractTerms (Set<Term> terms)

Expert: adds all terms occurring in this query to the terms set. Only works if this query is in its rewritten form.

public Filter getFilter ()

public Query getQuery ()

public int hashCode ()

Returns a hash code value for this object.

public Query rewrite (IndexReader reader)

Rewrites the wrapped query.

Throws
IOException

public String toString (String s)

Prints a user-readable version of this query.