Save This Page
Home » lucene-2.3.2-src » org.apache » lucene » analysis » ngram » [javadoc | source]
org.apache.lucene.analysis.ngram
public class: NGramTokenFilter [javadoc | source]
java.lang.Object
   org.apache.lucene.analysis.TokenStream
      org.apache.lucene.analysis.TokenFilter
         org.apache.lucene.analysis.ngram.NGramTokenFilter
Tokenizes the input into n-grams of the given size(s).
Field Summary
public static final  int DEFAULT_MIN_NGRAM_SIZE     
public static final  int DEFAULT_MAX_NGRAM_SIZE     
Fields inherited from org.apache.lucene.analysis.TokenFilter:
input
Constructor:
 public NGramTokenFilter(TokenStream input) 
    Creates NGramTokenFilter with default min and max n-grams.
    Parameters:
    input - TokenStream holding the input to be tokenized
 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
Method from org.apache.lucene.analysis.ngram.NGramTokenFilter Summary:
next
Methods from org.apache.lucene.analysis.TokenFilter:
close
Methods from org.apache.lucene.analysis.TokenStream:
close,   next,   next,   reset
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.analysis.ngram.NGramTokenFilter Detail:
 public final Token next() throws IOException 
    Returns the next token in the stream, or null at EOS.