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
SpanFilterResult.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 using System.Collections.Generic;
20 
21 namespace Lucene.Net.Search
22 {
23  /// <summary> The results of a SpanQueryFilter. Wraps the BitSet and the position information from the SpanQuery
24  ///
25  /// <p/>
26  /// NOTE: This API is still experimental and subject to change.
27  /// </summary>
28  public class SpanFilterResult
29  {
30  private DocIdSet docIdSet;
31  private IList<PositionInfo> positions; //Spans spans;
32 
33  /// <summary> </summary>
34  /// <param name="docIdSet">The DocIdSet for the Filter
35  /// </param>
36  /// <param name="positions">A List of <see cref="Lucene.Net.Search.SpanFilterResult.PositionInfo" /> objects
37  /// </param>
38  public SpanFilterResult(DocIdSet docIdSet, IList<PositionInfo> positions)
39  {
40  this.docIdSet = docIdSet;
41  this.positions = positions;
42  }
43 
44  /// <summary> The first entry in the array corresponds to the first "on" bit.
45  /// Entries are increasing by document order
46  /// </summary>
47  /// <value> A List of PositionInfo objects </value>
48  public virtual IList<PositionInfo> Positions
49  {
50  get { return positions; }
51  }
52 
53  /// <summary>Returns the docIdSet </summary>
54  public virtual DocIdSet DocIdSet
55  {
56  get { return docIdSet; }
57  }
58 
59  public class PositionInfo
60  {
61  private int doc;
62  private IList<StartEnd> positions;
63 
64 
65  public PositionInfo(int doc)
66  {
67  this.doc = doc;
68  positions = new List<StartEnd>();
69  }
70 
71  public virtual void AddPosition(int start, int end)
72  {
73  positions.Add(new StartEnd(start, end));
74  }
75 
76  public virtual int Doc
77  {
78  get { return doc; }
79  }
80 
81  /// <summary> </summary>
82  /// <value> A List of &lt;see cref=&quot;Lucene.Net.Search.SpanFilterResult.StartEnd&quot; /&gt; objects </value>
83  public virtual IList<StartEnd> Positions
84  {
85  get { return positions; }
86  }
87  }
88 
89  public class StartEnd
90  {
91  private int start;
92  private int end;
93 
94 
95  public StartEnd(int start, int end)
96  {
97  this.start = start;
98  this.end = end;
99  }
100 
101  /// <summary> </summary>
102  /// <value> The end position of this match </value>
103  public virtual int End
104  {
105  get { return end; }
106  }
107 
108  /// <summary> The Start position</summary>
109  /// <value> The start position of this match </value>
110  public virtual int Start
111  {
112  get { return start; }
113  }
114  }
115  }
116 }