org.apache.lucene.analysis

Class MockTokenizer

java.lang.Object

org.apache.lucene.util.AttributeSource

org.apache.lucene.analysis.TokenStream

org.apache.lucene.analysis.Tokenizer

org.apache.lucene.analysis.MockTokenizer

All Implemented Interfaces:

Closeable, AutoCloseable

public class MockTokenizer
extends Tokenizer

Tokenizer for testing.

This tokenizer is a replacement for WHITESPACE, SIMPLE, and KEYWORD tokenizers. If you are writing a component such as a TokenFilter, it's a great idea to test it wrapping this tokenizer instead for extra checks. This tokenizer has the following behavior:

• An internal state-machine is used for checking consumer consistency. These checks can be disabled with setEnableChecks(boolean).
• For convenience, optionally lowercases terms that it outputs.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_TOKEN_LENGTH
static CharacterRunAutomaton	KEYWORD Acts Similar to KeywordTokenizer.
static CharacterRunAutomaton	SIMPLE Acts like LetterTokenizer.
static CharacterRunAutomaton	WHITESPACE Acts Similar to WhitespaceTokenizer

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

input

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

DEFAULT_TOKEN_ATTRIBUTE_FACTORY

Constructor Summary

Constructors

Constructor and Description
MockTokenizer() Calls MockTokenizer(Reader, WHITESPACE, true)
MockTokenizer(AttributeFactory factory) Calls MockTokenizer(AttributeFactory, Reader, WHITESPACE, true)
MockTokenizer(AttributeFactory factory, CharacterRunAutomaton runAutomaton, boolean lowerCase)
MockTokenizer(AttributeFactory factory, CharacterRunAutomaton runAutomaton, boolean lowerCase, int maxTokenLength)
MockTokenizer(CharacterRunAutomaton runAutomaton, boolean lowerCase)
MockTokenizer(CharacterRunAutomaton runAutomaton, boolean lowerCase, int maxTokenLength)

Method Summary

Modifier and Type	Method and Description
void	close() Releases resources associated with this stream.
void	end() 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() Consumers (i.e., IndexWriter) use this method to advance the stream to the next token.
protected boolean	isTokenChar(int c)
protected int	normalize(int c)
protected int	readChar()
protected int	readCodePoint()
void	reset() This method is called by a consumer before it begins consumption using TokenStream.incrementToken().
void	setEnableChecks(boolean enableChecks) Toggle consumer workflow checking: if your test consumes tokenstreams normally you should leave this enabled.

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

correctOffset, 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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

WHITESPACE

public static final CharacterRunAutomaton WHITESPACE

Acts Similar to WhitespaceTokenizer

KEYWORD

public static final CharacterRunAutomaton KEYWORD

Acts Similar to KeywordTokenizer. TODO: Keyword returns an "empty" token for an empty reader...

SIMPLE

public static final CharacterRunAutomaton SIMPLE

Acts like LetterTokenizer.

DEFAULT_MAX_TOKEN_LENGTH

public static final int DEFAULT_MAX_TOKEN_LENGTH

See Also:

Constant Field Values

Constructor Detail

MockTokenizer

public MockTokenizer(AttributeFactory factory,
                     CharacterRunAutomaton runAutomaton,
                     boolean lowerCase,
                     int maxTokenLength)

MockTokenizer

public MockTokenizer(CharacterRunAutomaton runAutomaton,
                     boolean lowerCase,
                     int maxTokenLength)

MockTokenizer

public MockTokenizer(CharacterRunAutomaton runAutomaton,
                     boolean lowerCase)

MockTokenizer

public MockTokenizer()

Calls MockTokenizer(Reader, WHITESPACE, true)

MockTokenizer

public MockTokenizer(AttributeFactory factory,
                     CharacterRunAutomaton runAutomaton,
                     boolean lowerCase)

MockTokenizer

public MockTokenizer(AttributeFactory factory)

Calls MockTokenizer(AttributeFactory, Reader, WHITESPACE, true)

Method Detail

incrementToken

public final boolean incrementToken()
                             throws IOException

Description copied from class: TokenStream

Consumers (i.e., IndexWriter) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriate AttributeImpls with the attributes of the next token.

The producer must make no assumptions about the attributes after the method has been returned: the caller may arbitrarily change it. If the producer needs to preserve the state for subsequent calls, it can use AttributeSource.captureState() to create a copy of the current attribute state.

This method is called for every token of a document, so an efficient implementation is crucial for good performance. To avoid calls to AttributeSource.addAttribute(Class) and AttributeSource.getAttribute(Class), references to all AttributeImpls that this stream uses should be retrieved during instantiation.

To ensure that filters and consumers know which attributes are available, the attributes must be added during instantiation. Filters and consumers are not required to check for availability of attributes in TokenStream.incrementToken().

Specified by:

incrementToken in class TokenStream

Returns:

false for end of stream; true otherwise

Throws:

IOException

readCodePoint

protected int readCodePoint()
                     throws IOException

Throws:

IOException

readChar

protected int readChar()
                throws IOException

Throws:

IOException

isTokenChar

protected boolean isTokenChar(int c)

normalize

protected int normalize(int c)

reset

public void reset()
           throws IOException

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

close

public void close()
           throws IOException

Description copied from class: Tokenizer

Releases resources associated with this stream.

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

NOTE: The default implementation closes the input Reader, so be sure to call super.close() when overriding this method.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class Tokenizer

Throws:

IOException

end

public void end()
         throws IOException

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

setEnableChecks

public void setEnableChecks(boolean enableChecks)

Toggle consumer workflow checking: if your test consumes tokenstreams normally you should leave this enabled.