Lucene.Net.Search.QueryWrapperFilter Class Reference

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

Inherits Lucene.Net.Search.Filter.

Public Member Functions
	QueryWrapperFilter (Query query)
	Constructs a filter which only matches documents matching query.
override DocIdSet	GetDocIdSet (IndexReader reader)
override System.String	ToString ()
override bool	Equals (System.Object o)
override int	GetHashCode ()

Detailed Description

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.

<version> $Id:$ </version>

Definition at line 38 of file QueryWrapperFilter.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.QueryWrapperFilter.QueryWrapperFilter

(

Query

query

)

Constructs a filter which only matches documents matching query.

Definition at line 78 of file QueryWrapperFilter.cs.

Member Function Documentation

override bool Lucene.Net.Search.QueryWrapperFilter.Equals

(

System.Object

o

)

Definition at line 94 of file QueryWrapperFilter.cs.

override DocIdSet Lucene.Net.Search.QueryWrapperFilter.GetDocIdSet ( IndexReader  reader )

virtual

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.

/summary>

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.

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.

See Also

DocIdBitSet

Implements Lucene.Net.Search.Filter.

Definition at line 83 of file QueryWrapperFilter.cs.

override int Lucene.Net.Search.QueryWrapperFilter.GetHashCode

(

)

Definition at line 101 of file QueryWrapperFilter.cs.

override System.String Lucene.Net.Search.QueryWrapperFilter.ToString

(

)

Definition at line 89 of file QueryWrapperFilter.cs.

---

The documentation for this class was generated from the following file:

• core/Search/QueryWrapperFilter.cs