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
Public Member Functions | Properties | List of all members
Lucene.Net.Analysis.Tokenattributes.PositionIncrementAttribute Class Reference

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.
 

Detailed Description

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:

Definition at line 50 of file PositionIncrementAttribute.cs.

Member Function Documentation

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.

Property Documentation

virtual int Lucene.Net.Analysis.Tokenattributes.PositionIncrementAttribute.PositionIncrement
getset

Set the position increment. The default value is one.

the distance from the prior term

Definition at line 59 of file PositionIncrementAttribute.cs.


The documentation for this class was generated from the following file: