svn commit: r1336328 - /lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40DocValuesFormat.java

[si...@apache.org]

Author: simonw
Date: Wed May  9 18:24:11 2012
New Revision: 1336328

URL: http://svn.apache.org/viewvc?rev=1336328&view=rev
Log:
update Lucene40DocValuesFormat documentation

Modified:
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40DocValuesFormat.java

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40DocValuesFormat.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40DocValuesFormat.java?rev=1336328&r1=1336327&r2=1336328&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40DocValuesFormat.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40DocValuesFormat.java Wed May  9 18:24:11 2012
@@ -53,7 +53,6 @@ import org.apache.lucene.util.packed.Pac
  * actually contains only the unique values, and an additional <tt>.idx</tt> file contains
  * pointers to these unique values.
  * </p>
- * <!-- TODO: review these and make sure everything is actually accurate -->
  * Formats:
  * <ul>
  *    <li>{@link Type#VAR_INTS VAR_INTS} .dat --&gt; Header, PackedType, MinValue, 
@@ -72,6 +71,8 @@ import org.apache.lucene.util.packed.Pac
  *        Float64<sup>maxdoc</sup></li>
  *    <li>{@link Type#BYTES_FIXED_STRAIGHT BYTES_FIXED_STRAIGHT} .dat --&gt; Header, ValueSize,
  *        ({@link DataOutput#writeByte Byte} * ValueSize)<sup>maxdoc</sup></li>
+ *    <li>{@link Type#BYTES_VAR_STRAIGHT BYTES_VAR_STRAIGHT} .idx --&gt; Header, MaxAddress,
+ *        Addresses</li>
  *    <li>{@link Type#BYTES_VAR_STRAIGHT BYTES_VAR_STRAIGHT} .dat --&gt; Header, TotalBytes,
  *        Addresses, ({@link DataOutput#writeByte Byte} *
  *        <i>variable ValueSize</i>)<sup>maxdoc</sup></li>
@@ -96,7 +97,7 @@ import org.apache.lucene.util.packed.Pac
  * <ul>
  *    <li>Header --&gt; {@link CodecUtil#writeHeader CodecHeader}</li>
  *    <li>PackedType --&gt; {@link DataOutput#writeByte Byte}</li>
- *    <li>MinValue, DefaultValue --&gt; {@link DataOutput#writeLong Int64}</li>
+ *    <li>MaxAddress, MinValue, DefaultValue --&gt; {@link DataOutput#writeLong Int64}</li>
  *    <li>PackedStream, Addresses, Ordinals --&gt; {@link PackedInts}</li>
  *    <li>ValueSize, NumValues --&gt; {@link DataOutput#writeInt Int32}</li>
  *    <li>Float32 --&gt; 32-bit float encoded with {@link Float#floatToRawIntBits(float)}
@@ -123,6 +124,10 @@ import org.apache.lucene.util.packed.Pac
  *        In the VAR_SORTED case, there is double indirection (docid -> ordinal -> address), but
  *        an additional sentinel ordinal+address is always written (so there are NumValues+1 ordinals). To
  *        determine the length, ord+1's address is looked up as well.</li>
+ *    <li>{@link Type#BYTES_VAR_STRAIGHT BYTES_VAR_STRAIGHT} in contrast to other straight 
+ *        variants uses a <tt>.idx</tt> file to improve lookup perfromance. In contrast to 
+ *        {@link Type#BYTES_VAR_DEREF BYTES_VAR_DEREF} it doesn't apply deduplication of the document values.
+ *    </li>
  * </ul>
  */
 public class Lucene40DocValuesFormat extends DocValuesFormat {