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 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 Description SolrCacheHolder(SolrCache<K,V> delegate, CacheConfig factory)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
:TODO: copy from Mapvoid
close()
Frees any non-memory resourcesV
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 MapSolrInfoBean.Category
getCategory()
Category of this componentString
getDescription()
Simple one or two line descriptionint
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 ofMetricRegistry
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 instanceObject
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 MapV
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 Mapvoid
warm(SolrIndexSearcher searcher, SolrCache<K,V> old)
Warm this cache associated withsearcher
using theold
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, initializeMetrics
-
-
-
-
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
-
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 interfaceSolrCache<K,V>
- Parameters:
key
- keymappingFunction
- 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).
-
clear
public void clear()
Description copied from interface:SolrCache
:TODO: copy from Map
-
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.
-
getState
public SolrCache.State getState()
Description copied from interface:SolrCache
Returns the last State set on this instance- Specified by:
getState
in interfaceSolrCache<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 withsearcher
using theold
cache object.this
andold
will have the same concrete type.
-
close
public void close() throws Exception
Description copied from interface:SolrCache
Frees any non-memory resources- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceSolrCache<K,V>
- Specified by:
close
in interfaceSolrMetricProducer
- 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 interfaceSolrCache<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 interfaceSolrCache<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 interfaceSolrCache<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 interfaceSolrCache<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 theargs
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
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.
-
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 interfaceSolrInfoBean
-
getMetricRegistry
public com.codahale.metrics.MetricRegistry getMetricRegistry()
Description copied from interface:SolrInfoBean
An instance ofMetricRegistry
that this component uses for metrics reporting (default is null, which means no registry).- Specified by:
getMetricRegistry
in interfaceSolrInfoBean
-
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 bySolrInfoBean.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 interfaceSolrInfoBean
-
getDescription
public String getDescription()
Description copied from interface:SolrInfoBean
Simple one or two line description- Specified by:
getDescription
in interfaceSolrInfoBean
-
getCategory
public SolrInfoBean.Category getCategory()
Description copied from interface:SolrInfoBean
Category of this component- Specified by:
getCategory
in interfaceSolrInfoBean
-
initializeMetrics
public void initializeMetrics(SolrMetricsContext parentContext, String scope)
Description copied from interface:SolrMetricProducer
Initialize metrics specific to this producer.- Specified by:
initializeMetrics
in interfaceSolrMetricProducer
- 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 usingSolrMetricsContext.getChildContext(Object)
passingthis
as the child.scope
- component scope
-
-