Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | List of all members
Lucene.Net.Search.SpanFilter Class Referenceabstract

Abstract base class providing a mechanism to restrict searches to a subset of an index and also maintains and returns position information. This is useful if you want to compare the positions from a SpanQuery with the positions of items in a filter. For instance, if you had a SpanFilter that marked all the occurrences of the word "foo" in documents, and then you entered a new SpanQuery containing bar, you could not only filter by the word foo, but you could then compare position information for post processing. More...

Inherits Lucene.Net.Search.Filter.

Inherited by Lucene.Net.Search.CachingSpanFilter, and Lucene.Net.Search.SpanQueryFilter.

Public Member Functions

abstract SpanFilterResult BitSpans (IndexReader reader)
 Returns a SpanFilterResult with true for documents which should be permitted in search results, and false for those that should not and Spans for where the true docs match.
 
- Public Member Functions inherited from Lucene.Net.Search.Filter
abstract DocIdSet GetDocIdSet (IndexReader reader)
 
 

Detailed Description

Abstract base class providing a mechanism to restrict searches to a subset of an index and also maintains and returns position information. This is useful if you want to compare the positions from a SpanQuery with the positions of items in a filter. For instance, if you had a SpanFilter that marked all the occurrences of the word "foo" in documents, and then you entered a new SpanQuery containing bar, you could not only filter by the word foo, but you could then compare position information for post processing.

Definition at line 33 of file SpanFilter.cs.

Member Function Documentation

abstract SpanFilterResult Lucene.Net.Search.SpanFilter.BitSpans ( IndexReader  reader)
pure virtual

Returns a SpanFilterResult with true for documents which should be permitted in search results, and false for those that should not and Spans for where the true docs match.

Parameters
readerThe Lucene.Net.Index.IndexReader to load position and DocIdSet information from
Returns
A SpanFilterResult

<throws> java.io.IOException if there was an issue accessing the necessary information </throws>

Implemented in Lucene.Net.Search.CachingSpanFilter, and Lucene.Net.Search.SpanQueryFilter.


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