Save This Page
Home » lucene-3.0.1-src » org.apache.lucene.analysis.tokenattributes » [javadoc | source]
org.apache.lucene.analysis.tokenattributes
public interface: PositionIncrementAttribute [javadoc | source]

All Implemented Interfaces:
    Attribute

All Known Implementing Classes:
    Token, PositionIncrementAttributeImpl

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:

Method from org.apache.lucene.analysis.tokenattributes.PositionIncrementAttribute Summary:
getPositionIncrement,   setPositionIncrement
Method from org.apache.lucene.analysis.tokenattributes.PositionIncrementAttribute Detail:
 public int getPositionIncrement()
    Returns the position increment of this Token.
 public  void setPositionIncrement(int positionIncrement)
    Set the position increment. The default value is one.