TopFieldDocs.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 
20 /**
21  * Expert: Returned by low-level sorted search implementations.
22  *
23  <p>Created: Feb 12, 2004 8:58:46 AM
24  *
25  @author  Tim Jones (Nacimiento Software)
26  @since   lucene 1.4
27  @version $Id: TopFieldDocs.java 529 2004-10-05 11:55:26Z niraj $
28  @see Searchable#search(Query,Filter,int,Sort)
29  */
30 @SuppressWarnings("serial")
31 public class TopFieldDocs
32 extends TopDocs {
33 
34   /** The fields which were used to sort results by. */
35   public SortField[] fields;
36 
37   /** Creates one of these objects.
38    @param totalHits  Total number of hits for the query.
39    @param scoreDocs  The top hits for the query.
40    @param fields     The sort criteria used to find the top hits.
41    */
42   TopFieldDocs (int totalHits, ScoreDoc[] scoreDocs, SortField[] fields) {
43     super (totalHits, scoreDocs);
44     this.fields = fields;
45   }
46 }