org.apache.lucene.search

Class QueryWrapperFilter

java.lang.Object

org.apache.lucene.search.Filter

org.apache.lucene.search.QueryWrapperFilter

All Implemented Interfaces:

java.io.Serializable

public class QueryWrapperFilter
extends Filter

Constrains search results to only match those which also match a provided query.

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:$

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.util.BitSet	bits(IndexReader reader) Deprecated. Use getDocIdSet(IndexReader) instead.
boolean	equals(java.lang.Object o)
DocIdSet	getDocIdSet(IndexReader reader)
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryWrapperFilter

public QueryWrapperFilter(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

Deprecated. Use getDocIdSet(IndexReader) instead.

Overrides:

bits in class Filter

Returns:

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

Throws:

java.io.IOException

getDocIdSet

public DocIdSet getDocIdSet(IndexReader reader)
                     throws java.io.IOException

Overrides:

getDocIdSet in class Filter

Returns:

a DocIdSet that provides the documents which should be permitted or prohibited in search results.

Throws:

java.io.IOException

See Also:

DocIdBitSet

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object