KickJava   Java API By Example, From Geeks To Geeks.

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


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
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 354819 2005-12-07 17:48:37Z yonik $
28  * @see Searcher#search(Query,Filter,int,Sort)
29  */
30 public class TopFieldDocs
31 extends TopDocs {
32
33     /** The fields which were used to sort results by. */
34     public SortField[] fields;
35         
36     /** Creates one of these objects.
37      * @param totalHits Total number of hits for the query.
38      * @param scoreDocs The top hits for the query.
39      * @param fields The sort criteria used to find the top hits.
40      * @param maxScore The maximum score encountered.
41      */
42     TopFieldDocs (int totalHits, ScoreDoc[] scoreDocs, SortField[] fields, float maxScore) {
43       super (totalHits, scoreDocs, maxScore);
44       this.fields = fields;
45     }
46 }
Popular Tags