org.apache.lucene.search
Class QueryFilter

java.lang.Object
  extended by org.apache.lucene.search.Filter
      extended by org.apache.lucene.search.QueryFilter
All Implemented Interfaces:
java.io.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,v 1.6 2004/05/08 19:54:12 ehatcher Exp $
See Also:
Serialized Form

Constructor Summary
QueryFilter(Query query)
          Constructs a filter which only matches documents matching query.
 
Method Summary
 java.util.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.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, 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 java.util.BitSet bits(IndexReader reader)
                      throws java.io.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:
java.io.IOException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


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