org.elasticsearch.index.cache.bitset

Class BitsetFilterCache

java.lang.Object

org.elasticsearch.index.AbstractIndexComponent

org.elasticsearch.index.cache.bitset.BitsetFilterCache

All Implemented Interfaces:

com.google.common.cache.RemovalListener<Object,com.google.common.cache.Cache<org.apache.lucene.search.Query,BitsetFilterCache.Value>>, Closeable, AutoCloseable, org.apache.lucene.index.LeafReader.CoreClosedListener, IndexComponent

public class BitsetFilterCache
extends AbstractIndexComponent
implements org.apache.lucene.index.LeafReader.CoreClosedListener, com.google.common.cache.RemovalListener<Object,com.google.common.cache.Cache<org.apache.lucene.search.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 and 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 and Description
static String	LOAD_RANDOM_ACCESS_FILTERS_EAGERLY

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

deprecationLogger, index, indexSettings, logger

Constructor Summary

Constructors

Constructor and Description
BitsetFilterCache(Index index, IndexSettingsService indexSettingsService)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear(String reason)
void	close()
org.apache.lucene.search.join.BitSetProducer	getBitSetProducer(org.apache.lucene.search.Query query)
void	onClose(Object ownerCoreCacheKey)
void	onRemoval(com.google.common.cache.RemovalNotification<Object,com.google.common.cache.Cache<org.apache.lucene.search.Query,BitsetFilterCache.Value>> notification)
void	setIndicesWarmer(IndicesWarmer indicesWarmer)
void	setListener(BitsetFilterCache.Listener listener) Sets a listener that is invoked for all subsequent cache and removal events.

Methods inherited from class org.elasticsearch.index.AbstractIndexComponent

index, indexSettings

Methods inherited from class java.lang.Object

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

Field Detail

LOAD_RANDOM_ACCESS_FILTERS_EAGERLY

public static final String LOAD_RANDOM_ACCESS_FILTERS_EAGERLY

See Also:

Constant Field Values

Constructor Detail

BitsetFilterCache

@Inject
public BitsetFilterCache(Index index,
                        IndexSettingsService indexSettingsService)

Method Detail

setIndicesWarmer

@Inject(optional=true)
public void setIndicesWarmer(IndicesWarmer indicesWarmer)

setListener

public void setListener(BitsetFilterCache.Listener listener)

Sets a listener that is invoked for all subsequent cache and removal events.

Throws:

IllegalStateException - if the listener is set more than once

getBitSetProducer

public org.apache.lucene.search.join.BitSetProducer getBitSetProducer(org.apache.lucene.search.Query query)

onClose

public void onClose(Object ownerCoreCacheKey)

Specified by:

onClose in interface org.apache.lucene.index.LeafReader.CoreClosedListener

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

clear

public void clear(String reason)

onRemoval

public void onRemoval(com.google.common.cache.RemovalNotification<Object,com.google.common.cache.Cache<org.apache.lucene.search.Query,BitsetFilterCache.Value>> notification)

Specified by:

onRemoval in interface com.google.common.cache.RemovalListener<Object,com.google.common.cache.Cache<org.apache.lucene.search.Query,BitsetFilterCache.Value>>