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