beagled/Lucene.Net/Search/SortComparatorSource.cs

   1 /*
   2  * Copyright 2004 The Apache Software Foundation
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 using System;
  18 using IndexReader = Lucene.Net.Index.IndexReader;
  19
  20 namespace Lucene.Net.Search
  21 {
  22
  23         /// <summary> Expert: returns a comparator for sorting ScoreDocs.
  24         ///
  25         /// <p>Created: Apr 21, 2004 3:49:28 PM
  26         ///
  27         /// </summary>
  28         /// <author>   Tim Jones
  29         /// </author>
  30         /// <version>  $Id: SortComparatorSource.cs,v 1.3 2006/10/02 17:09:07 joeshaw Exp $
  31         /// </version>
  32         /// <since>   1.4
  33         /// </since>
  34         public interface SortComparatorSource
  35         {
  36
  37                 /// <summary> Creates a comparator for the field in the given index.</summary>
  38                 /// <param name="reader">Index to create comparator for.
  39                 /// </param>
  40                 /// <param name="fieldname"> Field to create comparator for.
  41                 /// </param>
  42                 /// <returns> Comparator of ScoreDoc objects.
  43                 /// </returns>
  44                 /// <throws>  IOException If an error occurs reading the index. </throws>
  45                 ScoreDocComparator NewComparator(IndexReader reader, System.String fieldname);
  46         }
  47 }