Package org.apache.solr.search

Interface SolrCache<K,​V>

    • Method Detail

      • init

        Object init​(Map<String,​String> args,
            Object persistence,
            CacheRegenerator regenerator)
        The initialization routine. Instance specific arguments are passed in the args map.

        The persistence object will exist across different lifetimes of similar caches. For example, all filter caches will share the same persistence object, sometimes at the same time (it must be thread-safe). If null is passed, then the cache implementation should create and return a new persistence object. If not null, the passed in object should be returned again.

        Since it will exist across the lifetime of many caches, care should be taken to not reference any particular cache instance and prevent it from being garbage collected (no using inner classes unless they are static).

        The persistence object is designed to be used as a way for statistics to accumulate across all instances of the same type of cache, however the object may be of any type desired by the cache implementation.

        The CacheRegenerator is what the cache uses during auto-warming to regenerate an item in the new cache from an entry in the old cache.

      • name

        String name()
        Name the Cache can be referenced with by SolrRequestHandlers.

        This method must return the identifier that the Cache instance expects SolrRequestHandlers to use when requesting access to it from the SolrIndexSearcher. It is strongly recommended that this method return the value of the "name" parameter from the init args.

        :TODO: verify this.

      • size

        int size()
        :TODO: copy from Map

      • put

        V put​(K key,
      V value)
        :TODO: copy from Map

      • get

        V get​(K key)
        :TODO: copy from Map

      • remove

        V remove​(K key)

      • computeIfAbsent

        V computeIfAbsent​(K key,
                  IOFunction<? super K,​? extends V> mappingFunction)
           throws IOException
        Get an existing element or atomically compute it if missing.
        Parameters:
        key - key
        mappingFunction - function to compute the element. If the function returns a null result the cache mapping will not be created. NOTE: this function must NOT attempt to modify any mappings in the cache.
        Returns:
        existing or newly computed value, null if there was no existing value and it was not possible to compute a new value (in which case the new mapping won't be created).
        Throws:
        IOException - if and only if mappingFunction threw an IOException. A cache mapping will not be created in this case

      • clear

        void clear()
        :TODO: copy from Map

      • setState

        void setState​(SolrCache.State state)
        Set different cache states. The state a cache is in can have an effect on how statistics are kept. The cache user (SolrIndexSearcher) will take care of switching cache states.

      • initialSearcher

        default void initialSearcher​(SolrIndexSearcher initialSearcher)
        A hook for caches that would like to perform some initialization for the first registered searcher. This method is analogous to warm(SolrIndexSearcher, SolrCache). The default implementation is a no-op. Implementers should not retain object references to the specified searcher.

      • warm

        void warm​(SolrIndexSearcher searcher,
          SolrCache<K,​V> old)
        Warm this cache associated with searcher using the old cache object. this and old will have the same concrete type.

      • getMaxSize

        int getMaxSize()
        Returns maximum size limit (number of items) if set and supported, -1 otherwise.

      • setMaxSize

        void setMaxSize​(int maxSize)
        Set maximum size limit (number of items), or -1 for unlimited. Note: this has effect only on implementations that support it, it's a no-op otherwise

      • getMaxRamMB

        int getMaxRamMB()
        Returns maximum size limit (in MB) if set and supported, -1 otherwise.

      • setMaxRamMB

        void setMaxRamMB​(int maxRamMB)
        Set maximum size limit (in MB), or -1 for unlimited. Note: this has effect only on implementations that support it, it's a no-op otherwise.