org.apache.lucene.analysis.ngram
Class NGramTokenFilter

java.lang.Object
  extended by org.apache.lucene.analysis.TokenStream
      extended by org.apache.lucene.analysis.TokenFilter
          extended by org.apache.lucene.analysis.ngram.NGramTokenFilter

public class NGramTokenFilter
extends TokenFilter

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

Author:
Otis Gospodnetic

Field Summary
static int DEFAULT_MAX_NGRAM_SIZE
           
static int DEFAULT_MIN_NGRAM_SIZE
           
 
Fields inherited from class org.apache.lucene.analysis.TokenFilter
input
 
Constructor Summary
NGramTokenFilter(TokenStream input)
          Creates NGramTokenFilter with default min and max n-grams.
NGramTokenFilter(TokenStream input, int minGram, int maxGram)
          Creates NGramTokenFilter with given min and max n-grams.
 
Method Summary
 Token next()
          Returns the next token in the stream, or null at EOS.
 
Methods inherited from class org.apache.lucene.analysis.TokenFilter
close
 
Methods inherited from class org.apache.lucene.analysis.TokenStream
next, reset
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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
Constructor Detail

NGramTokenFilter

public NGramTokenFilter(TokenStream input,
                        int minGram,
                        int maxGram)
Creates NGramTokenFilter with given min and max n-grams.

Parameters:
input - TokenStream holding the input to be tokenized
minGram - the smallest n-gram to generate
maxGram - the largest n-gram to generate

NGramTokenFilter

public NGramTokenFilter(TokenStream input)
Creates NGramTokenFilter with default min and max n-grams.

Parameters:
input - TokenStream holding the input to be tokenized
Method Detail

next

public final Token next()
                 throws IOException
Returns the next token in the stream, or null at EOS.

Overrides:
next in class TokenStream
Throws:
IOException


Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.