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 using System;
  17 using IndexReader = Lucene.Net.Index.IndexReader;
  18 namespace Lucene.Net.Search
  19 {
  20
  21         /// <summary> Expert: returns a comparator for sorting ScoreDocs.
  22         ///
  23         /// <p>Created: Apr 21, 2004 3:49:28 PM
  24         ///
  25         /// </summary>
  26         /// <author>   Tim Jones
  27         /// </author>
  28         /// <version>  $Id: SortComparatorSource.cs,v 1.1 2005/01/17 19:54:30 joeshaw Exp $
  29         /// </version>
  30         /// <since>   1.4
  31         /// </since>
  32         public interface SortComparatorSource
  33         {
  34
  35                 /// <summary> Creates a comparator for the Field in the given index.</summary>
  36                 /// <param name="reader">Index to create comparator for.
  37                 /// </param>
  38                 /// <param name="fieldname"> Field to create comparator for.
  39                 /// </param>
  40                 /// <returns> Comparator of ScoreDoc objects.
  41                 /// </returns>
  42                 /// <throws>  IOException If an error occurs reading the index. </throws>
  43                 ScoreDocComparator NewComparator(IndexReader reader, System.String fieldname);
  44         }
  45 }