public final class TermsFilter extends Filter
Constructor and Description |
---|
TermsFilter(List<Term> terms)
Creates a new
TermsFilter from the given list. |
TermsFilter(String field,
BytesRef... terms)
Creates a new
TermsFilter from the given BytesRef array for
a single field. |
TermsFilter(String field,
List<BytesRef> terms)
Creates a new
TermsFilter from the given BytesRef list for
a single field. |
TermsFilter(Term... terms)
Creates a new
TermsFilter from the given array. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
DocIdSet |
getDocIdSet(AtomicReaderContext context,
Bits acceptDocs)
Creates a
DocIdSet enumerating the documents that should be
permitted in search results. |
int |
hashCode() |
String |
toString() |
public TermsFilter(List<Term> terms)
TermsFilter
from the given list. The list
can contain duplicate terms and multiple fields.public TermsFilter(String field, List<BytesRef> terms)
TermsFilter
from the given BytesRef
list for
a single field.public TermsFilter(String field, BytesRef... terms)
TermsFilter
from the given BytesRef
array for
a single field.public TermsFilter(Term... terms)
TermsFilter
from the given array. The array can
contain duplicate terms and multiple fields.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