Package org.apache.lucene.search
Class Filter
- java.lang.Object
-
- org.apache.lucene.search.Filter
-
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
BooleanFilter
,CachingWrapperFilter
,CartesianShapeFilter
,ChainedFilter
,DistanceFilter
,DuplicateFilter
,FieldCacheRangeFilter
,FieldCacheTermsFilter
,FieldValueFilter
,MultiTermQueryWrapperFilter
,QueryWrapperFilter
,RawTermFilter
,RemoteCachingWrapperFilter
,SpanFilter
,TermsFilter
public abstract class Filter extends Object implements Serializable
Abstract base class for restricting which documents may be returned during searching.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Filter()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract DocIdSet
getDocIdSet(IndexReader reader)
Creates aDocIdSet
enumerating the documents that should be permitted in search results.
-
-
-
Method Detail
-
getDocIdSet
public abstract DocIdSet getDocIdSet(IndexReader reader) throws IOException
Creates aDocIdSet
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
- aIndexReader
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.
- Throws:
IOException
- See Also:
DocIdBitSet
-
-