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
public class NGramTokenFilter
- extends org.apache.lucene.analysis.TokenFilter
Tokenizes the input into n-grams of the given size(s).
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource |
org.apache.lucene.util.AttributeSource.AttributeFactory, org.apache.lucene.util.AttributeSource.State |
Fields inherited from class org.apache.lucene.analysis.TokenFilter |
input |
Constructor Summary |
NGramTokenFilter(org.apache.lucene.analysis.TokenStream input)
Creates NGramTokenFilter with default min and max n-grams. |
NGramTokenFilter(org.apache.lucene.analysis.TokenStream input,
int minGram,
int maxGram)
Creates NGramTokenFilter with given min and max n-grams. |
Method Summary |
boolean |
incrementToken()
Returns the next token in the stream, or null at EOS. |
org.apache.lucene.analysis.Token |
next()
Deprecated. Will be removed in Lucene 3.0. This method is final, as it should
not be overridden. Delegates to the backwards compatibility layer. |
org.apache.lucene.analysis.Token |
next(org.apache.lucene.analysis.Token reusableToken)
Deprecated. Will be removed in Lucene 3.0. This method is final, as it should
not be overridden. Delegates to the backwards compatibility layer. |
void |
reset()
|
Methods inherited from class org.apache.lucene.analysis.TokenFilter |
close, end |
Methods inherited from class org.apache.lucene.analysis.TokenStream |
getOnlyUseNewAPI, setOnlyUseNewAPI |
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(org.apache.lucene.analysis.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(org.apache.lucene.analysis.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.
- Overrides:
incrementToken
in class org.apache.lucene.analysis.TokenStream
- Throws:
IOException
next
public final org.apache.lucene.analysis.Token next(org.apache.lucene.analysis.Token reusableToken)
throws IOException
- Deprecated. Will be removed in Lucene 3.0. This method is final, as it should
not be overridden. Delegates to the backwards compatibility layer.
- Overrides:
next
in class org.apache.lucene.analysis.TokenStream
- Throws:
IOException
next
public final org.apache.lucene.analysis.Token next()
throws IOException
- Deprecated. Will be removed in Lucene 3.0. This method is final, as it should
not be overridden. Delegates to the backwards compatibility layer.
- Overrides:
next
in class org.apache.lucene.analysis.TokenStream
- Throws:
IOException
reset
public void reset()
throws IOException
- Overrides:
reset
in class org.apache.lucene.analysis.TokenFilter
- Throws:
IOException
Copyright © 2000-2010 Apache Software Foundation. All Rights Reserved.