Package org.apache.lucene.search.suggest.analyzing

Class SuggestStopFilterFactory

  • All Implemented Interfaces:
    ResourceLoaderAware
    public class SuggestStopFilterFactory
extends TokenFilterFactory
implements ResourceLoaderAware
    Factory for SuggestStopFilter. 
     <fieldType name="autosuggest" class="solr.TextField" 
            positionIncrementGap="100" autoGeneratePhraseQueries="true">
   <analyzer>
     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
     <filter class="solr.LowerCaseFilterFactory"/>
     <filter class="solr.SuggestStopFilterFactory" 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 EnglishAnalyzer.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 beginning with the "#" character. Blank lines are ignored. See WordlistLoader.getLines 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 WordlistLoader.getSnowballWordSet for details.
    Since:
    5.0.0

    • Field Detail

      • FORMAT_WORDSET

        public static final java.lang.String FORMAT_WORDSET
        the default format, one word per line, whole line comments start with "#"
        See Also:
        Constant Field Values

      • FORMAT_SNOWBALL

        public static final java.lang.String FORMAT_SNOWBALL
        multiple words may be specified on each line, trailing comments start with "|"
        See Also:
        Constant Field Values

      • stopWordFiles

        private final java.lang.String stopWordFiles

      • format

        private final java.lang.String format

      • ignoreCase

        private final boolean ignoreCase

    • Constructor Detail

      • SuggestStopFilterFactory

        public SuggestStopFilterFactory​(java.util.Map<java.lang.String,​java.lang.String> args)
        Creates a new StopFilterFactory

    • Method Detail

      • inform

        public void inform​(ResourceLoader loader)
            throws java.io.IOException
        Description copied from interface: ResourceLoaderAware
        Initializes this component with the provided ResourceLoader (used for loading classes, files, etc).
        Specified by:
        inform in interface ResourceLoaderAware
        Throws:
        java.io.IOException

      • isIgnoreCase

        public boolean isIgnoreCase()
        Whether or not to ignore case

      • getStopWords

        public CharArraySet getStopWords()
        Returns the configured stopword set