TopDocs.java
01 package gate.creole.annic.apache.lucene.search;
02 
03 /**
04  * Copyright 2004 The Apache Software Foundation
05  *
06  * Licensed under the Apache License, Version 2.0 (the "License");
07  * you may not use this file except in compliance with the License.
08  * You may obtain a copy of the License at
09  *
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 {
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 
29   /** Expert: Constructs a TopDocs.*/
30   TopDocs(int totalHits, ScoreDoc[] scoreDocs) {
31     this.totalHits = totalHits;
32     this.scoreDocs = scoreDocs;
33   }
34 }