org.apache.lucene.analysis.ngram
Class NGramTokenFilter
java.lang.Object
org.apache.lucene.util.AttributeSource
org.apache.lucene.analysis.TokenStream
org.apache.lucene.analysis.TokenFilter
org.apache.lucene.analysis.ngram.NGramTokenFilter
- All Implemented Interfaces:
- Closeable
public final class NGramTokenFilter
- extends TokenFilter
Tokenizes the input into n-grams of the given size(s).
Method Summary |
boolean |
incrementToken()
Returns the next token in the stream, or null at EOS. |
void |
reset()
Reset the filter as well as the input TokenStream. |
Methods inherited from class org.apache.lucene.util.AttributeSource |
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, restoreState, toString |
DEFAULT_MIN_NGRAM_SIZE
public static final int DEFAULT_MIN_NGRAM_SIZE
- See Also:
- Constant Field Values
DEFAULT_MAX_NGRAM_SIZE
public static final int DEFAULT_MAX_NGRAM_SIZE
- See Also:
- Constant Field Values
NGramTokenFilter
public NGramTokenFilter(TokenStream input,
int minGram,
int maxGram)
- Creates NGramTokenFilter with given min and max n-grams.
- Parameters:
input
- TokenStream
holding the input to be tokenizedminGram
- the smallest n-gram to generatemaxGram
- the largest n-gram to generate
NGramTokenFilter
public NGramTokenFilter(TokenStream input)
- Creates NGramTokenFilter with default min and max n-grams.
- Parameters:
input
- TokenStream
holding the input to be tokenized
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
- Reset the filter as well as the input TokenStream.
- Overrides:
reset
in class TokenFilter
- Throws:
IOException
Copyright © 2000-2010 Apache Software Foundation. All Rights Reserved.