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
  17 using System;
  18
  19 namespace Lucene.Net.Search
  20 {
  21
  22         /// <summary>Expert: Returned by low-level search implementations.</summary>
  23         /// <seealso cref="Searcher.Search(Query,Filter,int)">
  24         /// </seealso>
  25         [Serializable]
  26         public class TopDocs
  27         {
  28                 /// <summary>Expert: The total number of hits for the query.</summary>
  29                 /// <seealso cref="Hits.Length()">
  30                 /// </seealso>
  31                 public int totalHits;
  32                 /// <summary>Expert: The top hits for the query. </summary>
  33                 public ScoreDoc[] scoreDocs;
  34                 /// <summary>Expert: Stores the maximum score value encountered, needed for normalizing. </summary>
  35                 private float maxScore;
  36
  37                 /// <summary>Expert: Returns the maximum score value encountered. </summary>
  38                 public virtual float GetMaxScore()
  39                 {
  40                         return maxScore;
  41                 }
  42
  43                 /// <summary>Expert: Sets the maximum score value encountered. </summary>
  44                 public virtual void  SetMaxScore(float maxScore)
  45                 {
  46                         this.maxScore = maxScore;
  47                 }
  48
  49                 /// <summary>Expert: Constructs a TopDocs.</summary>
  50                 internal TopDocs(int totalHits, ScoreDoc[] scoreDocs, float maxScore)
  51                 {
  52                         this.totalHits = totalHits;
  53                         this.scoreDocs = scoreDocs;
  54                         this.maxScore = maxScore;
  55                 }
  56         }
  57 }