Class FilteringTokenFilter

Abstract base class for TokenFilters that may remove tokens. You have to implement Accept() and return a boolean if the current token should be preserved. IncrementToken() uses this method to decide if a token should be passed to the caller.

As of Lucene 4.4, an System.ArgumentException is thrown when trying to disable position increments when filtering terms.

Inheritance
System.Object
AttributeSource
TokenStream
TokenFilter
FilteringTokenFilter
StopFilter
TypeTokenFilter
JapanesePartOfSpeechStopFilter
CodepointCountFilter
KeepWordFilter
LengthFilter
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
[Serializable]
public abstract class FilteringTokenFilter : TokenFilter, IDisposable

Constructors

Name Description
FilteringTokenFilter(LuceneVersion, TokenStream)

Create a new FilteringTokenFilter.

FilteringTokenFilter(LuceneVersion, Boolean, TokenStream)

Create a new FilteringTokenFilter.

Fields

Name Description
m_version

Properties

Name Description
EnablePositionIncrements

Methods

Name Description
Accept()

Override this method and return if the current input token should be returned by IncrementToken().

End()
IncrementToken()
Reset()
SetEnablePositionIncrements(Boolean)

If true, this TokenFilter will preserve positions of the incoming tokens (ie, accumulate and set position increments of the removed tokens). Generally, true is best as it does not lose information (positions of the original tokens) during indexing.

When set, when a token is stopped (omitted), the position increment of the following token is incremented.

Extension Methods