pylucene 3.5.0-3

[pylucene.git] / lucene-java-3.5.0 / lucene / contrib / grouping / src / java / org / apache / lucene / search / grouping / GroupDocs.java

diff --git a/lucene-java-3.5.0/lucene/contrib/grouping/src/java/org/apache/lucene/search/grouping/GroupDocs.java b/lucene-java-3.5.0/lucene/contrib/grouping/src/java/org/apache/lucene/search/grouping/GroupDocs.java
new file mode 100644 (file)
index 0000000..0b24b5d
--- /dev/null
+++ b/lucene-java-3.5.0/lucene/contrib/grouping/src/java/org/apache/lucene/search/grouping/GroupDocs.java
@@ -0,0 +1,56 @@
+package org.apache.lucene.search.grouping;
+
+/**
+ * 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.
+ */
+
+import org.apache.lucene.search.ScoreDoc;
+
+/** Represents one group in the results.
+ * 
+ * @lucene.experimental */
+public class GroupDocs<GROUP_VALUE_TYPE> {
+  /** The groupField value for all docs in this group; this
+   *  may be null if hits did not have the groupField. */
+  public final GROUP_VALUE_TYPE groupValue;
+
+  /** Max score in this group */
+  public final float maxScore;
+
+  /** Hits; this may be {@link
+   * org.apache.lucene.search.FieldDoc} instances if the
+   * withinGroupSort sorted by fields. */
+  public final ScoreDoc[] scoreDocs;
+
+  /** Total hits within this group */
+  public final int totalHits;
+
+  /** Matches the groupSort passed to {@link
+   *  AbstractFirstPassGroupingCollector}. */
+  public final Object[] groupSortValues;
+
+  public GroupDocs(float maxScore,
+                   int totalHits,
+                   ScoreDoc[] scoreDocs,
+                   GROUP_VALUE_TYPE groupValue,
+                   Object[] groupSortValues) {
+    this.maxScore = maxScore;
+    this.totalHits = totalHits;
+    this.scoreDocs = scoreDocs;
+    this.groupValue = groupValue;
+    this.groupSortValues = groupSortValues;
+  }
+}