Lucene.Net
3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
|
The positionIncrement determines the position of this token relative to the previous Token in a TokenStream, used in phrase searching. More...
Inherits Attribute, Lucene.Net.Analysis.Tokenattributes.IPositionIncrementAttribute, and ICloneable.
Public Member Functions | |
override void | Clear () |
override bool | Equals (System.Object other) |
override int | GetHashCode () |
override void | CopyTo (Attribute target) |
override System.Object | Clone () |
Properties | |
virtual int | PositionIncrement [get, set] |
Set the position increment. The default value is one. | |
Properties inherited from Lucene.Net.Analysis.Tokenattributes.IPositionIncrementAttribute | |
int | PositionIncrement [get, set] |
Gets or sets the position increment. The default value is one. | |
The positionIncrement determines the position of this token relative to the previous Token in a TokenStream, used in phrase searching.
The default value is one.
Some common uses for this are:
Set it to zero to put multiple terms in the same position. This is useful if, e.g., a word has multiple stems. Searches for phrases including either stem will match. In this case, all but the first stem's increment should be set to zero: the increment of the first instance should be one. Repeating a token with an increment of zero can also be used to boost the scores of matches on that token.
Set it to values greater than one to inhibit exact phrase matches. If, for example, one does not want phrases to match across removed stop words, then one could build a stop word filter that removes stop words and also sets the increment to the number of stop words removed before each non-stop word. Then exact phrase queries will only match when the terms occur with no intervening stop words.
Definition at line 50 of file PositionIncrementAttribute.cs.
override void Lucene.Net.Analysis.Tokenattributes.PositionIncrementAttribute.Clear | ( | ) |
Definition at line 69 of file PositionIncrementAttribute.cs.
override System.Object Lucene.Net.Analysis.Tokenattributes.PositionIncrementAttribute.Clone | ( | ) |
Definition at line 100 of file PositionIncrementAttribute.cs.
override void Lucene.Net.Analysis.Tokenattributes.PositionIncrementAttribute.CopyTo | ( | Attribute | target | ) |
Definition at line 94 of file PositionIncrementAttribute.cs.
override bool Lucene.Net.Analysis.Tokenattributes.PositionIncrementAttribute.Equals | ( | System.Object | other | ) |
Definition at line 74 of file PositionIncrementAttribute.cs.
override int Lucene.Net.Analysis.Tokenattributes.PositionIncrementAttribute.GetHashCode | ( | ) |
Definition at line 89 of file PositionIncrementAttribute.cs.
|
getset |
Set the position increment. The default value is one.
the distance from the prior term
Definition at line 59 of file PositionIncrementAttribute.cs.