Class ManagedStopFilterFactory

  • All Implemented Interfaces:
    org.apache.lucene.analysis.util.ResourceLoaderAware, ManagedResourceObserver

    public class ManagedStopFilterFactory
    extends BaseManagedTokenFilterFactory
    TokenFilterFactory that uses the ManagedWordSetResource implementation for managing stop words using the REST API.
    Since:
    4.8.0
    • Field Summary

      • Fields inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory

        LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.apache.lucene.analysis.TokenStream create​(org.apache.lucene.analysis.TokenStream input)
      Returns a StopFilter based on our managed stop word set.
      protected Class<? extends ManagedResource> getManagedResourceImplClass()
      Returns the implementation class for managing stop words.
      String getResourceId()
      This analysis component knows the most logical "path" for which to manage stop words from.
      void onManagedResourceInitialized​(NamedList<?> args, ManagedResource res)
      Callback invoked by the ManagedResource instance to trigger this class to create the CharArraySet used to create the StopFilter using the wordset managed by ManagedWordSetResource.
      • Methods inherited from class org.apache.lucene.analysis.util.TokenFilterFactory

        availableTokenFilters, forName, lookupClass, reloadTokenFilters
      • Methods inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory

        get, get, get, get, get, getBoolean, getChar, getClassArg, getFloat, getInt, getLines, getLuceneMatchVersion, getOriginalArgs, getPattern, getSet, getSnowballWordSet, getWordSet, isExplicitLuceneMatchVersion, require, require, require, requireBoolean, requireChar, requireFloat, requireInt, setExplicitLuceneMatchVersion, splitAt, splitFileNames
    • Constructor Detail

      • ManagedStopFilterFactory

        public ManagedStopFilterFactory​(Map<String,​String> args)
        Initialize the managed "handle"
    • Method Detail

      • onManagedResourceInitialized

        public void onManagedResourceInitialized​(NamedList<?> args,
                                                 ManagedResource res)
                                          throws SolrException
        Callback invoked by the ManagedResource instance to trigger this class to create the CharArraySet used to create the StopFilter using the wordset managed by ManagedWordSetResource. Keep in mind that a schema.xml may reuse the same ManagedStopFilterFactory many times for different field types; behind the scenes all instances of this class/handle combination share the same managed data, hence the need for a listener/callback scheme.
        Throws:
        SolrException
      • create

        public org.apache.lucene.analysis.TokenStream create​(org.apache.lucene.analysis.TokenStream input)
        Returns a StopFilter based on our managed stop word set.
        Specified by:
        create in class org.apache.lucene.analysis.util.TokenFilterFactory