Abstract base class for restricting which documents may be returned during searching. More...

Public Member Functions
abstract DocIdSet	GetDocIdSet (IndexReader reader)

Detailed Description

Abstract base class for restricting which documents may be returned during searching.

Definition at line 28 of file Filter.cs.

Member Function Documentation

abstract DocIdSet Lucene.Net.Search.Filter.GetDocIdSet ( IndexReader reader )

pure 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

Implemented in Lucene.Net.Search.FieldCacheRangeFilter< T >, Lucene.Net.Search.CachingWrapperFilter, Lucene.Net.Search.FieldCacheTermsFilter, Lucene.Net.Search.MultiTermQueryWrapperFilter< T >, Lucene.Net.Analysis.ChainedFilter, Lucene.Net.Search.QueryWrapperFilter, Lucene.Net.Search.CachingSpanFilter, Lucene.Net.Search.DuplicateFilter, Lucene.Net.Search.BooleanFilter, Lucene.Net.Search.SpanQueryFilter, Lucene.Net.Search.TermsFilter, and Lucene.Net.Spatial.Util.TermsFilter.

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

core/Search/Filter.cs

Public Member Functions

Detailed Description

Member Function Documentation