public interface

OffsetAttribute

implements Attribute
org.apache.lucene.analysis.tokenattributes.OffsetAttribute
Known Indirect Subclasses

Class Overview

The start and end character offset of a Token.

Summary

Public Methods
abstract int endOffset()
Returns this Token's ending offset, one greater than the position of the last character corresponding to this token in the source text.
abstract void setOffset(int startOffset, int endOffset)
Set the starting and ending offset.
abstract int startOffset()
Returns this Token's starting offset, the position of the first character corresponding to this token in the source text.

Public Methods

public abstract int endOffset ()

Returns this Token's ending offset, one greater than the position of the last character corresponding to this token in the source text. The length of the token in the source text is (endOffset - startOffset).

public abstract void setOffset (int startOffset, int endOffset)

Set the starting and ending offset.

See Also

public abstract int startOffset ()

Returns this Token's starting offset, the position of the first character corresponding to this token in the source text. Note that the difference between endOffset() and startOffset() may not be equal to termText.length(), as the term text may have been altered by a stemmer or some other filter.