org.hibernate.search.filter

Interface FilterCachingStrategy

All Known Implementing Classes:

MRUFilterCachingStrategy

public interface FilterCachingStrategy

Defines the caching filter strategy implementations of getCachedFilter and addCachedFilter must be thread-safe

Author:

Emmanuel Bernard

Method Summary

Methods

Modifier and Type	Method and Description
void	addCachedFilter(FilterKey key, org.apache.lucene.search.Filter filter) Propose a candidate filter for caching
org.apache.lucene.search.Filter	getCachedFilter(FilterKey key) Retrieve the cached filter for a given key or null if not cached.
void	initialize(Properties properties) Initialize the strategy from the properties.

Method Detail

initialize

void initialize(Properties properties)

Initialize the strategy from the properties. The Properties must not be changed.

Parameters:

properties - the caching strategy configuration

getCachedFilter

org.apache.lucene.search.Filter getCachedFilter(FilterKey key)

Retrieve the cached filter for a given key or null if not cached.

Parameters:

key - the filter key

Returns:

the cached filter or null if not cached

addCachedFilter

void addCachedFilter(FilterKey key,
                   org.apache.lucene.search.Filter filter)

Propose a candidate filter for caching

Parameters:

key - the filter key

filter - the filter to cache