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