public final class TermFilter extends Filter
Constructor and Description |
---|
TermFilter(Term term) |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o) |
DocIdSet |
getDocIdSet(AtomicReaderContext context,
Bits acceptDocs)
Creates a
DocIdSet enumerating the documents that should be
permitted in search results. |
Term |
getTerm() |
int |
hashCode() |
String |
toString() |
public TermFilter(Term term)
term
- The term documents need to have in order to be a match for this filter.public Term getTerm()
public DocIdSet getDocIdSet(AtomicReaderContext 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 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
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)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
Copyright © 2010 - 2020 Adobe. All Rights Reserved