01: package org.apache.lucene.search;
02:
03: /**
04: * Licensed to the Apache Software Foundation (ASF) under one or more
05: * contributor license agreements. See the NOTICE file distributed with
06: * this work for additional information regarding copyright ownership.
07: * The ASF licenses this file to You under the Apache License, Version 2.0
08: * (the "License"); you may not use this file except in compliance with
09: * the License. You may obtain a copy of the License at
10: *
11: * http://www.apache.org/licenses/LICENSE-2.0
12: *
13: * Unless required by applicable law or agreed to in writing, software
14: * distributed under the License is distributed on an "AS IS" BASIS,
15: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16: * See the License for the specific language governing permissions and
17: * limitations under the License.
18: */
19:
20: import java.util.BitSet;
21: import java.io.IOException;
22: import org.apache.lucene.index.IndexReader;
23:
24: /** Abstract base class providing a mechanism to restrict searches to a subset
25: of an index. */
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 reader) throws IOException;
30: }
|