Package org.apache.solr.rest.schema.analysis

Class ManagedStopFilterFactory

  • All Implemented Interfaces:
    org.apache.lucene.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
    SPI Name (case-insensitive: if the name is 'htmlStrip', 'htmlstrip' can be used when looking up the service).
    "managedStop"

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String NAME
      SPI name

      • Fields inherited from class org.apache.lucene.analysis.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​(org.apache.solr.common.util.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.TokenFilterFactory

        availableTokenFilters, findSPIName, forName, lookupClass, normalize, reloadTokenFilters

      • Methods inherited from class org.apache.lucene.analysis.AbstractAnalysisFactory

        defaultCtorException, 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"

      • ManagedStopFilterFactory

        public ManagedStopFilterFactory()
        Default ctor for compatibility with SPI

    • Method Detail

      • onManagedResourceInitialized

        public void onManagedResourceInitialized​(org.apache.solr.common.util.NamedList<?> args,
                                         ManagedResource res)
                                  throws org.apache.solr.common.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:
        org.apache.solr.common.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.TokenFilterFactory