public class LRUCache<K,V> extends SolrCacheBase implements SolrCache<K,V>, Accountable
SolrCacheBase.AutoWarmCountRef
SolrCache.State
SolrInfoBean.Category, SolrInfoBean.Group
Modifier and Type | Field and Description |
---|---|
static long |
DEFAULT_RAM_BYTES_USED |
static long |
HASHTABLE_RAM_BYTES_PER_ENTRY |
autowarm, regenerator
Constructor and Description |
---|
LRUCache() |
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
|
Collection<Accountable> |
getChildResources() |
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.
|
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.
|
V |
put(K key,
V value)
:TODO: copy from Map
|
long |
ramBytesUsed() |
int |
size()
:TODO: copy from Map
|
String |
toString() |
void |
warm(SolrIndexSearcher searcher,
SolrCache<K,V> old)
Warm this cache associated with
searcher using the old
cache object. |
calcHitRatio, getAutowarmDescription, getCategory, getState, getVersion, init, isAutowarmingOn, name, setState
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getCategory, getMetricsSnapshot, registerMetricName
initializeMetrics
public static final long DEFAULT_RAM_BYTES_USED
public static final long HASHTABLE_RAM_BYTES_PER_ENTRY
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 int size()
SolrCache
public void clear()
SolrCache
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()
SolrCache
public String getName()
SolrInfoBean
getName
in interface SolrInfoBean
public String getDescription()
SolrInfoBean
getDescription
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 void initializeMetrics(SolrMetricManager manager, String registryName, String tag, String scope)
SolrMetricProducer
Note: for back-compatibility this method by default calls SolrMetricProducer.initializeMetrics(SolrMetricManager, String, String)
.
initializeMetrics
in interface SolrMetricProducer
manager
- an instance of SolrMetricManager
registryName
- 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 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 long ramBytesUsed()
ramBytesUsed
in interface Accountable
public Collection<Accountable> getChildResources()
getChildResources
in interface Accountable
Copyright © 2000-2018 Apache Software Foundation. All Rights Reserved.