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.
Main Page
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Properties
Pages
core
Search
SpanFilter.cs
Go to the documentation of this file.
1
/*
2
* Licensed to the Apache Software Foundation (ASF) under one or more
3
* contributor license agreements. See the NOTICE file distributed with
4
* this work for additional information regarding copyright ownership.
5
* The ASF licenses this file to You under the Apache License, Version 2.0
6
* (the "License"); you may not use this file except in compliance with
7
* the License. You may obtain a copy of the License at
8
*
9
* http://www.apache.org/licenses/LICENSE-2.0
10
*
11
* Unless required by applicable law or agreed to in writing, software
12
* distributed under the License is distributed on an "AS IS" BASIS,
13
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
* See the License for the specific language governing permissions and
15
* limitations under the License.
16
*/
17
18
using
System;
19
20
using
IndexReader
= Lucene.Net.Index.IndexReader;
21
22
namespace
Lucene.Net.Search
23
{
24
25
/// <summary>Abstract base class providing a mechanism to restrict searches to a subset
26
/// of an index and also maintains and returns position information.
27
/// This is useful if you want to compare the positions from a SpanQuery with the positions of items in
28
/// a filter. For instance, if you had a SpanFilter that marked all the occurrences of the word "foo" in documents,
29
/// and then you entered a new SpanQuery containing bar, you could not only filter by the word foo, but you could
30
/// then compare position information for post processing.
31
/// </summary>
32
[Serializable]
33
public
abstract
class
SpanFilter
:
Filter
34
{
35
/// <summary>Returns a SpanFilterResult with true for documents which should be permitted in
36
/// search results, and false for those that should not and Spans for where the true docs match.
37
/// </summary>
38
/// <param name="reader">The <see cref="Lucene.Net.Index.IndexReader" /> to load position and DocIdSet information from
39
/// </param>
40
/// <returns> A <see cref="SpanFilterResult" />
41
/// </returns>
42
/// <throws> java.io.IOException if there was an issue accessing the necessary information </throws>
43
/// <summary>
44
/// </summary>
45
public
abstract
SpanFilterResult
BitSpans(
IndexReader
reader);
46
}
47
}
Generated on Thu Jan 3 2013 02:34:13 for Lucene.Net by
1.8.3