Lucene.Net
3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
|
Abstract base class for restricting which documents may be returned during searching. More...
Inherited by Lucene.Net.Analysis.ChainedFilter, Lucene.Net.Search.BooleanFilter, Lucene.Net.Search.CachingWrapperFilter, Lucene.Net.Search.DuplicateFilter, Lucene.Net.Search.FieldCacheRangeFilter< T >, Lucene.Net.Search.FieldCacheTermsFilter, Lucene.Net.Search.MultiTermQueryWrapperFilter< T >, Lucene.Net.Search.QueryWrapperFilter, Lucene.Net.Search.SpanFilter, Lucene.Net.Search.TermsFilter, Lucene.Net.Spatial.Prefix.RecursivePrefixTreeFilter, Lucene.Net.Spatial.Util.TermsFilter, and Lucene.Net.Spatial.Util.ValueSourceFilter.
Public Member Functions | |
abstract DocIdSet | GetDocIdSet (IndexReader reader) |
| |
Abstract base class for restricting which documents may be returned during searching.
|
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>
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. |
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.