BitSetProducer
insteadpublic abstract class BitDocIdSetFilter extends Filter implements BitSetProducer
Filter
that produces BitDocIdSet
s.Modifier | Constructor and Description |
---|---|
protected |
BitDocIdSetFilter()
Deprecated.
Sole constructor, typically called from sub-classes.
|
Modifier and Type | Method and Description |
---|---|
BitSet |
getBitSet(LeafReaderContext context)
Deprecated.
Produce a
BitSet matching the expected documents on the given
segment. |
abstract BitDocIdSet |
getDocIdSet(LeafReaderContext context)
Deprecated.
Same as
getDocIdSet(LeafReaderContext, Bits) but does not take
acceptDocs into account and guarantees to return a BitDocIdSet . |
DocIdSet |
getDocIdSet(LeafReaderContext context,
Bits acceptDocs)
Deprecated.
Creates a
DocIdSet enumerating the documents that should be
permitted in search results. |
protected BitDocIdSetFilter()
public abstract BitDocIdSet getDocIdSet(LeafReaderContext context) throws IOException
getDocIdSet(LeafReaderContext, Bits)
but does not take
acceptDocs into account and guarantees to return a BitDocIdSet
.IOException
public final DocIdSet getDocIdSet(LeafReaderContext context, Bits acceptDocs) throws 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
context
- a LeafReaderContext
instance opened on the index currently
searched on. Note, it is likely that the provided reader info 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.
The provided context is always an atomic context, so you can call
LeafReader.fields()
on the context's reader, for example.acceptDocs
- Bits that represent the allowable docs to match (typically deleted docs
but possibly filtering other documents)null
should be returned if
the filter doesn't accept any documents otherwise internal optimization might not apply
in the case an empty DocIdSet
is returned.IOException
public final BitSet getBitSet(LeafReaderContext context) throws IOException
BitSetProducer
BitSet
matching the expected documents on the given
segment. This may return null
if no documents match.getBitSet
in interface BitSetProducer
IOException
Copyright © 2000–2015 The Apache Software Foundation. All rights reserved.