public class SolrCacheHolder<K,V> extends Object implements SolrCache<K,V>
SolrCache.State
SolrInfoBean.Category, SolrInfoBean.Group
Modifier and Type | Field and Description |
---|---|
protected SolrCache<K,V> |
delegate |
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 and Description |
---|
SolrCacheHolder(SolrCache<K,V> delegate,
CacheConfig factory) |
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) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getMetricsSnapshot, registerMetricName
getSolrMetricsContext, getUniqueMetricTag, initializeMetrics
public SolrCacheHolder(SolrCache<K,V> delegate, CacheConfig factory)
public int size()
SolrCache
public V computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)
SolrCache
computeIfAbsent
in interface SolrCache<K,V>
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.public void clear()
SolrCache
public void setState(SolrCache.State state)
SolrCache
public SolrCache.State getState()
SolrCache
getState
in interface SolrCache<K,V>
SolrCache.setState(org.apache.solr.search.SolrCache.State)
public void warm(SolrIndexSearcher searcher, SolrCache<K,V> old)
SolrCache
searcher
using the old
cache object. this
and old
will have the same concrete type.public void close() throws Exception
SolrCache
close
in interface AutoCloseable
close
in interface SolrMetricProducer
close
in interface SolrCache<K,V>
Exception
public int getMaxSize()
SolrCache
getMaxSize
in interface SolrCache<K,V>
public void setMaxSize(int maxSize)
SolrCache
setMaxSize
in interface SolrCache<K,V>
public int getMaxRamMB()
SolrCache
getMaxRamMB
in interface SolrCache<K,V>
public void setMaxRamMB(int maxRamMB)
SolrCache
setMaxRamMB
in interface SolrCache<K,V>
public void warm(SolrIndexSearcher searcher, SolrCacheHolder src)
public Object init(Map args, Object persistence, CacheRegenerator regenerator)
SolrCache
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.
public String name()
SolrCache
public String getName()
SolrInfoBean
getName
in interface SolrInfoBean
public com.codahale.metrics.MetricRegistry getMetricRegistry()
SolrInfoBean
MetricRegistry
that this component uses for metrics reporting
(default is null, which means no registry).getMetricRegistry
in interface SolrInfoBean
public Set<String> getMetricNames()
SolrInfoBean
SolrInfoBean.registerMetricName(String)
to capture what metrics names are reported from this component.
NOTE: this set has to allow iteration under modifications.
getMetricNames
in interface SolrInfoBean
public String getDescription()
SolrInfoBean
getDescription
in interface SolrInfoBean
public SolrInfoBean.Category getCategory()
SolrInfoBean
getCategory
in interface SolrInfoBean
public void initializeMetrics(SolrMetricsContext parentContext, String scope)
SolrMetricProducer
initializeMetrics
in interface SolrMetricProducer
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 scopeCopyright © 2000-2020 Apache Software Foundation. All Rights Reserved.