org.apache.lucene.search

Class QueryFilter

java.lang.Object

org.apache.lucene.search.Filter

org.apache.lucene.search.QueryFilter

All Implemented Interfaces:

Serializable

public class QueryFilter
extends Filter

Constrains search results to only match those which also match a provided query. Results are cached, so that searches after the first on the same index using this filter are much faster.

This could be used, for example, with a RangeQuery on a suitably formatted date field to implement date filtering. One could re-use a single QueryFilter that matches, e.g., only documents modified within the last week. The QueryFilter and RangeQuery would only need to be reconstructed once per day.

Version:

$Id: QueryFilter.java 328729 2005-10-26 21:05:35Z yonik $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
QueryFilter(Query query) Constructs a filter which only matches documents matching query.

Method Summary

Methods

Modifier and Type	Method and Description
BitSet	bits(IndexReader reader) Returns a BitSet with true for documents which should be permitted in search results, and false for those that should not.
boolean	equals(Object o)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryFilter

public QueryFilter(Query query)

Constructs a filter which only matches documents matching query.

Method Detail

bits

public BitSet bits(IndexReader reader)
            throws IOException

Description copied from class: Filter

Returns a BitSet with true for documents which should be permitted in search results, and false for those that should not.

Specified by:

bits in class Filter

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object