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