- Direct Known Subclasses:
public abstract class Filter extends ObjectAbstract base class for restricting which documents may be returned during searching.
Constructors Constructor Description
All Methods Instance Methods Abstract Methods Modifier and Type Method Description
getDocIdSet(AtomicReaderContext context, Bits acceptDocs)Creates a
DocIdSetenumerating the documents that should be permitted in search results.
public abstract DocIdSet getDocIdSet(AtomicReaderContext context, Bits acceptDocs) throws IOExceptionCreates a
DocIdSetenumerating 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
DocIdSetmust refer to document IDs for that segment, not for the top-level reader.
AtomicReaderContextinstance 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
AtomicReader.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)
- a DocIdSet that provides the documents which should be permitted or
prohibited in search results. NOTE:
nullshould be returned if the filter doesn't accept any documents otherwise internal optimization might not apply in the case an empty