You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by rm...@apache.org on 2013/01/08 04:08:11 UTC

svn commit: r1430123 - /lucene/dev/branches/lucene4547/lucene/core/src/java/org/apache/lucene/codecs/lucene41/Lucene41SimpleDocValuesFormat.java

Author: rmuir
Date: Tue Jan  8 03:08:11 2013
New Revision: 1430123

URL: http://svn.apache.org/viewvc?rev=1430123&view=rev
Log:
javadocs

Modified:
    lucene/dev/branches/lucene4547/lucene/core/src/java/org/apache/lucene/codecs/lucene41/Lucene41SimpleDocValuesFormat.java

Modified: lucene/dev/branches/lucene4547/lucene/core/src/java/org/apache/lucene/codecs/lucene41/Lucene41SimpleDocValuesFormat.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene4547/lucene/core/src/java/org/apache/lucene/codecs/lucene41/Lucene41SimpleDocValuesFormat.java?rev=1430123&r1=1430122&r2=1430123&view=diff
==============================================================================
--- lucene/dev/branches/lucene4547/lucene/core/src/java/org/apache/lucene/codecs/lucene41/Lucene41SimpleDocValuesFormat.java (original)
+++ lucene/dev/branches/lucene4547/lucene/core/src/java/org/apache/lucene/codecs/lucene41/Lucene41SimpleDocValuesFormat.java Tue Jan  8 03:08:11 2013
@@ -42,6 +42,18 @@ import org.apache.lucene.util.IOUtils;
 import org.apache.lucene.util.packed.PackedInts;
 import org.apache.lucene.util.packed.PackedInts.FormatAndBits;
 
+// nocommit fix this
+/**
+ * Internally there are only 2 field types:
+ * BINARY: a big byte[]
+ * NUMERIC: packed ints
+ *
+ * NumericField = NUMERIC
+ * fixedLength BinaryField = BINARY
+ * variableLength BinaryField = BINARY + NUMERIC (addresses)
+ * fixedLength SortedField = BINARY + NUMERIC (ords)
+ * variableLength SortedField = BINARY + NUMERIC (addresses) + NUMERIC (ords) 
+ */
 public class Lucene41SimpleDocValuesFormat extends SimpleDocValuesFormat {
 
   public Lucene41SimpleDocValuesFormat() {
@@ -266,7 +278,7 @@ public class Lucene41SimpleDocValuesForm
 
     @Override
     public NumericDocValues getNumeric(FieldInfo field) throws IOException {
-      // nocommit: user can currently get back a numericDV of the addresses...
+      // nocommit: user can currently get back a numericDV of the addresses...?
       NumericEntry entry = numerics.get(field.number);
       return getNumeric(field, entry);
     }
@@ -291,6 +303,7 @@ public class Lucene41SimpleDocValuesForm
 
     @Override
     public BinaryDocValues getBinary(FieldInfo field) throws IOException {
+      // nocommit: user can currently get back a binaryDV of the uniqueValues...?
       BinaryEntry bytes = binaries.get(field.number);
       if (bytes.minLength == bytes.maxLength) {
         return getFixedBinary(field, bytes);