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

Lucene.Net.Util.AttributeSource

Lucene.Net.Analysis.TokenStream

Lucene.Net.Analysis.TokenFilter

FilteringTokenFilter

Implements

System.IDisposable

Inherited Members

Lucene.Net.Analysis.TokenFilter.m_input

TokenFilter.Dispose(Boolean)

Lucene.Net.Analysis.TokenStream.Dispose()

Lucene.Net.Util.AttributeSource.GetAttributeFactory()

Lucene.Net.Util.AttributeSource.GetAttributeClassesEnumerator()

Lucene.Net.Util.AttributeSource.GetAttributeImplsEnumerator()

Lucene.Net.Util.AttributeSource.AddAttributeImpl(Lucene.Net.Util.Attribute)

Lucene.Net.Util.AttributeSource.AddAttribute<T>()

Lucene.Net.Util.AttributeSource.HasAttributes

Lucene.Net.Util.AttributeSource.HasAttribute<T>()

Lucene.Net.Util.AttributeSource.GetAttribute<T>()

Lucene.Net.Util.AttributeSource.ClearAttributes()

Lucene.Net.Util.AttributeSource.CaptureState()

Lucene.Net.Util.AttributeSource.RestoreState(Lucene.Net.Util.AttributeSource.State)

Lucene.Net.Util.AttributeSource.GetHashCode()

AttributeSource.Equals(Object)

AttributeSource.ReflectAsString(Boolean)

Lucene.Net.Util.AttributeSource.ReflectWith(Lucene.Net.Util.IAttributeReflector)

Lucene.Net.Util.AttributeSource.CloneAttributes()

Lucene.Net.Util.AttributeSource.CopyTo(Lucene.Net.Util.AttributeSource)

Lucene.Net.Util.AttributeSource.ToString()

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Lucene.Net.Analysis.Util

Assembly: Lucene.Net.Analysis.Common.dll

Syntax

public abstract class FilteringTokenFilter : TokenFilter, IDisposable

Constructors

| Improve this Doc View Source

FilteringTokenFilter(LuceneVersion, TokenStream)

Create a new FilteringTokenFilter.

Declaration

public FilteringTokenFilter(LuceneVersion version, TokenStream in)

Parameters

Type	Name	Description
Lucene.Net.Util.LuceneVersion	version	the Lucene match version
Lucene.Net.Analysis.TokenStream	in	the Lucene.Net.Analysis.TokenStream to consume

| Improve this Doc View Source

FilteringTokenFilter(LuceneVersion, Boolean, TokenStream)

Create a new FilteringTokenFilter.

Declaration

[Obsolete("enablePositionIncrements=false is not supported anymore as of Lucene 4.4")]
public FilteringTokenFilter(LuceneVersion version, bool enablePositionIncrements, TokenStream input)

Parameters

Type	Name	Description
Lucene.Net.Util.LuceneVersion	version	the Lucene match version
System.Boolean	enablePositionIncrements	whether to increment position increments when filtering out terms
Lucene.Net.Analysis.TokenStream	input	the input to consume

Fields

| Improve this Doc View Source

m_version

Declaration

protected readonly LuceneVersion m_version

Field Value

Type	Description
Lucene.Net.Util.LuceneVersion

Properties

| Improve this Doc View Source

EnablePositionIncrements

Declaration

public virtual bool EnablePositionIncrements { get; }

Property Value

Type	Description
System.Boolean

Methods

| Improve this Doc View Source

Accept()

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

Declaration

protected abstract bool Accept()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

End()

Declaration

public override void End()

Overrides

Lucene.Net.Analysis.TokenFilter.End()

| Improve this Doc View Source

IncrementToken()

Declaration

public sealed override bool IncrementToken()

Returns

Type	Description
System.Boolean

Overrides

Lucene.Net.Analysis.TokenStream.IncrementToken()

| Improve this Doc View Source

Reset()

Declaration

public override void Reset()

Overrides

Lucene.Net.Analysis.TokenFilter.Reset()

| Improve this Doc View Source

SetEnablePositionIncrements(Boolean)

If true, this Lucene.Net.Analysis.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.

Declaration

[Obsolete("enablePositionIncrements=false is not supported anymore as of Lucene 4.4")]
public virtual void SetEnablePositionIncrements(bool enable)

Parameters

Type	Name	Description
System.Boolean	enable

Implements

System.IDisposable