Module org.apache.lucene.monitor

Package org.apache.lucene.monitor

Class SuffixingNGramTokenFilter

java.lang.Object

org.apache.lucene.util.AttributeSource

org.apache.lucene.analysis.TokenStream

org.apache.lucene.analysis.TokenFilter

org.apache.lucene.monitor.SuffixingNGramTokenFilter

All Implemented Interfaces:

Closeable, AutoCloseable, Unwrappable<TokenStream>

final class SuffixingNGramTokenFilter
extends TokenFilter

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource

AttributeSource.State

Field Summary

Fields

Modifier and Type	Field	Description
private final String	anyToken
private int	curCodePointCount
private int	curGramSize
private int	curPos
private int	curPosInc
private int	curPosLen
private char[]	curTermBuffer
private int	curTermLength
private final KeywordAttribute	keywordAtt
private final int	maxTokenLength
private final OffsetAttribute	offsetAtt
private final PositionIncrementAttribute	posIncAtt
private final PositionLengthAttribute	posLenAtt
private final CharArraySet	seenInfixes
private final CharArraySet	seenSuffixes
private final String	suffix
private final CharTermAttribute	termAtt
private int	tokEnd
private int	tokStart

Fields inherited from class org.apache.lucene.analysis.TokenFilter

input

Fields inherited from class org.apache.lucene.analysis.TokenStream

DEFAULT_TOKEN_ATTRIBUTE_FACTORY

Constructor Summary

Constructors

Constructor	Description
SuffixingNGramTokenFilter(TokenStream input, String suffix, String wildcardToken, int maxTokenLength)	Creates SuffixingNGramTokenFilter.

Method Summary

Modifier and Type	Method	Description
final boolean	incrementToken()	Returns the next token in the stream, or null at EOS.
void	reset()	This method is called by a consumer before it begins consumption using TokenStream.incrementToken().

Methods inherited from class org.apache.lucene.analysis.TokenFilter

close, end, unwrap

Methods inherited from class org.apache.lucene.util.AttributeSource

addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

suffix

private final String suffix

maxTokenLength

private final int maxTokenLength

anyToken

private final String anyToken

curTermBuffer

private char[] curTermBuffer

curTermLength

private int curTermLength

curCodePointCount

private int curCodePointCount

curGramSize

private int curGramSize

curPos

private int curPos

curPosInc

private int curPosInc

curPosLen

private int curPosLen

tokStart

private int tokStart

tokEnd

private int tokEnd

termAtt

private final CharTermAttribute termAtt

posIncAtt

private final PositionIncrementAttribute posIncAtt

posLenAtt

private final PositionLengthAttribute posLenAtt

offsetAtt

private final OffsetAttribute offsetAtt

keywordAtt

private final KeywordAttribute keywordAtt

seenSuffixes

private final CharArraySet seenSuffixes

seenInfixes

private final CharArraySet seenInfixes

Constructor Details

SuffixingNGramTokenFilter

public SuffixingNGramTokenFilter(TokenStream input,
 String suffix,
 String wildcardToken,
 int maxTokenLength)

Creates SuffixingNGramTokenFilter.

Parameters:

input - TokenStream holding the input to be tokenized

suffix - a string to suffix to all ngrams

wildcardToken - a token to emit if the input token is longer than maxTokenLength

maxTokenLength - tokens longer than this will not be ngrammed

Method Details

incrementToken

public final boolean incrementToken()
                             throws IOException

Returns the next token in the stream, or null at EOS.

Specified by:

incrementToken in class TokenStream

Returns:

false for end of stream; true otherwise

Throws:

IOException

reset

public void reset()
           throws IOException

Description copied from class: TokenFilter

This method is called by a consumer before it begins consumption using TokenStream.incrementToken().

Resets this stream to a clean state. Stateful implementations must implement this method so that they can be reused, just as if they had been created fresh.

If you override this method, always call super.reset(), otherwise some internal state will not be correctly reset (e.g., Tokenizer will throw IllegalStateException on further usage).

NOTE: The default implementation chains the call to the input TokenStream, so be sure to call super.reset() when overriding this method.

Overrides:

reset in class TokenFilter

Throws:

IOException