pylucene 3.5.0-3

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

diff --git a/lucene-java-3.5.0/lucene/src/java/org/apache/lucene/search/ScoreDoc.java b/lucene-java-3.5.0/lucene/src/java/org/apache/lucene/search/ScoreDoc.java
new file mode 100644 (file)
index 0000000..5237a94
--- /dev/null
+++ b/lucene-java-3.5.0/lucene/src/java/org/apache/lucene/search/ScoreDoc.java
@@ -0,0 +1,51 @@
+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.
+ */
+
+/** Holds one hit in {@link TopDocs}. */
+
+public class ScoreDoc implements java.io.Serializable {
+
+  /** The score of this document for the query. */
+  public float score;
+
+  /** Expert: A hit document's number.
+   * @see Searcher#doc(int) */
+  public int doc;
+
+  /** Only set by {@link TopDocs#merge} */
+  public int shardIndex;
+
+  /** Constructs a ScoreDoc. */
+  public ScoreDoc(int doc, float score) {
+    this(doc, score, -1);
+  }
+
+  /** Constructs a ScoreDoc. */
+  public ScoreDoc(int doc, float score, int shardIndex) {
+    this.doc = doc;
+    this.score = score;
+    this.shardIndex = shardIndex;
+  }
+  
+  // A convenience method for debugging.
+  @Override
+  public String toString() {
+    return "doc=" + doc + " score=" + score;
+  }
+}