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
,
SolrCache
SolrCache.State
SolrInfoMBean.Category, SolrInfoMBean.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
|
SolrInfoMBean.Category |
getCategory()
Purpose of this Class
|
String |
getDescription()
Simple one or two line description
|
URL[] |
getDocs()
Documentation URL list.
|
String |
getName()
Simple common usage name, e.g.
|
String |
getSource()
CVS Source, SVN Source, etc
|
SolrCache.State |
getState()
Returns the last State set on this instance
|
NamedList |
getStatistics()
Any statistics this instance would like to be publicly available via
the Solr Administration interface.
|
String |
getVersion()
Simple common usage version, e.g.
|
Object |
init(Map args,
Object persistence,
CacheRegenerator regenerator)
The initialization routine.
|
void |
initializeMetrics(SolrMetricManager manager,
String registry,
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. |
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 int size()
SolrCache
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 old)
SolrCache
searcher
using the old
cache object. this
and old
will have the same concrete type.public void close()
SolrCache
public String getName()
SolrInfoMBean
getName
in interface SolrInfoMBean
public String getVersion()
SolrInfoMBean
getVersion
in interface SolrInfoMBean
public String getDescription()
SolrInfoMBean
getDescription
in interface SolrInfoMBean
public SolrInfoMBean.Category getCategory()
SolrInfoMBean
getCategory
in interface SolrInfoMBean
public String getSource()
SolrInfoMBean
getSource
in interface SolrInfoMBean
public URL[] getDocs()
SolrInfoMBean
Suggested documentation URLs: Homepage for sponsoring project, FAQ on class usage, Design doc for class, Wiki, bug reporting URL, etc...
getDocs
in interface SolrInfoMBean
public NamedList getStatistics()
SolrInfoMBean
Any Object type may be stored in the list, but only the
toString()
representation will be used.
getStatistics
in interface SolrInfoMBean
public void initializeMetrics(SolrMetricManager manager, String registry, String scope)
SolrMetricProducer
initializeMetrics
in interface SolrMetricProducer
manager
- an instance of SolrMetricManager
registry
- registry name where metrics are registeredscope
- scope of the metrics (eg. handler name) to separate metrics of
instances of the same component executing in different contextsCopyright © 2000-2017 Apache Software Foundation. All Rights Reserved.