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, MultiTermQueryWrapperFilter, QueryWrapperFilter, RemoteCachingWrapperFilter, SpanFilter, TermsFilter
public abstract class Filter
- extends Object
- implements Serializable
Abstract base class providing a mechanism to use a subset of an index
for restriction or permission of index search results.
- See Also:
- Serialized Form
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Filter
public Filter()
getDocIdSet
public abstract DocIdSet getDocIdSet(IndexReader reader)
throws IOException
- 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
Copyright © 2000-2009 Apache Software Foundation. All Rights Reserved.