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 org.apache.lucene.index.IndexReader;
21: import java.io.IOException;
22: import java.io.Serializable;
23:
24: /**
25: * Expert: returns a comparator for sorting ScoreDocs.
26: *
27: * <p>Created: Apr 21, 2004 3:49:28 PM
28: *
29: *
30: * @version $Id: SortComparatorSource.java 564236 2007-08-09 15:21:19Z gsingers $
31: * @since 1.4
32: */
33: public interface SortComparatorSource extends Serializable {
34:
35: /**
36: * Creates a comparator for the field in the given index.
37: * @param reader Index to create comparator for.
38: * @param fieldname Name of the field to create comparator for.
39: * @return Comparator of ScoreDoc objects.
40: * @throws IOException If an error occurs reading the index.
41: */
42: ScoreDocComparator newComparator(IndexReader reader,
43: String fieldname) throws IOException;
44: }
|