|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.search.Filter
org.apache.lucene.search.SpanFilter
org.apache.lucene.search.CachingSpanFilter
public class CachingSpanFilter
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.
Field Summary | |
---|---|
protected java.util.Map |
cache
A transient Filter cache. |
protected SpanFilter |
filter
|
Constructor Summary | |
---|---|
CachingSpanFilter(SpanFilter filter)
|
Method Summary | |
---|---|
java.util.BitSet |
bits(IndexReader reader)
Deprecated. Use getDocIdSet(IndexReader) instead. |
SpanFilterResult |
bitSpans(IndexReader reader)
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. |
boolean |
equals(java.lang.Object o)
|
DocIdSet |
getDocIdSet(IndexReader reader)
Creates a DocIdSet enumerating the documents that should be
permitted in search results. |
int |
hashCode()
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected SpanFilter filter
protected transient java.util.Map cache
Constructor Detail |
---|
public CachingSpanFilter(SpanFilter filter)
filter
- Filter to cache results ofMethod Detail |
---|
public java.util.BitSet bits(IndexReader reader) throws java.io.IOException
getDocIdSet(IndexReader)
instead.
bits
in class Filter
NOTE: See Filter.getDocIdSet(IndexReader)
for
handling of multi-segment indexes (which applies to
this method as well).
java.io.IOException
public DocIdSet getDocIdSet(IndexReader reader) throws java.io.IOException
Filter
DocIdSet
enumerating the documents that should be
permitted in search results. NOTE: null can be
returned if no documents are accepted by this Filter.
Note: This method will be called once per segment in
the index during searching. The returned DocIdSet
must refer to document IDs for that segment, not for
the top-level reader.
getDocIdSet
in class Filter
reader
- a IndexReader
instance opened on the index currently
searched on. Note, it is likely that the provided reader does not
represent the whole underlying index i.e. if the index has more than
one segment the given reader only represents a single segment.
java.io.IOException
DocIdBitSet
public SpanFilterResult bitSpans(IndexReader reader) throws java.io.IOException
SpanFilter
bitSpans
in class SpanFilter
reader
- The IndexReader
to load position and DocIdSet information from
SpanFilterResult
java.io.IOException
- if there was an issue accessing the necessary informationpublic java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |