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 @SuppressWarnings("serial")
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 
30   /** Expert: Constructs a TopDocs.*/
31   TopDocs(int totalHits, ScoreDoc[] scoreDocs) {
32     this.totalHits = totalHits;
33     this.scoreDocs = scoreDocs;
34   }
35 }