public class

QueryWrapperFilter

extends Filter
java.lang.Object
   ↳ org.apache.lucene.search.Filter
     ↳ org.apache.lucene.search.QueryWrapperFilter

Class Overview

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

This could be used, for example, with a TermRangeQuery 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 TermRangeQuery would only need to be reconstructed once per day.

Summary

Public Constructors
QueryWrapperFilter(Query query)
Constructs a filter which only matches documents matching query.
Public Methods
boolean equals(Object o)
DocIdSet getDocIdSet(IndexReader reader)
Creates a DocIdSet enumerating the documents that should be permitted in search results.
int hashCode()
String toString()
[Expand]
Inherited Methods
From class org.apache.lucene.search.Filter
From class java.lang.Object

Public Constructors

public QueryWrapperFilter (Query query)

Constructs a filter which only matches documents matching query.

Public Methods

public boolean equals (Object o)

public DocIdSet getDocIdSet (IndexReader reader)

Creates a DocIdSet enumerating the documents that should be permitted in search results. NOTE: null can be returned if no documents are accepted by this Filter.

Note: This method will be called once per segment in the index during searching. The returned DocIdSet must refer to document IDs for that segment, not for the top-level reader.

Parameters
reader a IndexReader instance opened on the index currently searched on. Note, it is likely that the provided reader does not represent the whole underlying index i.e. if the index has more than one segment the given reader only represents a single segment.
Returns
  • a DocIdSet that provides the documents which should be permitted or prohibited in search results. NOTE: null can be returned if no documents will be accepted by this Filter.
Throws
IOException

public int hashCode ()

public String toString ()