com.atlassian.confluence.search.lucene.filter
Class ConfluenceNGramTokenFilter

java.lang.Object
  extended by org.apache.lucene.analysis.TokenStream
      extended by org.apache.lucene.analysis.TokenFilter
          extended by com.atlassian.confluence.search.lucene.filter.ConfluenceNGramTokenFilter

public class ConfluenceNGramTokenFilter
extends org.apache.lucene.analysis.TokenFilter

Token filter that returns n-grams from the input (excluding start grams).


Nested Class Summary
static interface ConfluenceNGramTokenFilter.Callback
          Callback interface to allow filtering on n-gram tokens
 
Field Summary
static ConfluenceNGramTokenFilter.Callback ALL_GRAMS
           
static int DEFAULT_MAX_NGRAM_SIZE
           
static int DEFAULT_MIN_NGRAM_SIZE
           
static ConfluenceNGramTokenFilter.Callback EXCLUDE_START_GRAMS
           
static ConfluenceNGramTokenFilter.Callback ONLY_START_GRAMS
           
 
Fields inherited from class org.apache.lucene.analysis.TokenFilter
input
 
Constructor Summary
ConfluenceNGramTokenFilter(org.apache.lucene.analysis.TokenStream input, ConfluenceNGramTokenFilter.Callback callback)
          Creates NGramTokenFilter with default min and max n-grams.
ConfluenceNGramTokenFilter(org.apache.lucene.analysis.TokenStream input, int minGram, int maxGram, ConfluenceNGramTokenFilter.Callback callback)
          Creates NGramTokenFilter with given min and max n-grams.
 
Method Summary
 org.apache.lucene.analysis.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
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

EXCLUDE_START_GRAMS

public static final ConfluenceNGramTokenFilter.Callback EXCLUDE_START_GRAMS

ALL_GRAMS

public static final ConfluenceNGramTokenFilter.Callback ALL_GRAMS

ONLY_START_GRAMS

public static final ConfluenceNGramTokenFilter.Callback ONLY_START_GRAMS
Constructor Detail

ConfluenceNGramTokenFilter

public ConfluenceNGramTokenFilter(org.apache.lucene.analysis.TokenStream input,
                                  int minGram,
                                  int maxGram,
                                  ConfluenceNGramTokenFilter.Callback callback)
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
callback - this is called before a n-gram token is added

ConfluenceNGramTokenFilter

public ConfluenceNGramTokenFilter(org.apache.lucene.analysis.TokenStream input,
                                  ConfluenceNGramTokenFilter.Callback callback)
Creates NGramTokenFilter with default min and max n-grams.

Parameters:
input - TokenStream holding the input to be tokenized
callback - this is called before a n-gram token is added
Method Detail

next

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

Specified by:
next in class org.apache.lucene.analysis.TokenStream
Throws:
IOException


Copyright © 2003-2010 Atlassian. All Rights Reserved.