Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

tweak javadocs 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@899390 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael McCandless 2010-01-14 20:16:04 +00:00
parent 43c11321b4
commit cf3b8e539e
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/java/org/apache/lucene/search/Filter.java
View File

@ -23,21 +23,20 @@ import org.apache.lucene.index.IndexReader;
import org.apache.lucene.util.DocIdBitSet;
/**
* Abstract base class providing a mechanism to use a subset of an index
* for restriction or permission of index search results.
* <p>
* Abstract base class for restricting which documents may
* be returned during searching.
*/
public abstract class Filter implements java.io.Serializable {
/**
* Creates a {@link DocIdSet} that provides the documents which should be
* permitted or prohibited in search results. <b>NOTE:</b> null can be
* returned if no documents will be accepted by this Filter.
* Creates a {@link DocIdSet} enumerating the documents that should be
* permitted in search results. <b>NOTE:</b> null can be
* returned if no documents are accepted by this Filter.
* <p>
* Note: This method might be called more than once during a search if the
* index has more than one segment. In such a case the {@link DocIdSet}
* must be relative to the document base of the given reader. Yet, the
* segment readers are passed in increasing document base order.
* Note: This method will be called once per segment in
* the index during searching. The returned {@link DocIdSet}
* must refer to document IDs for that segment, not for
* the top-level reader.
*
* @param reader a {@link IndexReader} instance opened on the index currently
* searched on. Note, it is likely that the provided reader does not