Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
TopDocs.cs
Go to the documentation of this file.
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 Lucene.Net.Search
21 {
22 
26  [Serializable]
27  public class TopDocs
28  {
29  private int _totalHits;
30  private ScoreDoc[] _scoreDocs;
31  private float _maxScore;
32 
34  public int TotalHits
35  {
36  get { return _totalHits; }
37  set { _totalHits = value; }
38  }
39 
41  [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
42  public ScoreDoc[] ScoreDocs
43  {
44  get { return _scoreDocs; }
45  set { _scoreDocs = value; }
46  }
47 
52  public float MaxScore
53  {
54  get { return _maxScore; }
55  set { _maxScore = value; }
56  }
57 
59  internal TopDocs(int totalHits, ScoreDoc[] scoreDocs):this(totalHits, scoreDocs, float.NaN)
60  {
61  }
62 
64  public TopDocs(int totalHits, ScoreDoc[] scoreDocs, float maxScore)
65  {
66  this.TotalHits = totalHits;
67  this.ScoreDocs = scoreDocs;
68  this.MaxScore = maxScore;
69  }
70  }
71 }