package org.apache.lucene.search;
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import java.io.IOException;
import java.io.Serializable;
/**
* Provides a {@link FieldComparator} for custom field sorting.
*
* <b>NOTE:</b> This API is experimental and might change in
* incompatible ways in the next release.
*
*/
public abstract class FieldComparatorSource implements Serializable {
/**
* Creates a comparator for the field in the given index.
*
* @param fieldname
* Name of the field to create comparator for.
* @return FieldComparator.
* @throws IOException
* If an error occurs reading the index.
*/
public abstract FieldComparator newComparator(String fieldname, int numHits, int sortPos, boolean reversed)
throws IOException;
}