org.apache.lucene.analysis.ngram
Class EdgeNGramTokenFilter
java.lang.Object
org.apache.lucene.util.AttributeSource
org.apache.lucene.analysis.TokenStream
org.apache.lucene.analysis.TokenFilter
org.apache.lucene.analysis.ngram.EdgeNGramTokenFilter
- All Implemented Interfaces:
- Closeable
public final class EdgeNGramTokenFilter
- extends org.apache.lucene.analysis.TokenFilter
Tokenizes the given token into n-grams of given size(s).
This TokenFilter create n-grams from the beginning edge or ending edge of a input token.
|
Nested Class Summary |
static class |
EdgeNGramTokenFilter.Side
Specifies which side of the input the n-gram should be generated from |
| 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 |
EdgeNGramTokenFilter(org.apache.lucene.analysis.TokenStream input,
EdgeNGramTokenFilter.Side side,
int minGram,
int maxGram)
Creates EdgeNGramTokenFilter that can generate n-grams in the sizes of the given range |
EdgeNGramTokenFilter(org.apache.lucene.analysis.TokenStream input,
String sideLabel,
int minGram,
int maxGram)
Creates EdgeNGramTokenFilter that can generate n-grams in the sizes of the given range |
| Methods inherited from class org.apache.lucene.analysis.TokenFilter |
close, end |
| Methods inherited from class org.apache.lucene.util.AttributeSource |
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString |
DEFAULT_SIDE
public static final EdgeNGramTokenFilter.Side DEFAULT_SIDE
DEFAULT_MAX_GRAM_SIZE
public static final int DEFAULT_MAX_GRAM_SIZE
- See Also:
- Constant Field Values
DEFAULT_MIN_GRAM_SIZE
public static final int DEFAULT_MIN_GRAM_SIZE
- See Also:
- Constant Field Values
EdgeNGramTokenFilter
public EdgeNGramTokenFilter(org.apache.lucene.analysis.TokenStream input,
EdgeNGramTokenFilter.Side side,
int minGram,
int maxGram)
- Creates EdgeNGramTokenFilter that can generate n-grams in the sizes of the given range
- Parameters:
input - TokenStream holding the input to be tokenizedside - the EdgeNGramTokenFilter.Side from which to chop off an n-gramminGram - the smallest n-gram to generatemaxGram - the largest n-gram to generate
EdgeNGramTokenFilter
public EdgeNGramTokenFilter(org.apache.lucene.analysis.TokenStream input,
String sideLabel,
int minGram,
int maxGram)
- Creates EdgeNGramTokenFilter that can generate n-grams in the sizes of the given range
- Parameters:
input - TokenStream holding the input to be tokenizedsideLabel - the name of the EdgeNGramTokenFilter.Side from which to chop off an n-gramminGram - the smallest n-gram to generatemaxGram - the largest n-gram to generate
incrementToken
public final boolean incrementToken()
throws IOException
- Specified by:
incrementToken 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