Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class KeepWordFilterFactory

    Factory for KeepWordFilter.

    <fieldType name="text_keepword" class="solr.TextField" positionIncrementGap="100">
      <analyzer>
        <tokenizer class="solr.WhitespaceTokenizerFactory"/>
        <filter class="solr.KeepWordFilterFactory" words="keepwords.txt" ignoreCase="false"/>
      </analyzer>
    </fieldType>
    Inheritance
    object
    AbstractAnalysisFactory
    TokenFilterFactory
    KeepWordFilterFactory
    Implements
    IResourceLoaderAware
    Inherited Members
    TokenFilterFactory.ForName(string, IDictionary<string, string>)
    TokenFilterFactory.LookupClass(string)
    TokenFilterFactory.AvailableTokenFilters
    TokenFilterFactory.ReloadTokenFilters()
    AbstractAnalysisFactory.LUCENE_MATCH_VERSION_PARAM
    AbstractAnalysisFactory.m_luceneMatchVersion
    AbstractAnalysisFactory.OriginalArgs
    AbstractAnalysisFactory.AssureMatchVersion()
    AbstractAnalysisFactory.LuceneMatchVersion
    AbstractAnalysisFactory.Require(IDictionary<string, string>, string)
    AbstractAnalysisFactory.Require(IDictionary<string, string>, string, ICollection<string>)
    AbstractAnalysisFactory.Require(IDictionary<string, string>, string, ICollection<string>, bool)
    AbstractAnalysisFactory.Get(IDictionary<string, string>, string, string)
    AbstractAnalysisFactory.Get(IDictionary<string, string>, string, ICollection<string>)
    AbstractAnalysisFactory.Get(IDictionary<string, string>, string, ICollection<string>, string)
    AbstractAnalysisFactory.Get(IDictionary<string, string>, string, ICollection<string>, string, bool)
    AbstractAnalysisFactory.RequireInt32(IDictionary<string, string>, string)
    AbstractAnalysisFactory.GetInt32(IDictionary<string, string>, string, int)
    AbstractAnalysisFactory.RequireBoolean(IDictionary<string, string>, string)
    AbstractAnalysisFactory.GetBoolean(IDictionary<string, string>, string, bool)
    AbstractAnalysisFactory.RequireSingle(IDictionary<string, string>, string)
    AbstractAnalysisFactory.GetSingle(IDictionary<string, string>, string, float)
    AbstractAnalysisFactory.RequireChar(IDictionary<string, string>, string)
    AbstractAnalysisFactory.GetChar(IDictionary<string, string>, string, char)
    AbstractAnalysisFactory.GetSet(IDictionary<string, string>, string)
    AbstractAnalysisFactory.GetPattern(IDictionary<string, string>, string)
    AbstractAnalysisFactory.GetCulture(IDictionary<string, string>, string, CultureInfo)
    AbstractAnalysisFactory.GetWordSet(IResourceLoader, string, bool)
    AbstractAnalysisFactory.GetLines(IResourceLoader, string)
    AbstractAnalysisFactory.GetSnowballWordSet(IResourceLoader, string, bool)
    AbstractAnalysisFactory.SplitFileNames(string)
    AbstractAnalysisFactory.GetClassArg()
    AbstractAnalysisFactory.IsExplicitLuceneMatchVersion
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Analysis.Miscellaneous
    Assembly: Lucene.Net.Analysis.Common.dll
    Syntax
    public class KeepWordFilterFactory : TokenFilterFactory, IResourceLoaderAware

    Constructors

    KeepWordFilterFactory(IDictionary<string, string>)

    Creates a new KeepWordFilterFactory

    Declaration
    public KeepWordFilterFactory(IDictionary<string, string> args)
    Parameters
    Type Name Description
    IDictionary<string, string> args

    Properties

    EnablePositionIncrements

    Factory for KeepWordFilter.

    <fieldType name="text_keepword" class="solr.TextField" positionIncrementGap="100">
      <analyzer>
        <tokenizer class="solr.WhitespaceTokenizerFactory"/>
        <filter class="solr.KeepWordFilterFactory" words="keepwords.txt" ignoreCase="false"/>
      </analyzer>
    </fieldType>
    Declaration
    public virtual bool EnablePositionIncrements { get; }
    Property Value
    Type Description
    bool

    IgnoreCase

    Factory for KeepWordFilter.

    <fieldType name="text_keepword" class="solr.TextField" positionIncrementGap="100">
      <analyzer>
        <tokenizer class="solr.WhitespaceTokenizerFactory"/>
        <filter class="solr.KeepWordFilterFactory" words="keepwords.txt" ignoreCase="false"/>
      </analyzer>
    </fieldType>
    Declaration
    public virtual bool IgnoreCase { get; }
    Property Value
    Type Description
    bool

    Words

    Factory for KeepWordFilter.

    <fieldType name="text_keepword" class="solr.TextField" positionIncrementGap="100">
      <analyzer>
        <tokenizer class="solr.WhitespaceTokenizerFactory"/>
        <filter class="solr.KeepWordFilterFactory" words="keepwords.txt" ignoreCase="false"/>
      </analyzer>
    </fieldType>
    Declaration
    public virtual CharArraySet Words { get; }
    Property Value
    Type Description
    CharArraySet

    Methods

    Create(TokenStream)

    Transform the specified input Lucene.Net.Analysis.TokenStream

    Declaration
    public override TokenStream Create(TokenStream input)
    Parameters
    Type Name Description
    TokenStream input
    Returns
    Type Description
    TokenStream
    Overrides
    TokenFilterFactory.Create(TokenStream)

    Inform(IResourceLoader)

    Initializes this component with the provided IResourceLoader (used for loading types, embedded resources, files, etc).

    Declaration
    public virtual void Inform(IResourceLoader loader)
    Parameters
    Type Name Description
    IResourceLoader loader

    Implements

    IResourceLoaderAware
    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.