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
IPositionIncrementAttribute.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 Lucene.Net.Util;
20 
21 namespace Lucene.Net.Analysis.Tokenattributes
22 {
23 
24  /// <summary>The positionIncrement determines the position of this token
25  /// relative to the previous Token in a TokenStream, used in phrase
26  /// searching.
27  ///
28  /// <p/>The default value is one.
29  ///
30  /// <p/>Some common uses for this are:<list>
31  ///
32  /// <item>Set it to zero to put multiple terms in the same position. This is
33  /// useful if, e.g., a word has multiple stems. Searches for phrases
34  /// including either stem will match. In this case, all but the first stem's
35  /// increment should be set to zero: the increment of the first instance
36  /// should be one. Repeating a token with an increment of zero can also be
37  /// used to boost the scores of matches on that token.</item>
38  ///
39  /// <item>Set it to values greater than one to inhibit exact phrase matches.
40  /// If, for example, one does not want phrases to match across removed stop
41  /// words, then one could build a stop word filter that removes stop words and
42  /// also sets the increment to the number of stop words removed before each
43  /// non-stop word. Then exact phrase queries will only match when the terms
44  /// occur with no intervening stop words.</item>
45  ///
46  /// </list>
47  ///
48  /// </summary>
49  /// <seealso cref="Lucene.Net.Index.TermPositions">
50  /// </seealso>
52  {
53  /// <summary>Gets or sets the position increment. The default value is one.
54  ///
55  /// </summary>
56  /// <value> the distance from the prior term </value>
57  int PositionIncrement { set; get; }
58  }
59 }