You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by sa...@apache.org on 2016/05/19 20:31:19 UTC

lucene-solr:branch_6_0: LUCENE-7223: improve XXXPoint javadocs to explain that a StoredField is needed if you want to retrieve the original value at search time

Repository: lucene-solr
Updated Branches:
  refs/heads/branch_6_0 2457d96e3 -> 3e77726b8


LUCENE-7223: improve XXXPoint javadocs to explain that a StoredField is needed if you want to retrieve the original value at search time


Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/3e77726b
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/3e77726b
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/3e77726b

Branch: refs/heads/branch_6_0
Commit: 3e77726b88efad4bcb2127ee6ce393f20dff9f4e
Parents: 2457d96
Author: Mike McCandless <mi...@apache.org>
Authored: Fri Apr 15 13:34:16 2016 -0400
Committer: Steve Rowe <sa...@apache.org>
Committed: Thu May 19 16:31:04 2016 -0400

----------------------------------------------------------------------
 lucene/CHANGES.txt                                             | 6 ++++++
 .../core/src/java/org/apache/lucene/document/BinaryPoint.java  | 3 ++-
 .../core/src/java/org/apache/lucene/document/DoublePoint.java  | 3 ++-
 .../core/src/java/org/apache/lucene/document/FloatPoint.java   | 3 ++-
 lucene/core/src/java/org/apache/lucene/document/IntPoint.java  | 3 ++-
 lucene/core/src/java/org/apache/lucene/document/LongPoint.java | 3 ++-
 6 files changed, 16 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/3e77726b/lucene/CHANGES.txt
----------------------------------------------------------------------
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index 80c7baa..2cfe946 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -42,6 +42,12 @@ Bug Fixes
 * LUCENE-7231: WeightedSpanTermExtractor didn't deal correctly with single-term
   phrase queries. (Eva Popenda, Alan Woodward)
 
+Documentation
+
+* LUCENE-7223: Improve XXXPoint javadocs to make it clear that you
+  should separately add StoredField if you want to retrieve these
+  field values at search time (Greg Huber, Robert Muir, Mike McCandless)
+
 ======================= Lucene 6.0.0 =======================
 
 System Requirements

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/3e77726b/lucene/core/src/java/org/apache/lucene/document/BinaryPoint.java
----------------------------------------------------------------------
diff --git a/lucene/core/src/java/org/apache/lucene/document/BinaryPoint.java b/lucene/core/src/java/org/apache/lucene/document/BinaryPoint.java
index 60fd9d63..8324db4 100644
--- a/lucene/core/src/java/org/apache/lucene/document/BinaryPoint.java
+++ b/lucene/core/src/java/org/apache/lucene/document/BinaryPoint.java
@@ -28,7 +28,8 @@ import org.apache.lucene.util.BytesRef;
 import org.apache.lucene.util.StringHelper;
 
 /** 
- * An indexed binary field.
+ * An indexed binary field for fast range filters.  If you also
+ * need to store the value, you should add a separate {@link StoredField} instance.
  * <p>
  * Finding all documents within an N-dimensional shape or range at search time is
  * efficient.  Multiple values for the same field in one document

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/3e77726b/lucene/core/src/java/org/apache/lucene/document/DoublePoint.java
----------------------------------------------------------------------
diff --git a/lucene/core/src/java/org/apache/lucene/document/DoublePoint.java b/lucene/core/src/java/org/apache/lucene/document/DoublePoint.java
index 53de127..c33676f 100644
--- a/lucene/core/src/java/org/apache/lucene/document/DoublePoint.java
+++ b/lucene/core/src/java/org/apache/lucene/document/DoublePoint.java
@@ -27,7 +27,8 @@ import org.apache.lucene.util.BytesRef;
 import org.apache.lucene.util.NumericUtils;
 
 /** 
- * An indexed {@code double} field.
+ * An indexed {@code double} field for fast range filters.  If you also
+ * need to store the value, you should add a separate {@link StoredField} instance.
  * <p>
  * Finding all documents within an N-dimensional shape or range at search time is
  * efficient.  Multiple values for the same field in one document

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/3e77726b/lucene/core/src/java/org/apache/lucene/document/FloatPoint.java
----------------------------------------------------------------------
diff --git a/lucene/core/src/java/org/apache/lucene/document/FloatPoint.java b/lucene/core/src/java/org/apache/lucene/document/FloatPoint.java
index ab20928..aa5ca66 100644
--- a/lucene/core/src/java/org/apache/lucene/document/FloatPoint.java
+++ b/lucene/core/src/java/org/apache/lucene/document/FloatPoint.java
@@ -27,7 +27,8 @@ import org.apache.lucene.util.BytesRef;
 import org.apache.lucene.util.NumericUtils;
 
 /** 
- * An indexed {@code float} field.
+ * An indexed {@code float} field for fast range filters.  If you also
+ * need to store the value, you should add a separate {@link StoredField} instance.
  * <p>
  * Finding all documents within an N-dimensional at search time is
  * efficient.  Multiple values for the same field in one document

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/3e77726b/lucene/core/src/java/org/apache/lucene/document/IntPoint.java
----------------------------------------------------------------------
diff --git a/lucene/core/src/java/org/apache/lucene/document/IntPoint.java b/lucene/core/src/java/org/apache/lucene/document/IntPoint.java
index db24fc9..084bf16 100644
--- a/lucene/core/src/java/org/apache/lucene/document/IntPoint.java
+++ b/lucene/core/src/java/org/apache/lucene/document/IntPoint.java
@@ -27,7 +27,8 @@ import org.apache.lucene.util.BytesRef;
 import org.apache.lucene.util.NumericUtils;
 
 /** 
- * An indexed {@code int} field.
+ * An indexed {@code int} field for fast range filters.  If you also
+ * need to store the value, you should add a separate {@link StoredField} instance.
  * <p>
  * Finding all documents within an N-dimensional shape or range at search time is
  * efficient.  Multiple values for the same field in one document

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/3e77726b/lucene/core/src/java/org/apache/lucene/document/LongPoint.java
----------------------------------------------------------------------
diff --git a/lucene/core/src/java/org/apache/lucene/document/LongPoint.java b/lucene/core/src/java/org/apache/lucene/document/LongPoint.java
index ab2cb6f..f7e708b 100644
--- a/lucene/core/src/java/org/apache/lucene/document/LongPoint.java
+++ b/lucene/core/src/java/org/apache/lucene/document/LongPoint.java
@@ -27,7 +27,8 @@ import org.apache.lucene.util.BytesRef;
 import org.apache.lucene.util.NumericUtils;
 
 /** 
- * An indexed {@code long} field.
+ * An indexed {@code long} field for fast range filters.  If you also
+ * need to store the value, you should add a separate {@link StoredField} instance.
  * <p>
  * Finding all documents within an N-dimensional shape or range at search time is
  * efficient.  Multiple values for the same field in one document