beagled/Lucene.Net/Search/TopDocs.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 search implementations.</summary>
  20         /// <seealso cref="Searcher#Search(Query,Filter,int)">
  21         /// </seealso>
  22         [Serializable]
  23         public class TopDocs
  24         {
  25                 /// <summary>Expert: The total number of hits for the query.</summary>
  26                 /// <seealso cref="Hits#Length()">
  27                 /// </seealso>
  28                 public int totalHits;
  29                 /// <summary>Expert: The top hits for the query. </summary>
  30                 public ScoreDoc[] scoreDocs;
  31
  32                 /// <summary>Expert: Constructs a TopDocs.</summary>
  33                 internal TopDocs(int totalHits, ScoreDoc[] scoreDocs)
  34                 {
  35                         this.totalHits = totalHits;
  36                         this.scoreDocs = scoreDocs;
  37                 }
  38         }
  39 }