KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > lucene > search > TopDocs


1 package org.apache.lucene.search;
2
3 /**
4  * Copyright 2004 The Apache Software Foundation
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18
19 /** Expert: Returned by low-level search implementations.
20  * @see Searcher#search(Query,Filter,int) */
21 public class TopDocs implements java.io.Serializable JavaDoc {
22   /** Expert: The total number of hits for the query.
23    * @see Hits#length()
24   */
25   public int totalHits;
26   /** Expert: The top hits for the query. */
27   public ScoreDoc[] scoreDocs;
28   /** Expert: Stores the maximum score value encountered, needed for normalizing. */
29   private float maxScore;
30   
31   /** Expert: Returns the maximum score value encountered. */
32   public float getMaxScore() {
33       return maxScore;
34   }
35   
36   /** Expert: Sets the maximum score value encountered. */
37   public void setMaxScore(float maxScore) {
38       this.maxScore=maxScore;
39   }
40   
41   /** Expert: Constructs a TopDocs.*/
42   TopDocs(int totalHits, ScoreDoc[] scoreDocs, float maxScore) {
43     this.totalHits = totalHits;
44     this.scoreDocs = scoreDocs;
45     this.maxScore = maxScore;
46   }
47 }
48
Popular Tags