public abstract class Filter extends Object
|Constructor and Description|
|Modifier and Type||Method and Description|
public abstract DocIdSet getDocIdSet(LeafReaderContext context, Bits acceptDocs) throws IOException
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
must refer to document IDs for that segment, not for
the top-level reader.
LeafReaderContextinstance 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)
nullshould be returned if the filter doesn't accept any documents otherwise internal optimization might not apply in the case an empty
Copyright © 2000-2015 Apache Software Foundation. All Rights Reserved.