org.apache.lucene.analysis.ngram
Class NGramTokenFilter

java.lang.Object
  org.apache.lucene.util.AttributeSource
      org.apache.lucene.analysis.TokenStream
          org.apache.lucene.analysis.TokenFilter
              org.apache.lucene.analysis.ngram.NGramTokenFilter

public class NGramTokenFilter
extends TokenFilter

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

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource

AttributeSource.AttributeFactory, AttributeSource.State

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

boolean	incrementToken() Returns the next token in the stream, or null at EOS.
Token	next() Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.
Token	next(Token reusableToken) Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.
void	reset() Reset the filter as well as the input TokenStream.

Methods inherited from class org.apache.lucene.analysis.TokenFilter

close, end

Methods inherited from class org.apache.lucene.analysis.TokenStream

getOnlyUseNewAPI, setOnlyUseNewAPI

Methods inherited from class org.apache.lucene.util.AttributeSource

addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, restoreState, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, 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

incrementToken

public final boolean incrementToken()
                             throws IOException

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

Overrides:

incrementToken in class TokenStream

Returns:

false for end of stream; true otherwise

Note that this method will be defined abstract in Lucene 3.0.

Throws:

IOException

next

public final Token next(Token reusableToken)
                 throws IOException

Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.

Description copied from class: TokenStream

Returns the next token in the stream, or null at EOS. When possible, the input Token should be used as the returned Token (this gives fastest tokenization performance), but this is not required and a new Token may be returned. Callers may re-use a single Token instance for successive calls to this method.

This implicitly defines a "contract" between consumers (callers of this method) and producers (implementations of this method that are the source for tokens):

• A consumer must fully consume the previously returned Token before calling this method again.
• A producer must call Token.clear() before setting the fields in it and returning it

Also, the producer must make no assumptions about a Token after it has been returned: the caller may arbitrarily change it. If the producer needs to hold onto the Token for subsequent calls, it must clone() it before storing it. Note that a TokenFilter is considered a consumer.

Overrides:

next in class TokenStream

Parameters:

reusableToken - a Token that may or may not be used to return; this parameter should never be null (the callee is not required to check for null before using it, but it is a good idea to assert that it is not null.)

Returns:

next Token in the stream or null if end-of-stream was hit

Throws:

IOException

next

public final Token next()
                 throws IOException

Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.

Description copied from class: TokenStream

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

Overrides:

next in class TokenStream

Throws:

IOException

reset

public void reset()
           throws IOException

Description copied from class: TokenFilter

Reset the filter as well as the input TokenStream.

Overrides:

reset in class TokenFilter

Throws:

IOException