Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class SnowballFilter

    A filter that stems words using a Snowball-generated stemmer.

    Available stemmers are listed in Lucene.Net.Tartarus.Snowball.Ext.

    NOTE: SnowballFilter expects lowercased text.

    • For the Turkish language, see TurkishLowerCaseFilter.
    • For other languages, see LowerCaseFilter.

    Note: This filter is aware of the Lucene.Net.Analysis.TokenAttributes.IKeywordAttribute. To prevent certain terms from being passed to the stemmer Lucene.Net.Analysis.TokenAttributes.IKeywordAttribute.IsKeyword should be set to true in a previous Lucene.Net.Analysis.TokenStream.

    Note: For including the original term as well as the stemmed version, see KeywordRepeatFilterFactory

    Inheritance
    object
    AttributeSource
    TokenStream
    TokenFilter
    SnowballFilter
    Implements
    IDisposable
    Inherited Members
    TokenFilter.End()
    TokenFilter.Reset()
    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(bool)
    AttributeSource.ReflectWith(IAttributeReflector)
    AttributeSource.CloneAttributes()
    AttributeSource.CopyTo(AttributeSource)
    AttributeSource.ToString()
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Analysis.Snowball
    Assembly: Lucene.Net.Analysis.Common.dll
    Syntax
    public sealed class SnowballFilter : TokenFilter, IDisposable

    Constructors

    SnowballFilter(TokenStream, SnowballProgram)

    A filter that stems words using a Snowball-generated stemmer.

    Available stemmers are listed in Lucene.Net.Tartarus.Snowball.Ext.

    NOTE: SnowballFilter expects lowercased text.

    • For the Turkish language, see TurkishLowerCaseFilter.
    • For other languages, see LowerCaseFilter.

    Note: This filter is aware of the Lucene.Net.Analysis.TokenAttributes.IKeywordAttribute. To prevent certain terms from being passed to the stemmer Lucene.Net.Analysis.TokenAttributes.IKeywordAttribute.IsKeyword should be set to true in a previous Lucene.Net.Analysis.TokenStream.

    Note: For including the original term as well as the stemmed version, see KeywordRepeatFilterFactory

    Declaration
    public SnowballFilter(TokenStream input, SnowballProgram stemmer)
    Parameters
    Type Name Description
    TokenStream input
    SnowballProgram stemmer

    SnowballFilter(TokenStream, string)

    Construct the named stemming filter.

    Available stemmers are listed in Lucene.Net.Tartarus.Snowball.Ext. The name of a stemmer is the part of the class name before "Stemmer", e.g., the stemmer in EnglishStemmer is named "English".

    Declaration
    public SnowballFilter(TokenStream @in, string name)
    Parameters
    Type Name Description
    TokenStream in

    the input tokens to stem

    string name

    the name of a stemmer

    Methods

    IncrementToken()

    Returns the next input Lucene.Net.Analysis.Token, after being stemmed

    Declaration
    public override sealed bool IncrementToken()
    Returns
    Type Description
    bool
    Overrides
    Lucene.Net.Analysis.TokenStream.IncrementToken()

    Implements

    IDisposable
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.