Show / Hide Table of Contents

    Class LimitTokenCountFilter

    This TokenFilter limits the number of tokens while indexing. It is a replacement for the maximum field length setting inside IndexWriter.

    By default, this filter ignores any tokens in the wrapped TokenStream once the limit has been reached, 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 LimitTokenCountFilter(TokenStream, Int32, Boolean) consumeAllTokens option.

    Inheritance
    System.Object
    AttributeSource
    TokenStream
    TokenFilter
    LimitTokenCountFilter
    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 LimitTokenCountFilter : TokenFilter, IDisposable

    Constructors

    | Improve this Doc View Source

    LimitTokenCountFilter(TokenStream, Int32)

    Build a filter that only accepts tokens up to a maximum number. This filter will not consume any tokens beyond the maxTokenCount limit

    Declaration
    public LimitTokenCountFilter(TokenStream in, int maxTokenCount)
    Parameters
    Type Name Description
    TokenStream in

    the stream to wrap

    System.Int32 maxTokenCount

    max number of tokens to produce

    See Also
    LimitTokenCountFilter(TokenStream, Int32, Boolean)
    | Improve this Doc View Source

    LimitTokenCountFilter(TokenStream, Int32, Boolean)

    Build an filter that limits the maximum number of tokens per field.

    Declaration
    public LimitTokenCountFilter(TokenStream in, int maxTokenCount, bool consumeAllTokens)
    Parameters
    Type Name Description
    TokenStream in

    the stream to wrap

    System.Int32 maxTokenCount

    max number of tokens to produce

    System.Boolean consumeAllTokens

    whether all tokens from the input must be consumed even if maxTokenCount is reached.

    Methods

    | Improve this Doc View Source

    IncrementToken()

    Declaration
    public override bool IncrementToken()
    Returns
    Type Description
    System.Boolean
    Overrides
    TokenStream.IncrementToken()
    | Improve this Doc View Source

    Reset()

    Declaration
    public override void Reset()
    Overrides
    TokenFilter.Reset()

    Implements

    IDisposable
    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Licensed to the Apache Software Foundation (ASF)