PositionIncrementAttributeImpl

Class Overview

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.

Summary

   public int hashCode() {
     int code = startOffset;
     code = code * 31 + endOffset;
     return code;
   }
 

[Expand] Inherited Methods
From class org.apache.lucene.util.AttributeImpl abstract void clear() Clears the values in this AttributeImpl and resets it to its default value. Object clone() Shallow clone. abstract void copyTo(AttributeImpl target) Copies the values from this Attribute into the passed-in target attribute. abstract boolean equals(Object other) All values used for computation of hashCode() should be checked here for equality. abstract int hashCode() Subclasses must implement this method and should compute a hashCode similar to this: public int hashCode() { int code = startOffset; code = code * 31 + endOffset; return code; } see also equals(Object) String toString() The default implementation of this method accesses all declared fields of this object and prints the values in the following syntax: public String toString() { return "start=" + startOffset + ",end=" + endOffset; } This method may be overridden by subclasses.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.apache.lucene.analysis.tokenattributes.PositionIncrementAttribute abstract int getPositionIncrement() Returns the position increment of this Token. abstract void setPositionIncrement(int positionIncrement) Set the position increment.