Interface OffsetAttribute
- All Superinterfaces:
Attribute
- All Known Implementing Classes:
OffsetAttributeImpl,PackedTokenAttributeImpl
The start and end character offset of a Token.
-
Method Summary
Modifier and TypeMethodDescriptionintReturns this Token's ending offset, one greater than the position of the last character corresponding to this token in the source text.voidsetOffset(int startOffset, int endOffset) Set the starting and ending offset.intReturns this Token's starting offset, the position of the first character corresponding to this token in the source text.
-
Method Details
-
startOffset
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()andstartOffset()may not be equal to termText.length(), as the term text may have been altered by a stemmer or some other filter.- See Also:
-
setOffset
void setOffset(int startOffset, int endOffset) Set the starting and ending offset.- Throws:
IllegalArgumentException- IfstartOffsetorendOffsetare negative, or ifstartOffsetis greater thanendOffset- See Also:
-
endOffset
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()).- See Also:
-