org.infinispan.lucene.cacheloader

Class LuceneCacheLoader

java.lang.Object

org.infinispan.lucene.cacheloader.LuceneCacheLoader

All Implemented Interfaces:

Lifecycle, AdvancedCacheLoader, CacheLoader

public class LuceneCacheLoader
extends Object
implements AdvancedCacheLoader

A CacheLoader meant to load Lucene index(es) from filesystem based Lucene index(es). This is exclusively suitable for keys being used by the Directory, any other key will be ignored. The InfinispanDirectory requires indexes to be named; this CacheLoader needs to be configured with the path of the root directory containing the indexes, and expects index names to match directory names under this common root path.

Since:

5.2

Author:

Sanne Grinovero

Nested Class Summary

Nested classes/interfaces inherited from interface org.infinispan.persistence.spi.AdvancedCacheLoader

AdvancedCacheLoader.CacheLoaderTask<K,V>, AdvancedCacheLoader.KeyFilter<K>, AdvancedCacheLoader.TaskContext

Constructor Summary

Constructors

Constructor and Description
LuceneCacheLoader()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(Object key) Returns true if the storage contains an entry associated with the given key.
void	init(InitializationContext ctx) Used to initialize a cache loader.
MarshalledEntry	load(Object key) Fetches an entry from the storage.
void	process(AdvancedCacheLoader.KeyFilter filter, AdvancedCacheLoader.CacheLoaderTask task, Executor executor, boolean fetchValue, boolean fetchMetadata) Iterates in parallel over the entries in the storage using the threads from the executor pool.
int	size() Returns the number of elements in the store.
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

LuceneCacheLoader

public LuceneCacheLoader()

Method Detail

init

public void init(InitializationContext ctx)

Description copied from interface: CacheLoader

Used to initialize a cache loader. Typically invoked by the PersistenceManager when setting up cache loaders.

Specified by:

init in interface CacheLoader

load

public MarshalledEntry load(Object key)

Description copied from interface: CacheLoader

Fetches an entry from the storage. If a MarshalledEntry needs to be created here, InitializationContext.getMarshalledEntryFactory() and InitializationContext.getByteBufferFactory() should be used.

Specified by:

load in interface CacheLoader

Returns:

the entry, or null if the entry does not exist

contains

public boolean contains(Object key)

Description copied from interface: CacheLoader

Returns true if the storage contains an entry associated with the given key.

Specified by:

contains in interface CacheLoader

process

public void process(AdvancedCacheLoader.KeyFilter filter,
           AdvancedCacheLoader.CacheLoaderTask task,
           Executor executor,
           boolean fetchValue,
           boolean fetchMetadata)

Description copied from interface: AdvancedCacheLoader

Iterates in parallel over the entries in the storage using the threads from the executor pool. For each entry the CacheLoaderTask#processEntry(org.infinispan.marshall.core.MarshalledEntry, TaskContext) is invoked. Before passing an entry to the callback task, the entry should be validated against the filter. Implementors should build an AdvancedCacheLoader.TaskContext instance (implementation) that is fed to the AdvancedCacheLoader.CacheLoaderTask on every invocation. The AdvancedCacheLoader.CacheLoaderTask might invoke AdvancedCacheLoader.TaskContext.stop() at any time, so implementors of this method should verify TaskContext's state for early termination of iteration. The method should only return once the iteration is complete or as soon as possible in the case TaskContext.stop() is invoked.

Specified by:

process in interface AdvancedCacheLoader

Parameters:

filter - to validate which entries should be feed into the task. Might be null.

task - callback to be invoked in parallel for each stored entry that passes the filter check

executor - an external thread pool to be used for parallel iteration

fetchValue - whether or not to fetch the value from the persistent store. E.g. if the iteration is intended only over the key set, no point fetching the values from the persistent store as well

fetchMetadata - whether or not to fetch the metadata from the persistent store. E.g. if the iteration is intended only ove the key set, then no pint fetching the metadata from the persistent store as well

size

public int size()

Description copied from interface: AdvancedCacheLoader

Returns the number of elements in the store.

Specified by:

size in interface AdvancedCacheLoader

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle