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

lucene-solr:master: 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/master b513df6c4 -> c7d408082


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/c7d40808
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/c7d40808
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/c7d40808

Branch: refs/heads/master
Commit: c7d4080820b0b50d09c7e1ddb5e68b325ab145b7
Parents: b513df6
Author: Mike McCandless <mi...@apache.org>
Authored: Fri Apr 15 13:34:16 2016 -0400
Committer: Mike McCandless <mi...@apache.org>
Committed: Fri Apr 15 13:34:16 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/c7d40808/lucene/CHANGES.txt
----------------------------------------------------------------------
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index 717d958..d7e1b39 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -84,6 +84,12 @@ Bug Fixes
   that led to IllegalStateException being thrown when nothing was wrong.
   (David Smiley, yonik)  
 
+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)
+
 Other
 
 * LUCENE-7174: Upgrade randomizedtesting to 2.3.4. (Uwe Schindler, Dawid Weiss)

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/c7d40808/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 7132a5d..3b0a0e9 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/c7d40808/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 102e94f..9a383a4 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/c7d40808/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 f3626cf..8d84269 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/c7d40808/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 41be876..8b3484b 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/c7d40808/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 6f45962..686086c 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