org.apache.lucene.analysis.ngram

Class EdgeNGramTokenFilter

public class EdgeNGramTokenFilter extends TokenFilter

Tokenizes the given token into n-grams of given size(s).

Author: Otis Gospodnetic

Nested Class Summary
static class	EdgeNGramTokenFilter.Side Specifies which side of the input the n-gram should be generated from

Field Summary
static int	DEFAULT_MAX_GRAM_SIZE
static int	DEFAULT_MIN_GRAM_SIZE
static EdgeNGramTokenFilter.Side	DEFAULT_SIDE

Constructor Summary
protected	EdgeNGramTokenFilter(TokenStream input)
	EdgeNGramTokenFilter(TokenStream input, EdgeNGramTokenFilter.Side side, int minGram, int maxGram) Creates EdgeNGramTokenFilter that can generate n-grams in the sizes of the given range
	EdgeNGramTokenFilter(TokenStream input, String sideLabel, int minGram, int maxGram) Creates EdgeNGramTokenFilter that can generate n-grams in the sizes of the given range

Method Summary
Token	next() Returns the next token in the stream, or null at EOS.

Field Detail

DEFAULT_MAX_GRAM_SIZE

public static final int DEFAULT_MAX_GRAM_SIZE

DEFAULT_MIN_GRAM_SIZE

public static final int DEFAULT_MIN_GRAM_SIZE

DEFAULT_SIDE

public static final EdgeNGramTokenFilter.Side DEFAULT_SIDE

Constructor Detail

EdgeNGramTokenFilter

protected EdgeNGramTokenFilter(TokenStream input)

EdgeNGramTokenFilter

public EdgeNGramTokenFilter(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 tokenized side the Side from which to chop off an n-gram minGram the smallest n-gram to generate maxGram the largest n-gram to generate

EdgeNGramTokenFilter

public EdgeNGramTokenFilter(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 tokenized sideLabel the name of the Side from which to chop off an n-gram minGram the smallest n-gram to generate maxGram the largest n-gram to generate

Method Detail

public final Token next()

Returns the next token in the stream, or null at EOS.