org.apache.lucene.analysis.ngram
Class NGramTokenFilter
java.lang.Object
org.apache.lucene.analysis.TokenStream
org.apache.lucene.analysis.TokenFilter
org.apache.lucene.analysis.ngram.NGramTokenFilter
public class NGramTokenFilter
- extends TokenFilter
Tokenizes the input into n-grams of the given size(s).
Method Summary |
Token |
next(Token reusableToken)
Returns the next token in the stream, or null at EOS. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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
next
public final Token next(Token reusableToken)
throws java.io.IOException
- Returns the next token in the stream, or null at EOS.
- Overrides:
next
in class TokenStream
- Parameters:
reusableToken
- a Token that may or may not be used to
return; this parameter should never be null (the callee
is not required to check for null before using it, but it is a
good idea to assert that it is not null.)
- Returns:
- next token in the stream or null if end-of-stream was hit
- Throws:
java.io.IOException
Copyright © 2000-2010 Apache Software Foundation. All Rights Reserved.