org.apache.lucene.search
Class CachingSpanFilter
java.lang.Object
org.apache.lucene.search.Filter
org.apache.lucene.search.SpanFilter
org.apache.lucene.search.CachingSpanFilter
- All Implemented Interfaces:
- java.io.Serializable
public class CachingSpanFilter
- extends SpanFilter
Wraps another SpanFilter's result and caches it. The purpose is to allow
filters to simply filter, and then wrap with this class to add caching.
- See Also:
- Serialized Form
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
filter
protected SpanFilter filter
cache
protected transient java.util.Map cache
- A transient Filter cache. To cache Filters even when using
RemoteSearchable
use
RemoteCachingWrapperFilter
instead.
CachingSpanFilter
public CachingSpanFilter(SpanFilter filter)
- Parameters:
filter
- Filter to cache results of
bits
public java.util.BitSet bits(IndexReader reader)
throws java.io.IOException
- Deprecated. Use
getDocIdSet(IndexReader)
instead.
- Overrides:
bits
in class Filter
- Returns:
- A BitSet with true for documents which should be permitted in
search results, and false for those that should not.
- Throws:
java.io.IOException
getDocIdSet
public DocIdSet getDocIdSet(IndexReader reader)
throws java.io.IOException
- Overrides:
getDocIdSet
in class Filter
- Returns:
- a DocIdSet that provides the documents which should be
permitted or prohibited in search results.
- Throws:
java.io.IOException
- See Also:
DocIdBitSet
bitSpans
public SpanFilterResult bitSpans(IndexReader reader)
throws java.io.IOException
- Description copied from class:
SpanFilter
- Returns a SpanFilterResult with true for documents which should be permitted in
search results, and false for those that should not and Spans for where the true docs match.
- Specified by:
bitSpans
in class SpanFilter
- Parameters:
reader
- The IndexReader
to load position and DocIdSet information from
- Returns:
- A
SpanFilterResult
- Throws:
java.io.IOException
- if there was an issue accessing the necessary information
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-2009 Apache Software Foundation. All Rights Reserved.