org.apache.lucene.analysis.ngram

Class Lucene43EdgeNGramTokenizer

java.lang.Object

org.apache.lucene.util.AttributeSource

org.apache.lucene.analysis.TokenStream

org.apache.lucene.analysis.Tokenizer

org.apache.lucene.analysis.ngram.Lucene43EdgeNGramTokenizer

All Implemented Interfaces:

Closeable, AutoCloseable

Deprecated.

@Deprecated
public final class Lucene43EdgeNGramTokenizer
extends Tokenizer

Old version of EdgeNGramTokenizer which doesn't handle correctly supplementary characters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Lucene43EdgeNGramTokenizer.Side Deprecated. Specifies which side of the input the n-gram should be generated from

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

AttributeSource.AttributeFactory, AttributeSource.State

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_GRAM_SIZE Deprecated.
static int	DEFAULT_MIN_GRAM_SIZE Deprecated.
static Lucene43EdgeNGramTokenizer.Side	DEFAULT_SIDE Deprecated.

Constructor Summary

Constructors

Constructor and Description
Lucene43EdgeNGramTokenizer(Version version, AttributeSource.AttributeFactory factory, Reader input, int minGram, int maxGram) Deprecated. Creates EdgeNGramTokenizer that can generate n-grams in the sizes of the given range
Lucene43EdgeNGramTokenizer(Version version, AttributeSource.AttributeFactory factory, Reader input, Lucene43EdgeNGramTokenizer.Side side, int minGram, int maxGram) Deprecated.
Lucene43EdgeNGramTokenizer(Version version, AttributeSource.AttributeFactory factory, Reader input, String sideLabel, int minGram, int maxGram) Deprecated.
Lucene43EdgeNGramTokenizer(Version version, Reader input, int minGram, int maxGram) Deprecated. Creates EdgeNGramTokenizer that can generate n-grams in the sizes of the given range
Lucene43EdgeNGramTokenizer(Version version, Reader input, Lucene43EdgeNGramTokenizer.Side side, int minGram, int maxGram) Deprecated.
Lucene43EdgeNGramTokenizer(Version version, Reader input, String sideLabel, int minGram, int maxGram) Deprecated.

Method Summary

Modifier and Type	Method and 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_SIDE

public static final Lucene43EdgeNGramTokenizer.Side DEFAULT_SIDE

Deprecated.

DEFAULT_MAX_GRAM_SIZE

public static final int DEFAULT_MAX_GRAM_SIZE

Deprecated.

See Also:

Constant Field Values

DEFAULT_MIN_GRAM_SIZE

public static final int DEFAULT_MIN_GRAM_SIZE

Deprecated.

See Also:

Constant Field Values

Constructor Detail

Lucene43EdgeNGramTokenizer

@Deprecated
public Lucene43EdgeNGramTokenizer(Version version,
                                              Reader input,
                                              Lucene43EdgeNGramTokenizer.Side side,
                                              int minGram,
                                              int maxGram)

Deprecated.

Creates EdgeNGramTokenizer that can generate n-grams in the sizes of the given range

Parameters:

version - the Lucene match version

input - Reader holding the input to be tokenized

side - the Lucene43EdgeNGramTokenizer.Side from which to chop off an n-gram

minGram - the smallest n-gram to generate

maxGram - the largest n-gram to generate

Lucene43EdgeNGramTokenizer

@Deprecated
public Lucene43EdgeNGramTokenizer(Version version,
                                              AttributeSource.AttributeFactory factory,
                                              Reader input,
                                              Lucene43EdgeNGramTokenizer.Side side,
                                              int minGram,
                                              int maxGram)

Deprecated.

Creates EdgeNGramTokenizer that can generate n-grams in the sizes of the given range

Parameters:

version - the Lucene match version

factory - AttributeSource.AttributeFactory to use

input - Reader holding the input to be tokenized

side - the Lucene43EdgeNGramTokenizer.Side from which to chop off an n-gram

minGram - the smallest n-gram to generate

maxGram - the largest n-gram to generate

Lucene43EdgeNGramTokenizer

@Deprecated
public Lucene43EdgeNGramTokenizer(Version version,
                                              Reader input,
                                              String sideLabel,
                                              int minGram,
                                              int maxGram)

Deprecated.

Creates EdgeNGramTokenizer that can generate n-grams in the sizes of the given range

Parameters:

version - the Lucene match version

input - Reader holding the input to be tokenized

sideLabel - the name of the Lucene43EdgeNGramTokenizer.Side from which to chop off an n-gram

minGram - the smallest n-gram to generate

maxGram - the largest n-gram to generate

Lucene43EdgeNGramTokenizer

@Deprecated
public Lucene43EdgeNGramTokenizer(Version version,
                                              AttributeSource.AttributeFactory factory,
                                              Reader input,
                                              String sideLabel,
                                              int minGram,
                                              int maxGram)

Deprecated.

Creates EdgeNGramTokenizer that can generate n-grams in the sizes of the given range

Parameters:

version - the Lucene match version

factory - AttributeSource.AttributeFactory to use

input - Reader holding the input to be tokenized

sideLabel - the name of the Lucene43EdgeNGramTokenizer.Side from which to chop off an n-gram

minGram - the smallest n-gram to generate

maxGram - the largest n-gram to generate

Lucene43EdgeNGramTokenizer

public Lucene43EdgeNGramTokenizer(Version version,
                                  Reader input,
                                  int minGram,
                                  int maxGram)

Deprecated.

Creates EdgeNGramTokenizer that can generate n-grams in the sizes of the given range

Parameters:

version - the Lucene match version

input - Reader holding the input to be tokenized

minGram - the smallest n-gram to generate

maxGram - the largest n-gram to generate

Lucene43EdgeNGramTokenizer

public Lucene43EdgeNGramTokenizer(Version version,
                                  AttributeSource.AttributeFactory factory,
                                  Reader input,
                                  int minGram,
                                  int maxGram)

Deprecated.

Creates EdgeNGramTokenizer that can generate n-grams in the sizes of the given range

Parameters:

version - the Lucene match version

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

Method Detail

incrementToken

public 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

end

public void end()
         throws 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:

IOException - If an I/O error occurs

reset

public void reset()
           throws 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:

IOException