Filter.java
01 package gate.creole.annic.apache.lucene.search;
02 
03 /**
04  * Copyright 2004 The Apache Software Foundation
05  *
06  * Licensed under the Apache License, Version 2.0 (the "License");
07  * you may not use this file except in compliance with the License.
08  * You may obtain a copy of the License at
09  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 
19 import java.util.BitSet;
20 import java.io.IOException;
21 import gate.creole.annic.apache.lucene.index.IndexReader;
22 
23 /** Abstract base class providing a mechanism to restrict searches to a subset
24  of an index. */
25 @SuppressWarnings("serial")
26 public abstract class Filter implements java.io.Serializable {
27   /** Returns a BitSet with true for documents which should be permitted in
28     search results, and false for those that should not. */
29   public abstract BitSet bits(IndexReader readerthrows IOException;
30 }