lucene-java-3.5.0/lucene/src/java/org/apache/lucene/search/FieldComparatorSource.java

   1 package org.apache.lucene.search;
   2
   3 /**
   4  * Licensed to the Apache Software Foundation (ASF) under one or more
   5  * contributor license agreements.  See the NOTICE file distributed with
   6  * this work for additional information regarding copyright ownership.
   7  * The ASF licenses this file to You under the Apache License, Version 2.0
   8  * (the "License"); you may not use this file except in compliance with
   9  * 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.io.IOException;
  21 import java.io.Serializable;
  22
  23 /**
  24  * Provides a {@link FieldComparator} for custom field sorting.
  25  *
  26  * @lucene.experimental
  27  *
  28  */
  29 public abstract class FieldComparatorSource implements Serializable {
  30
  31   /**
  32    * Creates a comparator for the field in the given index.
  33    *
  34    * @param fieldname
  35    *          Name of the field to create comparator for.
  36    * @return FieldComparator.
  37    * @throws IOException
  38    *           If an error occurs reading the index.
  39    */
  40   public abstract FieldComparator newComparator(String fieldname, int numHits, int sortPos, boolean reversed)
  41       throws IOException;
  42 }