org.apache.lucene.search.join

Class FixedBitSetCachingWrapperFilter

java.lang.Object

org.apache.lucene.search.Filter

org.apache.lucene.search.CachingWrapperFilter

org.apache.lucene.search.join.FixedBitSetCachingWrapperFilter

public final class FixedBitSetCachingWrapperFilter
extends CachingWrapperFilter

A CachingWrapperFilter that caches sets using a FixedBitSet, as required for joins.

Field Summary

Fields inherited from class org.apache.lucene.search.CachingWrapperFilter

EMPTY_DOCIDSET

Constructor Summary

Constructors

Constructor and Description
FixedBitSetCachingWrapperFilter(Filter filter) Sole constructor, see CachingWrapperFilter.CachingWrapperFilter(Filter).

Method Summary

Methods

Modifier and Type	Method and Description
protected DocIdSet	docIdSetToCache(DocIdSet docIdSet, AtomicReader reader) Provide the DocIdSet to be cached, using the DocIdSet provided by the wrapped Filter.

Methods inherited from class org.apache.lucene.search.CachingWrapperFilter

cacheImpl, equals, getDocIdSet, getFilter, hashCode, sizeInBytes, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FixedBitSetCachingWrapperFilter

public FixedBitSetCachingWrapperFilter(Filter filter)

Sole constructor, see CachingWrapperFilter.CachingWrapperFilter(Filter).

Method Detail

docIdSetToCache

protected DocIdSet docIdSetToCache(DocIdSet docIdSet,
                       AtomicReader reader)
                            throws IOException

Description copied from class: CachingWrapperFilter

Provide the DocIdSet to be cached, using the DocIdSet provided by the wrapped Filter.

This implementation returns the given DocIdSet, if DocIdSet.isCacheable() returns true, else it calls CachingWrapperFilter.cacheImpl(DocIdSetIterator,AtomicReader)

Note: This method returns CachingWrapperFilter.EMPTY_DOCIDSET if the given docIdSet is null or if DocIdSet.iterator() return null. The empty instance is use as a placeholder in the cache instead of the null value.

Overrides:

docIdSetToCache in class CachingWrapperFilter

Throws:

IOException