Package org.apache.solr.search

Class LRUCache<K,V>

java.lang.Object

org.apache.solr.search.SolrCacheBase

org.apache.solr.search.LRUCache<K,V>

All Implemented Interfaces:

org.apache.lucene.util.Accountable, SolrInfoBean, SolrMetricProducer, SolrCache<K,V>

public class LRUCache<K,V>
extends SolrCacheBase
implements SolrCache<K,V>, org.apache.lucene.util.Accountable

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.search.SolrCacheBase

SolrCacheBase.AutoWarmCountRef

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
static long	DEFAULT_RAM_BYTES_USED
static long	HASHTABLE_RAM_BYTES_PER_ENTRY

Fields inherited from class org.apache.solr.search.SolrCacheBase

autowarm, regenerator

Constructor Summary

Constructors

Constructor	Description
LRUCache()

Method Summary

Modifier and Type	Method	Description
void	clear()	:TODO: copy from Map
void	close()	Frees any non-memory resources
V	get(K key)	:TODO: copy from Map
Collection<org.apache.lucene.util.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.

Methods inherited from class org.apache.solr.search.SolrCacheBase

calcHitRatio, getAutowarmDescription, getCategory, getState, getVersion, init, isAutowarmingOn, name, setState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.solr.search.SolrCache

getState, name, setState

Methods inherited from interface org.apache.solr.core.SolrInfoBean

getCategory, getMetricsSnapshot, registerMetricName

Field Detail

DEFAULT_RAM_BYTES_USED

public static final long DEFAULT_RAM_BYTES_USED

See Also:

Constant Field Values

HASHTABLE_RAM_BYTES_PER_ENTRY

public static final long HASHTABLE_RAM_BYTES_PER_ENTRY

Constructor Detail

LRUCache

public LRUCache()

Method Detail

init

public Object init(Map args,
                   Object persistence,
                   CacheRegenerator regenerator)

Description copied from interface: SolrCache

The initialization routine. Instance specific arguments are passed in the 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.

Specified by:

init in interface SolrCache<K,V>

size

public int size()

Description copied from interface: SolrCache

:TODO: copy from Map

Specified by:

size in interface SolrCache<K,V>

put

public V put(K key,
             V value)

Description copied from interface: SolrCache

:TODO: copy from Map

Specified by:

put in interface SolrCache<K,V>

get

public V get(K key)

Description copied from interface: SolrCache

:TODO: copy from Map

Specified by:

get in interface SolrCache<K,V>

clear

public void clear()

Description copied from interface: SolrCache

:TODO: copy from Map

Specified by:

clear in interface SolrCache<K,V>

warm

public void warm(SolrIndexSearcher searcher,
                 SolrCache<K,V> old)

Description copied from interface: SolrCache

Warm this cache associated with searcher using the old cache object. this and old will have the same concrete type.

Specified by:

warm in interface SolrCache<K,V>

close

public void close()

Description copied from interface: SolrCache

Frees any non-memory resources

Specified by:

close in interface SolrCache<K,V>

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 interface SolrInfoBean

getDescription

public String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

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 by SolrInfoBean.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 interface SolrInfoBean

initializeMetrics

public void initializeMetrics(SolrMetricManager manager,
                              String registryName,
                              String tag,
                              String scope)

Description copied from interface: SolrMetricProducer

Initializes metrics specific to this producer

Specified by:

initializeMetrics in interface SolrMetricProducer

Parameters:

manager - an instance of SolrMetricManager

registryName - registry name where metrics are registered

tag - a symbolic tag that represents this instance of the producer, or a group of related instances that have the same life-cycle. This tag is used when managing life-cycle of some metrics and is set when SolrMetricProducer.initializeMetrics(SolrMetricManager, String, String, String) is called.

scope - scope of the metrics (eg. handler name) to separate metrics of

getMetricRegistry

public com.codahale.metrics.MetricRegistry getMetricRegistry()

Description copied from interface: SolrInfoBean

An instance of MetricRegistry that this component uses for metrics reporting (default is null, which means no registry).

Specified by:

getMetricRegistry in interface SolrInfoBean

toString

public String toString()

Overrides:

toString in class Object

ramBytesUsed

public long ramBytesUsed()

Specified by:

ramBytesUsed in interface org.apache.lucene.util.Accountable

getChildResources

public Collection<org.apache.lucene.util.Accountable> getChildResources()

Specified by:

getChildResources in interface org.apache.lucene.util.Accountable