Package org.apache.lucene.analysis.ngram

Class Lucene43NGramTokenizer

java.lang.Object

org.apache.lucene.util.AttributeSource

org.apache.lucene.analysis.TokenStream

org.apache.lucene.analysis.Tokenizer

org.apache.lucene.analysis.ngram.Lucene43NGramTokenizer

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

@Deprecated
public final class Lucene43NGramTokenizer
extends Tokenizer

Deprecated.

Old broken version of NGramTokenizer.

Nested Class Summary

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

AttributeSource.AttributeFactory, AttributeSource.State

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
Lucene43NGramTokenizer(java.io.Reader input)	Deprecated. Creates NGramTokenizer with default min and max n-grams.
Lucene43NGramTokenizer(java.io.Reader input, int minGram, int maxGram)	Deprecated. Creates NGramTokenizer with given min and max n-grams.
Lucene43NGramTokenizer(AttributeSource.AttributeFactory factory, java.io.Reader input, int minGram, int maxGram)	Deprecated. Creates NGramTokenizer with given min and max n-grams.

Method Summary

Modifier and Type	Method	Description
void	end()	Deprecated. This method is called by the consumer after the last token has been consumed, after TokenStream.incrementToken() returned false (using the new TokenStream API).
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.Tokenizer

close, setReader

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

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

Lucene43NGramTokenizer

public Lucene43NGramTokenizer(java.io.Reader input,
                              int minGram,
                              int maxGram)

Deprecated.

Creates NGramTokenizer with given min and max n-grams.

Parameters:

input - Reader holding the input to be tokenized

minGram - the smallest n-gram to generate

maxGram - the largest n-gram to generate

Lucene43NGramTokenizer

public Lucene43NGramTokenizer(AttributeSource.AttributeFactory factory,
                              java.io.Reader input,
                              int minGram,
                              int maxGram)

Deprecated.

Creates NGramTokenizer with given min and max n-grams.

Parameters:

factory - AttributeSource.AttributeFactory to use

input - Reader holding the input to be tokenized

minGram - the smallest n-gram to generate

maxGram - the largest n-gram to generate

Lucene43NGramTokenizer

public Lucene43NGramTokenizer(java.io.Reader input)

Deprecated.

Creates NGramTokenizer with default min and max n-grams.

Parameters:

input - Reader holding the input to be tokenized

Method Detail

incrementToken

public boolean incrementToken()
                       throws java.io.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:

java.io.IOException

end

public void end()
         throws java.io.IOException

Deprecated.

Description copied from class: TokenStream

This method is called by the consumer after the last token has been consumed, after TokenStream.incrementToken() returned false (using the new TokenStream API). Streams implementing the old API should upgrade to use this feature.

This method can be used to perform any end-of-stream operations, such as setting the final offset of a stream. The final offset of a stream might differ from the offset of the last token eg in case one or more whitespaces followed after the last token, but a WhitespaceTokenizer was used.

Additionally any skipped positions (such as those removed by a stopfilter) can be applied to the position increment, or any adjustment of other attributes where the end-of-stream value may be important.

If you override this method, always call super.end().

Overrides:

end in class TokenStream

Throws:

java.io.IOException - If an I/O error occurs

reset

public void reset()
           throws java.io.IOException

Deprecated.

Description copied from class: TokenStream

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).

Overrides:

reset in class Tokenizer

Throws:

java.io.IOException