org.apache.lucene.search
Class CachingWrapperFilter

java.lang.Object
  extended by org.apache.lucene.search.Filter
      extended by org.apache.lucene.search.CachingWrapperFilter
All Implemented Interfaces:
java.io.Serializable

public class CachingWrapperFilter
extends Filter

Wraps another filter's result and caches it. The caching behavior is like QueryFilter. The purpose is to allow filters to simply filter, and then wrap with this class to add caching, keeping the two concerns decoupled yet composable.

See Also:
Serialized Form

Constructor Summary
CachingWrapperFilter(Filter filter)
           
 
Method Summary
 java.util.BitSet bits(IndexReader reader)
          Returns a BitSet with true for documents which should be permitted in search results, and false for those that should not.
 boolean equals(java.lang.Object o)
           
 int hashCode()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CachingWrapperFilter

public CachingWrapperFilter(Filter filter)
Parameters:
filter - Filter to cache results of
Method Detail

bits

public java.util.BitSet bits(IndexReader reader)
                      throws java.io.IOException
Description copied from class: Filter
Returns a BitSet with true for documents which should be permitted in search results, and false for those that should not.

Specified by:
bits in class Filter
Throws:
java.io.IOException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object


Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.