Package 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
,AutoCloseable
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
Nested Classes Modifier and Type Class Description static class
EdgeNGramTokenFilter.Side
Specifies which side of the input the n-gram should be generated from
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_MAX_GRAM_SIZE
static int
DEFAULT_MIN_GRAM_SIZE
static EdgeNGramTokenFilter.Side
DEFAULT_SIDE
-
Constructor Summary
Constructors Constructor Description 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 rangeEdgeNGramTokenFilter(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
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
incrementToken()
void
reset()
-
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
-
-
-
-
Field Detail
-
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
-
-
Constructor Detail
-
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
- theEdgeNGramTokenFilter.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 theEdgeNGramTokenFilter.Side
from which to chop off an n-gramminGram
- the smallest n-gram to generatemaxGram
- the largest n-gram to generate
-
-
Method Detail
-
incrementToken
public final boolean incrementToken() throws IOException
- Specified by:
incrementToken
in classorg.apache.lucene.analysis.TokenStream
- Throws:
IOException
-
reset
public void reset() throws IOException
- Overrides:
reset
in classorg.apache.lucene.analysis.TokenFilter
- Throws:
IOException
-
-