Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class StopwordAnalyzerBase

    Base class for Lucene.Net.Analysis.Analyzers that need to make use of stopword sets.

    Inheritance
    System.Object
    Lucene.Net.Analysis.Analyzer
    StopwordAnalyzerBase
    ArabicAnalyzer
    BulgarianAnalyzer
    BrazilianAnalyzer
    CatalanAnalyzer
    CJKAnalyzer
    SoraniAnalyzer
    StopAnalyzer
    CzechAnalyzer
    DanishAnalyzer
    GermanAnalyzer
    GreekAnalyzer
    EnglishAnalyzer
    SpanishAnalyzer
    BasqueAnalyzer
    PersianAnalyzer
    FinnishAnalyzer
    FrenchAnalyzer
    IrishAnalyzer
    GalicianAnalyzer
    HindiAnalyzer
    HungarianAnalyzer
    ArmenianAnalyzer
    IndonesianAnalyzer
    ItalianAnalyzer
    LatvianAnalyzer
    NorwegianAnalyzer
    PortugueseAnalyzer
    RomanianAnalyzer
    RussianAnalyzer
    ClassicAnalyzer
    StandardAnalyzer
    UAX29URLEmailAnalyzer
    SwedishAnalyzer
    TurkishAnalyzer
    Implements
    System.IDisposable
    Inherited Members
    Analyzer.NewAnonymous(Func<String, TextReader, TokenStreamComponents>)
    Analyzer.NewAnonymous(Func<String, TextReader, TokenStreamComponents>, ReuseStrategy)
    Analyzer.NewAnonymous(Func<String, TextReader, TokenStreamComponents>, Func<String, TextReader, TextReader>)
    Analyzer.NewAnonymous(Func<String, TextReader, TokenStreamComponents>, Func<String, TextReader, TextReader>, ReuseStrategy)
    Analyzer.CreateComponents(String, TextReader)
    Analyzer.GetTokenStream(String, TextReader)
    Analyzer.GetTokenStream(String, String)
    Analyzer.InitReader(String, TextReader)
    Analyzer.GetPositionIncrementGap(String)
    Analyzer.GetOffsetGap(String)
    Lucene.Net.Analysis.Analyzer.Strategy
    Lucene.Net.Analysis.Analyzer.Dispose()
    Analyzer.Dispose(Boolean)
    Lucene.Net.Analysis.Analyzer.GLOBAL_REUSE_STRATEGY
    Lucene.Net.Analysis.Analyzer.PER_FIELD_REUSE_STRATEGY
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Lucene.Net.Analysis.Util
    Assembly: Lucene.Net.Analysis.Common.dll
    Syntax
    public abstract class StopwordAnalyzerBase : Analyzer, IDisposable

    Constructors

    | Improve this Doc View Source

    StopwordAnalyzerBase(LuceneVersion)

    Creates a new Lucene.Net.Analysis.Analyzer with an empty stopword set

    Declaration
    protected StopwordAnalyzerBase(LuceneVersion version)
    Parameters
    Type Name Description
    Lucene.Net.Util.LuceneVersion version

    the Lucene version for cross version compatibility

    | Improve this Doc View Source

    StopwordAnalyzerBase(LuceneVersion, CharArraySet)

    Creates a new instance initialized with the given stopword set

    Declaration
    protected StopwordAnalyzerBase(LuceneVersion version, CharArraySet stopwords)
    Parameters
    Type Name Description
    Lucene.Net.Util.LuceneVersion version

    the Lucene version for cross version compatibility

    CharArraySet stopwords

    the analyzer's stopword set

    Fields

    | Improve this Doc View Source

    m_matchVersion

    Declaration
    protected readonly LuceneVersion m_matchVersion
    Field Value
    Type Description
    Lucene.Net.Util.LuceneVersion
    | Improve this Doc View Source

    m_stopwords

    An immutable stopword set

    Declaration
    protected readonly CharArraySet m_stopwords
    Field Value
    Type Description
    CharArraySet

    Properties

    | Improve this Doc View Source

    StopwordSet

    Returns the analyzer's stopword set or an empty set if the analyzer has no stopwords

    Declaration
    public virtual CharArraySet StopwordSet { get; }
    Property Value
    Type Description
    CharArraySet

    the analyzer's stopword set or an empty set if the analyzer has no stopwords

    Methods

    | Improve this Doc View Source

    LoadStopwordSet(Boolean, Type, String, String)

    Creates a CharArraySet from an embedded resource associated with a class. (See System.Reflection.Assembly.GetManifestResourceStream(System.String)).

    Declaration
    protected static CharArraySet LoadStopwordSet(bool ignoreCase, Type aClass, string resource, string comment)
    Parameters
    Type Name Description
    System.Boolean ignoreCase

    true if the set should ignore the case of the stopwords, otherwise false

    System.Type aClass

    a class that is associated with the given stopwordResource

    System.String resource

    name of the resource file associated with the given class

    System.String comment

    comment string to ignore in the stopword file

    Returns
    Type Description
    CharArraySet

    a CharArraySet containing the distinct stopwords from the given file

    Exceptions
    Type Condition
    System.IO.IOException

    if loading the stopwords throws an System.IO.IOException

    | Improve this Doc View Source

    LoadStopwordSet(FileInfo, LuceneVersion)

    Creates a CharArraySet from a file.

    Declaration
    protected static CharArraySet LoadStopwordSet(FileInfo stopwords, LuceneVersion matchVersion)
    Parameters
    Type Name Description
    System.IO.FileInfo stopwords

    the stopwords file to load

    Lucene.Net.Util.LuceneVersion matchVersion

    the Lucene version for cross version compatibility

    Returns
    Type Description
    CharArraySet

    a CharArraySet containing the distinct stopwords from the given file

    Exceptions
    Type Condition
    System.IO.IOException

    if loading the stopwords throws an System.IO.IOException

    | Improve this Doc View Source

    LoadStopwordSet(TextReader, LuceneVersion)

    Creates a CharArraySet from a file.

    Declaration
    protected static CharArraySet LoadStopwordSet(TextReader stopwords, LuceneVersion matchVersion)
    Parameters
    Type Name Description
    System.IO.TextReader stopwords

    the stopwords reader to load

    Lucene.Net.Util.LuceneVersion matchVersion

    the Lucene version for cross version compatibility

    Returns
    Type Description
    CharArraySet

    a CharArraySet containing the distinct stopwords from the given reader

    Exceptions
    Type Condition
    System.IO.IOException

    if loading the stopwords throws an System.IO.IOException

    Implements

    System.IDisposable
    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 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.