Class SolrSuggester

  • All Implemented Interfaces:
    org.apache.lucene.util.Accountable

    public class SolrSuggester
    extends Object
    implements org.apache.lucene.util.Accountable
    Responsible for loading the lookup and dictionary Implementations specified by the SolrConfig. Interacts (query/build/reload) with Lucene Suggesters through Lookup and Dictionary
    • Field Detail

      • DEFAULT_DICT_NAME

        public static final String DEFAULT_DICT_NAME
        Name used when an unnamed suggester config is passed
        See Also:
        Constant Field Values
      • LOCATION

        public static final String LOCATION
        Location of the source data - either a path to a file, or null for the current IndexReader.
        See Also:
        Constant Field Values
      • LOOKUP_IMPL

        public static final String LOOKUP_IMPL
        Fully-qualified class of the Lookup implementation.
        See Also:
        Constant Field Values
      • DICTIONARY_IMPL

        public static final String DICTIONARY_IMPL
        Fully-qualified class of the Dictionary implementation
        See Also:
        Constant Field Values
      • STORE_DIR

        public static final String STORE_DIR
        Name of the location where to persist the dictionary. If this location is relative then the data will be stored under the core's dataDir. If this is null the storing will be disabled.
        See Also:
        Constant Field Values
    • Constructor Detail

      • SolrSuggester

        public SolrSuggester()
    • Method Detail

      • init

        public String init​(org.apache.solr.common.util.NamedList<?> config,
                           SolrCore core)
        Uses the config and the core to initialize the underlying Lucene suggester
      • reload

        public void reload()
                    throws IOException
        Reloads the underlying Lucene Suggester
        Throws:
        IOException
      • getStoreFile

        public Path getStoreFile()
        Returns:
        the file where this suggester is stored. null if no storeDir was configured
      • getName

        public String getName()
        Returns the unique name of the suggester
      • ramBytesUsed

        public long ramBytesUsed()
        Specified by:
        ramBytesUsed in interface org.apache.lucene.util.Accountable
      • getChildResources

        public Collection<org.apache.lucene.util.Accountable> getChildResources()
        Specified by:
        getChildResources in interface org.apache.lucene.util.Accountable