lucene-java-3.5.0/lucene/src/java/org/apache/lucene/search/TopFieldDocs.java

   1 package org.apache.lucene.search;
   2
   3 /**
   4  * Licensed to the Apache Software Foundation (ASF) under one or more
   5  * contributor license agreements.  See the NOTICE file distributed with
   6  * this work for additional information regarding copyright ownership.
   7  * The ASF licenses this file to You under the Apache License, Version 2.0
   8  * (the "License"); you may not use this file except in compliance with
   9  * 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 /** Represents hits returned by {@link
  22  * Searcher#search(Query,Filter,int,Sort)}.
  23  */
  24 public class TopFieldDocs
  25 extends TopDocs {
  26
  27         /** The fields which were used to sort results by. */
  28         public SortField[] fields;
  29
  30         /** Creates one of these objects.
  31          * @param totalHits  Total number of hits for the query.
  32          * @param scoreDocs  The top hits for the query.
  33          * @param fields     The sort criteria used to find the top hits.
  34          * @param maxScore   The maximum score encountered.
  35          */
  36         public TopFieldDocs (int totalHits, ScoreDoc[] scoreDocs, SortField[] fields, float maxScore) {
  37           super (totalHits, scoreDocs, maxScore);
  38           this.fields = fields;
  39         }
  40 }