mcs/tools/monkeydoc/Lucene.Net/Lucene.Net/Search/ScoreDoc.cs

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one or more
   3  * contributor license agreements.  See the NOTICE file distributed with
   4  * this work for additional information regarding copyright ownership.
   5  * The ASF licenses this file to You under the Apache License, Version 2.0
   6  * (the "License"); you may not use this file except in compliance with
   7  * the License.  You may obtain a copy of the License at
   8  *
   9  * http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 using System;
  19
  20 namespace Mono.Lucene.Net.Search
  21 {
  22
  23         /// <summary>Expert: Returned by low-level search implementations.</summary>
  24         /// <seealso cref="TopDocs">
  25         /// </seealso>
  26         [Serializable]
  27         public class ScoreDoc
  28         {
  29                 /// <summary>Expert: The score of this document for the query. </summary>
  30                 public float score;
  31
  32                 /// <summary>Expert: A hit document's number.</summary>
  33                 /// <seealso cref="Searcher.Doc(int)">
  34                 /// </seealso>
  35                 public int doc;
  36
  37                 /// <summary>Expert: Constructs a ScoreDoc. </summary>
  38                 public ScoreDoc(int doc, float score)
  39                 {
  40                         this.doc = doc;
  41                         this.score = score;
  42                 }
  43
  44                 // A convenience method for debugging.
  45                 public override System.String ToString()
  46                 {
  47                         return "doc=" + doc + " score=" + score;
  48                 }
  49         }
  50 }