Class LimitTokenPositionFilter
This Lucene.Net.Analysis.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 Lucene.Net.Analysis.TokenStream
once the limit has been exceeded, which can result in Reset() being
called prior to IncrementToken() returning false. For most
Lucene.Net.Analysis.TokenStream implementations this should be acceptable, and faster
then consuming the full stream. If you are wrapping a Lucene.Net.Analysis.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
Lucene.Net.Util.AttributeSource
Lucene.Net.Analysis.TokenStream
Lucene.Net.Analysis.TokenFilter
LimitTokenPositionFilter
Implements
System.IDisposable
Inherited Members
Lucene.Net.Analysis.TokenFilter.m_input
Lucene.Net.Analysis.TokenFilter.End()
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()
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)
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
public sealed class LimitTokenPositionFilter : TokenFilter, IDisposable
Constructors
|
Improve this Doc
View Source
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 |
| Lucene.Net.Analysis.TokenStream |
in |
the stream to wrap
|
| System.Int32 |
maxTokenPosition |
max position of tokens to produce (1st token always has position 1)
|
See Also
|
Improve this Doc
View Source
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 |
| Lucene.Net.Analysis.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
|
Improve this Doc
View Source
IncrementToken()
Declaration
public 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()
Implements
System.IDisposable