Class PositionIncrementAttribute

Default implementation of IPositionIncrementAttribute.

Inheritance
object
Attribute
PositionIncrementAttribute
Inherited Members
Namespace: Lucene.Net.Analysis.TokenAttributes
Assembly: Lucene.Net.dll
Syntax
public class PositionIncrementAttribute : Attribute, IPositionIncrementAttribute, IAttribute

Constructors

PositionIncrementAttribute()

Initialize this attribute with position increment of 1

Declaration
public PositionIncrementAttribute()

Properties

PositionIncrement

Gets or Sets the position increment (the distance from the prior term). The default value is one.

Declaration
public virtual int PositionIncrement { get; set; }
Property Value
Type Description
int
Exceptions
Type Condition
ArgumentException

if value is set to a negative value.

Methods

Clear()

Clears the values in this Attribute and resets it to its default value. If this implementation implements more than one Attribute interface it clears all.

Declaration
public override void Clear()
Overrides

CopyTo(IAttribute)

Copies the values from this Attribute into the passed-in target attribute. The target implementation must support all the IAttributes this implementation supports.

Declaration
public override void CopyTo(IAttribute target)
Parameters
Type Name Description
IAttribute target
Overrides

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
object other
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
Overrides

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides

Implements