public class LFUCache<K,V> extends Object implements SolrCache<K,V>
This implementation does not use a separate cleanup thread. Instead it uses the calling thread itself to do the cleanup when the size of the cache exceeds certain limits.
Also see SolrCaching
This API is experimental and subject to change
ConcurrentLFUCache,
SolrCacheSolrCache.StateSolrInfoBean.Category, SolrInfoBean.Group| Constructor and Description |
|---|
LFUCache() |
| Modifier and Type | Method and Description |
|---|---|
void |
clear()
:TODO: copy from Map
|
void |
close()
Frees any non-memory resources
|
V |
get(K key)
:TODO: copy from Map
|
SolrInfoBean.Category |
getCategory()
Category of this component
|
String |
getDescription()
Simple one or two line description
|
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(SolrMetricManager manager,
String registryName,
String tag,
String scope)
Initializes 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
|
void |
setState(SolrCache.State state)
Set different cache states.
|
int |
size()
:TODO: copy from Map
|
String |
toString() |
void |
warm(SolrIndexSearcher searcher,
SolrCache old)
Warm this cache associated with
searcher using the old
cache object. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetMetricsSnapshot, registerMetricNameinitializeMetricspublic Object init(Map args, Object persistence, CacheRegenerator regenerator)
SolrCacheargs 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()
SolrCachepublic int size()
SolrCachepublic void clear()
SolrCachepublic void setState(SolrCache.State state)
SolrCachepublic SolrCache.State getState()
SolrCachegetState in interface SolrCache<K,V>SolrCache.setState(org.apache.solr.search.SolrCache.State)public void warm(SolrIndexSearcher searcher, SolrCache old)
SolrCachesearcher using the old
cache object. this and old will have the same concrete type.public void close()
SolrCachepublic String getName()
SolrInfoBeangetName in interface SolrInfoBeanpublic String getDescription()
SolrInfoBeangetDescription in interface SolrInfoBeanpublic SolrInfoBean.Category getCategory()
SolrInfoBeangetCategory in interface SolrInfoBeanpublic void initializeMetrics(SolrMetricManager manager, String registryName, String tag, String scope)
SolrMetricProducerNote: for back-compatibility this method by default calls SolrMetricProducer.initializeMetrics(SolrMetricManager, String, String).
initializeMetrics in interface SolrMetricProducermanager - an instance of SolrMetricManagerregistryName - registry name where metrics are registeredtag - symbolic tag that represents a group of related instances that
have the same life-cycle. Parent component can use the tag when
calling SolrMetricManager.unregisterGauges(String, String)
to unregister metrics created by this instance of the producer.scope - scope of the metrics (eg. handler name) to separate metrics of
instances of the same component executing in different contextspublic Set<String> getMetricNames()
SolrInfoBeanSolrInfoBean.registerMetricName(String)
to capture what metrics names are reported from this component.
NOTE: this set has to allow iteration under modifications.
getMetricNames in interface SolrInfoBeanpublic com.codahale.metrics.MetricRegistry getMetricRegistry()
SolrInfoBeanMetricRegistry that this component uses for metrics reporting
(default is null, which means no registry).getMetricRegistry in interface SolrInfoBeanCopyright © 2000-2018 Apache Software Foundation. All Rights Reserved.