beagled/Lucene.Net/Search/TopFieldDocs.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 namespace Lucene.Net.Search
  18 {
  19         /// <summary> Expert: Returned by low-level sorted search implementations.
  20         ///
  21         /// <p>Created: Feb 12, 2004 8:58:46 AM
  22         ///
  23         /// </summary>
  24         /// <author>   Tim Jones (Nacimiento Software)
  25         /// </author>
  26         /// <since>   lucene 1.4
  27         /// </since>
  28         /// <version>  $Id: TopFieldDocs.cs,v 1.1 2005/01/17 19:54:30 joeshaw Exp $
  29         /// </version>
  30         /// <seealso cref="Searchable#Search(Query,Filter,int,Sort)">
  31         /// </seealso>
  32         [Serializable]
  33         public class TopFieldDocs:TopDocs
  34         {
  35
  36                 /// <summary>The fields which were used to sort results by. </summary>
  37                 public SortField[] fields;
  38
  39                 /// <summary>Creates one of these objects.</summary>
  40                 /// <param name="totalHits"> Total number of hits for the query.
  41                 /// </param>
  42                 /// <param name="scoreDocs"> The top hits for the query.
  43                 /// </param>
  44                 /// <param name="fields">    The sort criteria used to find the top hits.
  45                 /// </param>
  46                 internal TopFieldDocs(int totalHits, ScoreDoc[] scoreDocs, SortField[] fields):base(totalHits, scoreDocs)
  47                 {
  48                         this.fields = fields;
  49                 }
  50         }
  51 }