Method GetDocIdSet
GetDocIdSet(AtomicReaderContext, IBits)
Creates a 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.
Declaration
public abstract DocIdSet GetDocIdSet(AtomicReaderContext context, IBits acceptDocs)Parameters
| Type | Name | Description |
|---|---|---|
| AtomicReaderContext | context | a AtomicReaderContext 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 Fields on the context's reader, for example. |
| IBits | acceptDocs | IBits that represent the allowable docs to match (typically deleted docs but possibly filtering other documents) |
Returns
| Type | Description |
|---|---|
| DocIdSet | A DocIdSet that provides the documents which should be permitted or
prohibited in search results. NOTE: |
