org.apache.solr.search

Class SolrCacheHolder<K,V>

java.lang.Object

org.apache.solr.search.SolrCacheHolder<K,V>

All Implemented Interfaces:

AutoCloseable, SolrInfoBean, SolrMetricProducer, SolrCache<K,V>

public class SolrCacheHolder<K,V>
extends Object
implements SolrCache<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.solr.search.SolrCache

SolrCache.State

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields

Modifier and Type	Field and Description
protected SolrCache<K,V>	delegate

Fields inherited from interface org.apache.solr.search.SolrCache

CLEANUP_THREAD_PARAM, EVICTIONS_PARAM, HIT_RATIO_PARAM, HITS_PARAM, INITIAL_SIZE_PARAM, INSERTS_PARAM, LOOKUPS_PARAM, MAX_IDLE_TIME_PARAM, MAX_RAM_MB_PARAM, MAX_SIZE_PARAM, RAM_BYTES_USED_PARAM, SHOW_ITEMS_PARAM, SIZE_PARAM

Constructor Summary

Constructors

Constructor and Description
SolrCacheHolder(SolrCache<K,V> delegate, CacheConfig factory)

Method Summary

Modifier and Type	Method and Description
void	clear() :TODO: copy from Map
void	close() Frees any non-memory resources
V	computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction) Get an existing element or atomically compute it if missing.
SolrCache<K,V>	get()
V	get(K key) :TODO: copy from Map
SolrInfoBean.Category	getCategory() Category of this component
String	getDescription() Simple one or two line description
int	getMaxRamMB() Returns maximum size limit (in MB) if set and supported, -1 otherwise.
int	getMaxSize() Returns maximum size limit (number of items) if set and supported, -1 otherwise.
Set<String>	getMetricNames() Modifiable set of metric names that this component reports (default is null, which means none).
com.codahale.metrics.MetricRegistry	getMetricRegistry() An instance of MetricRegistry that this component uses for metrics reporting (default is null, which means no registry).
String	getName() Simple common usage name, e.g.
SolrCache.State	getState() Returns the last State set on this instance
Object	init(Map args, Object persistence, CacheRegenerator regenerator) The initialization routine.
void	initializeMetrics(SolrMetricsContext parentContext, String scope) Initialize metrics specific to this producer.
String	name() Name the Cache can be referenced with by SolrRequestHandlers.
V	put(K key, V value) :TODO: copy from Map
V	remove(K key)
void	setMaxRamMB(int maxRamMB) Set maximum size limit (in MB), or -1 for unlimited.
void	setMaxSize(int maxSize) Set maximum size limit (number of items), or -1 for unlimited.
void	setState(SolrCache.State state) Set different cache states.
int	size() :TODO: copy from Map
void	warm(SolrIndexSearcher searcher, SolrCache<K,V> old) Warm this cache associated with searcher using the old cache object.
void	warm(SolrIndexSearcher searcher, SolrCacheHolder src)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.solr.core.SolrInfoBean

getMetricsSnapshot, registerMetricName

Methods inherited from interface org.apache.solr.metrics.SolrMetricProducer

getSolrMetricsContext, getUniqueMetricTag, initializeMetrics

Field Detail

delegate

protected volatile SolrCache<K,V> delegate

Constructor Detail

SolrCacheHolder

public SolrCacheHolder(SolrCache<K,V> delegate,
                       CacheConfig factory)

Method Detail

size

public int size()

Description copied from interface: SolrCache

:TODO: copy from Map

Specified by:

size in interface SolrCache<K,V>

put

public V put(K key,
             V value)

Description copied from interface: SolrCache

:TODO: copy from Map

Specified by:

put in interface SolrCache<K,V>

remove

public V remove(K key)

Specified by:

remove in interface SolrCache<K,V>

computeIfAbsent

public V computeIfAbsent(K key,
                         Function<? super K,? extends V> mappingFunction)

Description copied from interface: SolrCache

Get an existing element or atomically compute it if missing.

Specified by:

computeIfAbsent in interface SolrCache<K,V>

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).

get

public V get(K key)

Description copied from interface: SolrCache

:TODO: copy from Map

Specified by:

get in interface SolrCache<K,V>

clear

public void clear()

Description copied from interface: SolrCache

:TODO: copy from Map

Specified by:

clear in interface SolrCache<K,V>

setState

public void setState(SolrCache.State state)

Description copied from interface: SolrCache

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.

Specified by:

setState in interface SolrCache<K,V>

getState

public SolrCache.State getState()

Description copied from interface: SolrCache

Returns the last State set on this instance

Specified by:

getState in interface SolrCache<K,V>

See Also:

SolrCache.setState(org.apache.solr.search.SolrCache.State)

warm

public void warm(SolrIndexSearcher searcher,
                 SolrCache<K,V> old)

Description copied from interface: SolrCache

Warm this cache associated with searcher using the old cache object. this and old will have the same concrete type.

Specified by:

warm in interface SolrCache<K,V>

get

public SolrCache<K,V> get()

close

public void close()
           throws Exception

Description copied from interface: SolrCache

Frees any non-memory resources

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SolrMetricProducer

Specified by:

close in interface SolrCache<K,V>

Throws:

Exception

getMaxSize

public int getMaxSize()

Description copied from interface: SolrCache

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

Specified by:

getMaxSize in interface SolrCache<K,V>

setMaxSize

public void setMaxSize(int maxSize)

Description copied from interface: SolrCache

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

Specified by:

setMaxSize in interface SolrCache<K,V>

getMaxRamMB

public int getMaxRamMB()

Description copied from interface: SolrCache

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

Specified by:

getMaxRamMB in interface SolrCache<K,V>

setMaxRamMB

public void setMaxRamMB(int maxRamMB)

Description copied from interface: SolrCache

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.

Specified by:

setMaxRamMB in interface SolrCache<K,V>

warm

public void warm(SolrIndexSearcher searcher,
                 SolrCacheHolder src)

init

public Object init(Map args,
                   Object persistence,
                   CacheRegenerator regenerator)

Description copied from interface: SolrCache

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.

Specified by:

init in interface SolrCache<K,V>

name

public String name()

Description copied from interface: SolrCache

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.

Specified by:

name in interface SolrCache<K,V>

getName

public String getName()

Description copied from interface: SolrInfoBean

Simple common usage name, e.g. BasicQueryHandler, or fully qualified class name.

Specified by:

getName in interface SolrInfoBean

getMetricRegistry

public com.codahale.metrics.MetricRegistry getMetricRegistry()

Description copied from interface: SolrInfoBean

An instance of MetricRegistry that this component uses for metrics reporting (default is null, which means no registry).

Specified by:

getMetricRegistry in interface SolrInfoBean

getMetricNames

public Set<String> getMetricNames()

Description copied from interface: SolrInfoBean

Modifiable set of metric names that this component reports (default is null, which means none). If not null then this set is used by SolrInfoBean.registerMetricName(String) to capture what metrics names are reported from this component.

NOTE: this set has to allow iteration under modifications.

Specified by:

getMetricNames in interface SolrInfoBean

getDescription

public String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

getCategory

public SolrInfoBean.Category getCategory()

Description copied from interface: SolrInfoBean

Category of this component

Specified by:

getCategory in interface SolrInfoBean

initializeMetrics

public void initializeMetrics(SolrMetricsContext parentContext,
                              String scope)

Description copied from interface: SolrMetricProducer

Initialize metrics specific to this producer.

Specified by:

initializeMetrics in interface SolrMetricProducer

Parameters:

parentContext - parent metrics context. If this component has the same life-cycle as the parent it can simply use the parent context, otherwise it should obtain a child context using SolrMetricsContext.getChildContext(Object) passing this as the child.

scope - component scope