pylucene 3.5.0-3

[pylucene.git] / lucene-java-3.5.0 / lucene / src / java / org / apache / lucene / search / TopFieldDocs.java

diff --git a/lucene-java-3.5.0/lucene/src/java/org/apache/lucene/search/TopFieldDocs.java b/lucene-java-3.5.0/lucene/src/java/org/apache/lucene/search/TopFieldDocs.java
new file mode 100644 (file)
index 0000000..ec9750f
--- /dev/null
+++ b/lucene-java-3.5.0/lucene/src/java/org/apache/lucene/search/TopFieldDocs.java
@@ -0,0 +1,40 @@
+package org.apache.lucene.search;
+
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+
+/** Represents hits returned by {@link
+ * Searcher#search(Query,Filter,int,Sort)}.
+ */
+public class TopFieldDocs
+extends TopDocs {
+
+       /** The fields which were used to sort results by. */
+       public SortField[] fields;
+        
+       /** Creates one of these objects.
+        * @param totalHits  Total number of hits for the query.
+        * @param scoreDocs  The top hits for the query.
+        * @param fields     The sort criteria used to find the top hits.
+        * @param maxScore   The maximum score encountered.
+        */
+        public TopFieldDocs (int totalHits, ScoreDoc[] scoreDocs, SortField[] fields, float maxScore) {
+         super (totalHits, scoreDocs, maxScore);
+         this.fields = fields;
+       }
+}
\ No newline at end of file