org.apache.lucene.analysis.ngram

Class Lucene43NGramTokenFilter

java.lang.Object

org.apache.lucene.util.AttributeSource

org.apache.lucene.analysis.TokenStream

org.apache.lucene.analysis.TokenFilter

org.apache.lucene.analysis.ngram.Lucene43NGramTokenFilter

All Implemented Interfaces:

Closeable, AutoCloseable

Deprecated.

Use NGramTokenFilter instead.

@Deprecated
public final class Lucene43NGramTokenFilter
extends TokenFilter

Tokenizes the input into n-grams of the given size(s), matching Lucene 4.3 and before behavior.

Nested Class Summary

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

AttributeSource.State

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_NGRAM_SIZE Deprecated.
static int	DEFAULT_MIN_NGRAM_SIZE Deprecated.

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

input

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

DEFAULT_TOKEN_ATTRIBUTE_FACTORY

Constructor Summary

Constructors

Constructor and Description
Lucene43NGramTokenFilter(TokenStream input) Deprecated. Creates NGramTokenFilter with default min and max n-grams.
Lucene43NGramTokenFilter(TokenStream input, int minGram, int maxGram) Deprecated. Creates Lucene43NGramTokenFilter with given min and max n-grams.

Method Summary

Modifier and Type	Method and Description
boolean	incrementToken() Deprecated. Returns the next token in the stream, or null at EOS.
void	reset() Deprecated. This method is called by a consumer before it begins consumption using TokenStream.incrementToken().

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

close, end

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

addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, 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

Deprecated.

See Also:

Constant Field Values

DEFAULT_MAX_NGRAM_SIZE

public static final int DEFAULT_MAX_NGRAM_SIZE

Deprecated.

See Also:

Constant Field Values

Constructor Detail

Lucene43NGramTokenFilter

public Lucene43NGramTokenFilter(TokenStream input,
                                int minGram,
                                int maxGram)

Deprecated.

Creates Lucene43NGramTokenFilter 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

Lucene43NGramTokenFilter

public Lucene43NGramTokenFilter(TokenStream input)

Deprecated.

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

Deprecated.

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

Specified by:

incrementToken in class TokenStream

Returns:

false for end of stream; true otherwise

Throws:

IOException

reset

public void reset()
           throws IOException

Deprecated.

Description copied from class: TokenFilter

This method is called by a consumer before it begins consumption using TokenStream.incrementToken().

Resets this stream to a clean state. Stateful implementations must implement this method so that they can be reused, just as if they had been created fresh.

If you override this method, always call super.reset(), otherwise some internal state will not be correctly reset (e.g., Tokenizer will throw IllegalStateException on further usage).

NOTE: The default implementation chains the call to the input TokenStream, so be sure to call super.reset() when overriding this method.

Overrides:

reset in class TokenFilter

Throws:

IOException