Class LimitTokenPositionFilter

This TokenFilter limits its emitted tokens to those with positions that are not greater than the configured limit.

By default, this filter ignores any tokens in the wrapped TokenStream once the limit has been exceeded, which can result in Reset() being called prior to IncrementToken() returning false. For most TokenStream implementations this should be acceptable, and faster then consuming the full stream. If you are wrapping a TokenStream which requires that the full stream of tokens be exhausted in order to function properly, use the LimitTokenPositionFilter(TokenStream, Int32, Boolean) consumeAllTokens option.

Inheritance

System.Object

AttributeSource

TokenStream

TokenFilter

LimitTokenPositionFilter

Implements

IDisposable

Inherited Members

TokenFilter.m_input

TokenFilter.End()

TokenFilter.Dispose(Boolean)

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(Boolean)

AttributeSource.ReflectWith(IAttributeReflector)

AttributeSource.CloneAttributes()

AttributeSource.CopyTo(AttributeSource)

AttributeSource.ToString()

Namespace: Lucene.Net.Analysis.Miscellaneous

Assembly: Lucene.Net.Analysis.Common.dll

Syntax

public sealed class LimitTokenPositionFilter : TokenFilter, IDisposable

Constructors

LimitTokenPositionFilter(TokenStream, Int32)

Build a filter that only accepts tokens up to and including the given maximum position. This filter will not consume any tokens with position greater than the maxTokenPosition limit.

Declaration

public LimitTokenPositionFilter(TokenStream in, int maxTokenPosition)

Parameters

Type	Name	Description
TokenStream	in	the stream to wrap
System.Int32	maxTokenPosition	max position of tokens to produce (1st token always has position 1)

See Also

LimitTokenPositionFilter(TokenStream, Int32, Boolean)

LimitTokenPositionFilter(TokenStream, Int32, Boolean)

Build a filter that limits the maximum position of tokens to emit.

Declaration

public LimitTokenPositionFilter(TokenStream in, int maxTokenPosition, bool consumeAllTokens)

Parameters

Type	Name	Description
TokenStream	in	the stream to wrap
System.Int32	maxTokenPosition	max position of tokens to produce (1st token always has position 1)
System.Boolean	consumeAllTokens	whether all tokens from the wrapped input stream must be consumed even if maxTokenPosition is exceeded.

Methods

IncrementToken()

Declaration

public override bool IncrementToken()

Returns

Type	Description
System.Boolean

Overrides

TokenStream.IncrementToken()

Reset()

Declaration

public override void Reset()

Overrides

TokenFilter.Reset()

Implements

IDisposable