Package org.elasticsearch.index.cache.bitset

Class BitsetFilterCache

java.lang.Object

org.elasticsearch.index.AbstractIndexComponent

org.elasticsearch.index.cache.bitset.BitsetFilterCache

All Implemented Interfaces:

Closeable, AutoCloseable, IndexReader.ClosedListener, RemovalListener<IndexReader.CacheKey,Cache<Query,BitsetFilterCache.Value>>, IndexComponent

public final class BitsetFilterCache
extends AbstractIndexComponent
implements IndexReader.ClosedListener, RemovalListener<IndexReader.CacheKey,Cache<Query,BitsetFilterCache.Value>>, Closeable

This is a cache for BitDocIdSet based filters and is unbounded by size or time.

Use this cache with care, only components that require that a filter is to be materialized as a BitDocIdSet and require that it should always be around should use this cache, otherwise the QueryCache should be used instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BitsetFilterCache.Listener	A listener interface that is executed for each onCache / onRemoval event
static class	BitsetFilterCache.Value

Field Summary

Fields

Modifier and Type	Field	Description
static Setting<Boolean>	INDEX_LOAD_RANDOM_ACCESS_FILTERS_EAGERLY_SETTING

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

deprecationLogger, indexSettings, logger

Constructor Summary

Constructors

Constructor	Description
BitsetFilterCache(IndexSettings indexSettings, BitsetFilterCache.Listener listener)

Method Summary

Modifier and Type	Method	Description
static BitSet	bitsetFromQuery(Query query, LeafReaderContext context)
void	clear(String reason)
void	close()
IndexWarmer.Listener	createListener(ThreadPool threadPool)
BitSetProducer	getBitSetProducer(Query query)
void	onClose(IndexReader.CacheKey ownerCoreCacheKey)	Invoked when the resource (segment core, or index reader) that is being cached on is closed.
void	onRemoval(RemovalNotification<IndexReader.CacheKey,Cache<Query,BitsetFilterCache.Value>> notification)

Methods inherited from class org.elasticsearch.index.AbstractIndexComponent

getIndexSettings, index

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_LOAD_RANDOM_ACCESS_FILTERS_EAGERLY_SETTING

public static final Setting<Boolean> INDEX_LOAD_RANDOM_ACCESS_FILTERS_EAGERLY_SETTING

Constructor Detail

BitsetFilterCache

public BitsetFilterCache(IndexSettings indexSettings,
                         BitsetFilterCache.Listener listener)

Method Detail

bitsetFromQuery

public static BitSet bitsetFromQuery(Query query,
                                     LeafReaderContext context)
                              throws IOException

Throws:

IOException

createListener

public IndexWarmer.Listener createListener(ThreadPool threadPool)

getBitSetProducer

public BitSetProducer getBitSetProducer(Query query)

onClose

public void onClose(IndexReader.CacheKey ownerCoreCacheKey)

Description copied from interface: IndexReader.ClosedListener

Invoked when the resource (segment core, or index reader) that is being cached on is closed.

Specified by:

onClose in interface IndexReader.ClosedListener

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

clear

public void clear(String reason)

onRemoval

public void onRemoval(RemovalNotification<IndexReader.CacheKey,Cache<Query,BitsetFilterCache.Value>> notification)

Specified by:

onRemoval in interface RemovalListener<IndexReader.CacheKey,Cache<Query,BitsetFilterCache.Value>>