Class StopFilterFactory

Factory for StopFilter.

<fieldType name="text_stop" class="solr.TextField" positionIncrementGap="100" autoGeneratePhraseQueries="true">
  <analyzer>
    <tokenizer class="solr.WhitespaceTokenizerFactory"/>
    <filter class="solr.StopFilterFactory" ignoreCase="true"
            words="stopwords.txt" format="wordset" />
  </analyzer>
</fieldType>

All attributes are optional:

  • ignoreCase defaults to false
  • words should be the name of a stopwords file to parse, if not specified the factory will use ENGLISH_STOP_WORDS_SET
  • format defines how the words file will be parsed, and defaults to wordset. If words is not specified, then format must not be specified.

The valid values for the format option are:

  • wordset - This is the default format, which supports one word per line (including any intra-word whitespace) and allows whole line comments begining with the "#" character. Blank lines are ignored. See GetLines(Stream, Encoding) for details.
  • snowball - This format allows for multiple words specified on each line, and trailing comments may be specified using the vertical line ("|"). Blank lines are ignored. See GetSnowballWordSet(TextReader, LuceneVersion) for details.

Inheritance
System.Object
AbstractAnalysisFactory
TokenFilterFactory
StopFilterFactory
Inherited Members
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.Core
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
public class StopFilterFactory : TokenFilterFactory, IResourceLoaderAware

Constructors

| Improve this Doc View Source

StopFilterFactory(IDictionary<String, String>)

Creates a new StopFilterFactory

Declaration
public StopFilterFactory(IDictionary<string, string> args)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.String, System.String> args

Fields

| Improve this Doc View Source

FORMAT_SNOWBALL

Declaration
public const string FORMAT_SNOWBALL = "snowball"
Field Value
Type Description
System.String
| Improve this Doc View Source

FORMAT_WORDSET

Declaration
public const string FORMAT_WORDSET = "wordset"
Field Value
Type Description
System.String

Properties

| Improve this Doc View Source

EnablePositionIncrements

Declaration
public virtual bool EnablePositionIncrements { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IgnoreCase

Declaration
public virtual bool IgnoreCase { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

StopWords

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

Methods

| Improve this Doc View Source

Create(TokenStream)

Declaration
public override TokenStream Create(TokenStream input)
Parameters
Type Name Description
TokenStream input
Returns
Type Description
TokenStream
Overrides
| Improve this Doc View Source

Inform(IResourceLoader)

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

Implements