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
TermPositionVector.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 namespace Lucene.Net.Index
21 {
22 
23  /// <summary>Extends <c>TermFreqVector</c> to provide additional information about
24  /// positions in which each of the terms is found. A TermPositionVector not necessarily
25  /// contains both positions and offsets, but at least one of these arrays exists.
26  /// </summary>
28  {
29 
30  /// <summary>Returns an array of positions in which the term is found.
31  /// Terms are identified by the index at which its number appears in the
32  /// term String array obtained from the <c>indexOf</c> method.
33  /// May return null if positions have not been stored.
34  /// </summary>
35  int[] GetTermPositions(int index);
36 
37  /// <summary> Returns an array of TermVectorOffsetInfo in which the term is found.
38  /// May return null if offsets have not been stored.
39  ///
40  /// </summary>
41  /// <seealso cref="Lucene.Net.Analysis.Token">
42  ///
43  /// </seealso>
44  /// <param name="index">The position in the array to get the offsets from
45  /// </param>
46  /// <returns> An array of TermVectorOffsetInfo objects or the empty list
47  /// </returns>
48  TermVectorOffsetInfo[] GetOffsets(int index);
49  }
50 }