C# Class Lucene.Net.Analysis.Ngram.NGramTokenizer

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

On the contrary to NGramTokenFilter, this class sets offsets so that characters between startOffset and endOffset in the original stream are the same as the term chars.

For example, "abcde" would be tokenized as (minGram=2, maxGram=3):

Termababcbcbcdcdcdede
Position increment1111111
Position length1111111
Offsets[0,2[[0,3[[1,3[[1,4[[2,4[[2,5[[3,5[

This tokenizer changed a lot in Lucene 4.4 in order to:

  • tokenize in a streaming fashion to support streams which are larger than 1024 chars (limit of the previous version),
  • count grams based on unicode code points instead of java chars (and never split in the middle of surrogate pairs),
  • give the ability to #isTokenChar(int) pre-tokenize the stream before computing n-grams.

Additionally, this class doesn't trim trailing whitespaces and emits tokens in a different order, tokens are now emitted by increasing start offsets while they used to be emitted by increasing lengths (which prevented from supporting large input streams).

Although highly discouraged, it is still possible to use the old behavior through Lucene43NGramTokenizer.

Inheritance: Tokenizer
Show file Open project: apache/lucenenet Class Usage Examples

Public Methods

Method Description
End ( ) : void
IncrementToken ( ) : bool
NGramTokenizer ( LuceneVersion version, AttributeFactory factory, TextReader.TextReader input, int minGram, int maxGram ) : Lucene.Net.Analysis.Tokenattributes

Creates NGramTokenizer with given min and max n-grams.
NGramTokenizer ( LuceneVersion version, TextReader.TextReader input ) : Lucene.Net.Analysis.Tokenattributes

Creates NGramTokenizer with default min and max n-grams.
NGramTokenizer ( LuceneVersion version, TextReader.TextReader input, int minGram, int maxGram ) : Lucene.Net.Analysis.Tokenattributes

Creates NGramTokenizer with given min and max n-grams.
Reset ( ) : void

Protected Methods

Method Description
IsTokenChar ( int chr ) : bool

Only collect characters which satisfy this condition.

Private Methods

Method Description
Init ( LuceneVersion version, int minGram, int maxGram, bool edgesOnly ) : void
NGramTokenizer ( LuceneVersion version, AttributeFactory factory, TextReader.TextReader input, int minGram, int maxGram, bool edgesOnly ) : Lucene.Net.Analysis.Tokenattributes
NGramTokenizer ( LuceneVersion version, TextReader.TextReader input, int minGram, int maxGram, bool edgesOnly ) : Lucene.Net.Analysis.Tokenattributes
UpdateLastNonTokenChar ( ) : void
consume ( ) : void

Consume one code point.

Method Details

End() public method

public End ( ) : void
return void

IncrementToken() public final method

public final IncrementToken ( ) : bool
return bool

IsTokenChar() protected method

Only collect characters which satisfy this condition.
protected IsTokenChar ( int chr ) : bool
chr int
return bool

NGramTokenizer() public method

Creates NGramTokenizer with given min and max n-grams.
public NGramTokenizer ( LuceneVersion version, AttributeFactory factory, TextReader.TextReader input, int minGram, int maxGram ) : Lucene.Net.Analysis.Tokenattributes
version LuceneVersion the lucene compatibility version
factory AttributeFactory to use
input System.IO.TextReader.TextReader holding the input to be tokenized
minGram int the smallest n-gram to generate
maxGram int the largest n-gram to generate
return Lucene.Net.Analysis.Tokenattributes

NGramTokenizer() public method

Creates NGramTokenizer with default min and max n-grams.
public NGramTokenizer ( LuceneVersion version, TextReader.TextReader input ) : Lucene.Net.Analysis.Tokenattributes
version LuceneVersion the lucene compatibility version
input System.IO.TextReader.TextReader holding the input to be tokenized
return Lucene.Net.Analysis.Tokenattributes

NGramTokenizer() public method

Creates NGramTokenizer with given min and max n-grams.
public NGramTokenizer ( LuceneVersion version, TextReader.TextReader input, int minGram, int maxGram ) : Lucene.Net.Analysis.Tokenattributes
version LuceneVersion the lucene compatibility version
input System.IO.TextReader.TextReader holding the input to be tokenized
minGram int the smallest n-gram to generate
maxGram int the largest n-gram to generate
return Lucene.Net.Analysis.Tokenattributes

Reset() public method

public Reset ( ) : void
return void