Class MockTokenizer

Tokenizer for testing.

This tokenizer is a replacement for WHITESPACE, SIMPLE, and KEYWORD tokenizers. If you are writing a component such as a Lucene.Net.Analysis.TokenFilter, its 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 EnableChecks.
• For convenience, optionally lowercases terms that it outputs.

Inheritance

object

AttributeSource

TokenStream

Tokenizer

MockTokenizer

Implements

IDisposable

Inherited Members

Tokenizer.m_input

Tokenizer.CorrectOffset(int)

Tokenizer.SetReader(TextReader)

TokenStream.Dispose()

AttributeSource.GetAttributeFactory()

AttributeSource.GetAttributeClassesEnumerator()

AttributeSource.GetAttributeImplsEnumerator()

AttributeSource.AddAttributeImpl(Attribute)

AttributeSource.AddAttribute<T>()

AttributeSource.HasAttributes

AttributeSource.HasAttribute<T>()

AttributeSource.GetAttribute<T>()

AttributeSource.ClearAttributes()

AttributeSource.CaptureState()

AttributeSource.RestoreState(AttributeSource.State)

AttributeSource.GetHashCode()

AttributeSource.Equals(object)

AttributeSource.ReflectAsString(bool)

AttributeSource.ReflectWith(IAttributeReflector)

AttributeSource.CloneAttributes()

AttributeSource.CopyTo(AttributeSource)

AttributeSource.ToString()

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Analysis

Assembly: Lucene.Net.TestFramework.dll

Syntax

public class MockTokenizer : Tokenizer, IDisposable

Constructors

MockTokenizer(AttributeFactory, TextReader)

Calls MockTokenizer(AttributeFactory, TextReader, WHITESPACE, true)

Declaration

public MockTokenizer(AttributeSource.AttributeFactory factory, TextReader input)

Parameters

Type	Name	Description
AttributeSource.AttributeFactory	factory
TextReader	input

MockTokenizer(AttributeFactory, TextReader, CharacterRunAutomaton, bool)

Tokenizer for testing.

This tokenizer is a replacement for WHITESPACE, SIMPLE, and KEYWORD tokenizers. If you are writing a component such as a Lucene.Net.Analysis.TokenFilter, its 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 EnableChecks.
• For convenience, optionally lowercases terms that it outputs.

Declaration

public MockTokenizer(AttributeSource.AttributeFactory factory, TextReader input, CharacterRunAutomaton runAutomaton, bool lowerCase)

Parameters

Type	Name	Description
AttributeSource.AttributeFactory	factory
TextReader	input
CharacterRunAutomaton	runAutomaton
bool	lowerCase

MockTokenizer(AttributeFactory, TextReader, CharacterRunAutomaton, bool, int)

Tokenizer for testing.

This tokenizer is a replacement for WHITESPACE, SIMPLE, and KEYWORD tokenizers. If you are writing a component such as a Lucene.Net.Analysis.TokenFilter, its 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 EnableChecks.
• For convenience, optionally lowercases terms that it outputs.

Declaration

public MockTokenizer(AttributeSource.AttributeFactory factory, TextReader input, CharacterRunAutomaton runAutomaton, bool lowerCase, int maxTokenLength)

Parameters

Type	Name	Description
AttributeSource.AttributeFactory	factory
TextReader	input
CharacterRunAutomaton	runAutomaton
bool	lowerCase
int	maxTokenLength

MockTokenizer(TextReader)

Calls MockTokenizer(TextReader, WHITESPACE, true).

Declaration

public MockTokenizer(TextReader input)

Parameters

Type	Name	Description
TextReader	input

MockTokenizer(TextReader, CharacterRunAutomaton, bool)

Tokenizer for testing.

This tokenizer is a replacement for WHITESPACE, SIMPLE, and KEYWORD tokenizers. If you are writing a component such as a Lucene.Net.Analysis.TokenFilter, its 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 EnableChecks.
• For convenience, optionally lowercases terms that it outputs.

Declaration

public MockTokenizer(TextReader input, CharacterRunAutomaton runAutomaton, bool lowerCase)

Parameters

Type	Name	Description
TextReader	input
CharacterRunAutomaton	runAutomaton
bool	lowerCase

MockTokenizer(TextReader, CharacterRunAutomaton, bool, int)

Tokenizer for testing.

This tokenizer is a replacement for WHITESPACE, SIMPLE, and KEYWORD tokenizers. If you are writing a component such as a Lucene.Net.Analysis.TokenFilter, its 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 EnableChecks.
• For convenience, optionally lowercases terms that it outputs.

Declaration

public MockTokenizer(TextReader input, CharacterRunAutomaton runAutomaton, bool lowerCase, int maxTokenLength)

Parameters

Type	Name	Description
TextReader	input
CharacterRunAutomaton	runAutomaton
bool	lowerCase
int	maxTokenLength

Fields

DEFAULT_MAX_TOKEN_LENGTH

Tokenizer for testing.

This tokenizer is a replacement for WHITESPACE, SIMPLE, and KEYWORD tokenizers. If you are writing a component such as a Lucene.Net.Analysis.TokenFilter, its 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 EnableChecks.
• For convenience, optionally lowercases terms that it outputs.

Declaration

public static readonly int DEFAULT_MAX_TOKEN_LENGTH

Field Value

Type	Description
int

KEYWORD

Acts Similar to Lucene.Net.Analysis.Core.KeywordTokenizer. TODO: Keyword returns an "empty" token for an empty reader...

Declaration

public static readonly CharacterRunAutomaton KEYWORD

Field Value

Type	Description
CharacterRunAutomaton

SIMPLE

Acts like Lucene.Net.Analysis.Core.LetterTokenizer.

Declaration

public static readonly CharacterRunAutomaton SIMPLE

Field Value

Type	Description
CharacterRunAutomaton

WHITESPACE

Acts Similar to Lucene.Net.Analysis.Core.WhitespaceTokenizer.

Declaration

public static readonly CharacterRunAutomaton WHITESPACE

Field Value

Type	Description
CharacterRunAutomaton

Properties

EnableChecks

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

Declaration

public virtual bool EnableChecks { get; set; }

Property Value

Type	Description
bool

Methods

Dispose(bool)

Releases resources associated with this stream.

If you override this method, always call base.Dispose(disposing), otherwise some internal state will not be correctly reset (e.g., Lucene.Net.Analysis.Tokenizer will throw InvalidOperationException on reuse).

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Overrides

Tokenizer.Dispose(bool)

Remarks

NOTE: The default implementation closes the input TextReader, so be sure to call base.Dispose(disposing) when overriding this method.

End()

This method is called by the consumer after the last token has been consumed, after Lucene.Net.Analysis.TokenStream.IncrementToken() returned false (using the new Lucene.Net.Analysis.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 base.End();.

Declaration

public override void End()

Overrides

Lucene.Net.Analysis.TokenStream.End()

Exceptions

Type	Condition
IOException	If an I/O error occurs

IncrementToken()

Consumers (i.e., Lucene.Net.Index.IndexWriter) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriate Lucene.Net.Util.IAttributes 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 Lucene.Net.Util.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 Lucene.Net.Util.AttributeSource.AddAttribute<T>() and Lucene.Net.Util.AttributeSource.GetAttribute<T>(), references to all Lucene.Net.Util.IAttributes 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 Lucene.Net.Analysis.TokenStream.IncrementToken().

Declaration

public override sealed bool IncrementToken()

Returns

Type	Description
bool	false for end of stream; true otherwise

Overrides

Lucene.Net.Analysis.TokenStream.IncrementToken()

IsTokenChar(int)

Tokenizer for testing.

This tokenizer is a replacement for WHITESPACE, SIMPLE, and KEYWORD tokenizers. If you are writing a component such as a Lucene.Net.Analysis.TokenFilter, its 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 EnableChecks.
• For convenience, optionally lowercases terms that it outputs.

Declaration

protected virtual bool IsTokenChar(int c)

Parameters

Type	Name	Description
int	c

Returns

Type	Description
bool

Normalize(int)

Tokenizer for testing.

This tokenizer is a replacement for WHITESPACE, SIMPLE, and KEYWORD tokenizers. If you are writing a component such as a Lucene.Net.Analysis.TokenFilter, its 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 EnableChecks.
• For convenience, optionally lowercases terms that it outputs.

Declaration

protected virtual int Normalize(int c)

Parameters

Type	Name	Description
int	c

Returns

Type	Description
int

ReadChar()

Tokenizer for testing.

This tokenizer is a replacement for WHITESPACE, SIMPLE, and KEYWORD tokenizers. If you are writing a component such as a Lucene.Net.Analysis.TokenFilter, its 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 EnableChecks.
• For convenience, optionally lowercases terms that it outputs.

Declaration

protected virtual int ReadChar()

Returns

Type	Description
int

ReadCodePoint()

Tokenizer for testing.

This tokenizer is a replacement for WHITESPACE, SIMPLE, and KEYWORD tokenizers. If you are writing a component such as a Lucene.Net.Analysis.TokenFilter, its 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 EnableChecks.
• For convenience, optionally lowercases terms that it outputs.

Declaration

protected virtual int ReadCodePoint()

Returns

Type	Description
int

Reset()

This method is called by a consumer before it begins consumption using Lucene.Net.Analysis.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 base.Reset(), otherwise some internal state will not be correctly reset (e.g., Lucene.Net.Analysis.Tokenizer will throw InvalidOperationException on further usage).

Declaration

public override void Reset()

Overrides

Lucene.Net.Analysis.Tokenizer.Reset()

Implements

IDisposable