svn commit: r1332334 - /lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldPostingsFormat.java

[rm...@apache.org]

Author: rmuir
Date: Mon Apr 30 18:40:02 2012
New Revision: 1332334

URL: http://svn.apache.org/viewvc?rev=1332334&view=rev
Log:
LUCENE-2946: doc 4.0 per-field postings format

Modified:
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldPostingsFormat.java

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldPostingsFormat.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldPostingsFormat.java?rev=1332334&r1=1332333&r2=1332334&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldPostingsFormat.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldPostingsFormat.java Mon Apr 30 18:40:02 2012
@@ -39,6 +39,7 @@ import org.apache.lucene.index.SegmentIn
 import org.apache.lucene.index.SegmentReadState;
 import org.apache.lucene.index.SegmentWriteState;
 import org.apache.lucene.index.Terms;
+import org.apache.lucene.store.DataOutput; // javadocs
 import org.apache.lucene.store.Directory;
 import org.apache.lucene.store.IOContext;
 import org.apache.lucene.store.IndexInput;
@@ -55,6 +56,21 @@ import org.apache.lucene.util.IOUtils;
  * This method uses Java's 
  * {@link ServiceLoader Service Provider Interface} to resolve format names.
  * <p>
+ * PerFieldFile format:
+ * <ul>
+ *   <li>PerFieldFile (.per) --&gt; Header, IdToFormat, FieldToFormat</li>
+ *   <li>Header --&gt; {@link CodecUtil#checkHeader CodecHeader}</li>
+ *   <li>IdToFormat,FieldToFormat --&gt; {@link DataOutput#writeStringStringMap(Map) Map&lt;String,String&gt;}</li> 
+ * </ul>
+ * <p>Notes:</p>
+ * <ul>
+ *   <li>each format is assigned an id, and files written by that posting format
+ *       have an additional suffix containing the id. For example, in a per-field
+ *       configuration instead of <tt>_1.prx</tt> filenames would look like 
+ *       <tt>_1_0.prx</tt>.</li>
+ *   <li>IdToFormat is a mapping between these ids and the available formats.</li>
+ *   <li>FieldToFormat is a mapping between field names and format names.</li>
+ * </ul>
  * @see ServiceLoader
  * @lucene.experimental
  */