Class MockTokenFilter

A Lucene.Net.Analysis.TokenFilter for testing that removes terms accepted by a DFA.

Union a list of singletons to act like a Lucene.Net.Analysis.Core.StopFilter.
Use the complement to act like a Lucene.Net.Analysis.Miscellaneous.KeepWordFilter.
Use a regex like .{12,} to act like a Lucene.Net.Analysis.Miscellaneous.LengthFilter.

Inheritance

object

AttributeSource

TokenStream

TokenFilter

MockTokenFilter

Implements

IDisposable

Inherited Members

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.ReferenceEquals(object, object)

Namespace: Lucene.Net.Analysis

Assembly: Lucene.Net.TestFramework.dll

Syntax

public sealed class MockTokenFilter : TokenFilter, IDisposable

Constructors

MockTokenFilter(TokenStream, CharacterRunAutomaton)

Create a new MockTokenFilter.

Declaration

public MockTokenFilter(TokenStream input, CharacterRunAutomaton filter)

Parameters

Type	Name	Description
TokenStream	input	Lucene.Net.Analysis.TokenStream to filter
CharacterRunAutomaton	filter	DFA representing the terms that should be removed.

Fields

EMPTY_STOPSET

Empty set of stopwords

Declaration

public static readonly CharacterRunAutomaton EMPTY_STOPSET

Field Value

Type	Description
CharacterRunAutomaton

ENGLISH_STOPSET

Set of common english stopwords

Declaration

public static readonly CharacterRunAutomaton ENGLISH_STOPSET

Field Value

Type	Description
CharacterRunAutomaton

Methods

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.

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

Declaration

public override void End()

Overrides

Lucene.Net.Analysis.TokenFilter.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 bool IncrementToken()

Returns

Type	Description
bool	false for end of stream; true otherwise

Overrides

Lucene.Net.Analysis.TokenStream.IncrementToken()

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.TokenFilter.Reset()

Remarks

NOTE: The default implementation chains the call to the input Lucene.Net.Analysis.TokenStream, so be sure to call base.Reset() when overriding this method.

Implements

IDisposable