Known Direct Subclasses
|
Known Indirect Subclasses
CachingSpanFilter |
Wraps another SpanFilter's result and caches it. |
NumericRangeFilter<T extends Number> |
A Filter that only accepts numeric values within
a specified range. |
PrefixFilter |
A Filter that restricts search results to values that have a matching prefix in a given
field. |
SpanQueryFilter |
Constrains search results to only match those which also match a provided
query. |
TermRangeFilter |
A Filter that restricts search results to a range of term
values in a given field. |
|
Class Overview
Abstract base class for restricting which documents may
be returned during searching.
Summary
[Expand]
Inherited Methods |
From class
java.lang.Object
Object
|
clone()
|
boolean
|
equals(Object arg0)
|
void
|
finalize()
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
|
Public Constructors
Public Methods
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.
Parameters
reader
| a IndexReader instance opened on the index currently
searched on. Note, it is likely that the provided reader 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. |
Returns
- a DocIdSet that provides the documents which should be permitted or
prohibited in search results. NOTE: null can be returned if
no documents will be accepted by this Filter.