docs/attachments/LUCENE-1561/LUCENE-1561.patch

Index: src/java/org/apache/lucene/index/DocFieldProcessorPerThread.java
===================================================================
--- src/java/org/apache/lucene/index/DocFieldProcessorPerThread.java	(revision 762732)
+++ src/java/org/apache/lucene/index/DocFieldProcessorPerThread.java	(working copy)
@@ -183,7 +183,7 @@
         // easily add it
         FieldInfo fi = fieldInfos.add(fieldName, field.isIndexed(), field.isTermVectorStored(),
                                       field.isStorePositionWithTermVector(), field.isStoreOffsetWithTermVector(),
-                                      field.getOmitNorms(), false, field.getOmitTermFreqAndPositions());
+                                      field.getOmitNorms(), false, field.getOmitTf());
 
         fp = new DocFieldProcessorPerField(this, fi);
         fp.next = fieldHash[hashPos];
@@ -195,7 +195,7 @@
       } else
         fp.fieldInfo.update(field.isIndexed(), field.isTermVectorStored(),
                             field.isStorePositionWithTermVector(), field.isStoreOffsetWithTermVector(),
-                            field.getOmitNorms(), false, field.getOmitTermFreqAndPositions());
+                            field.getOmitNorms(), false, field.getOmitTf());
 
       if (thisFieldGen != fp.lastGen) {
 
Index: src/java/org/apache/lucene/index/CheckIndex.java
===================================================================
--- src/java/org/apache/lucene/index/CheckIndex.java	(revision 762732)
+++ src/java/org/apache/lucene/index/CheckIndex.java	(working copy)
@@ -20,6 +20,7 @@
 import org.apache.lucene.store.FSDirectory;
 import org.apache.lucene.store.Directory;
 import org.apache.lucene.store.IndexInput;
+import org.apache.lucene.document.AbstractField;  // for javadocs
 import org.apache.lucene.document.Document;
 
 import java.text.NumberFormat;
@@ -167,7 +168,7 @@
 
       /** True if at least one of the fields in this segment
        *  does not omitTermFreqAndPositions.
-       *  @see Fieldable#setOmitTermFreqAndPositions */
+       *  @see AbstractField#setOmitTermFreqAndPositions */
       public boolean hasProx;
     }
   }
Index: src/java/org/apache/lucene/document/AbstractField.java
===================================================================
--- src/java/org/apache/lucene/document/AbstractField.java	(revision 762732)
+++ src/java/org/apache/lucene/document/AbstractField.java	(working copy)
@@ -15,7 +15,10 @@
  * limitations under the License.
  */
 
+import org.apache.lucene.search.PhraseQuery; // for javadocs
+import org.apache.lucene.search.spans.SpanQuery; // for javadocs
 
+
 /**
  *
  *
@@ -263,8 +266,10 @@
   /** True if norms are omitted for this indexed field */
   public boolean getOmitNorms() { return omitNorms; }
 
+  /** @deprecated Renamed to {@link #getOmitTermFreqAndPositions} */
   public boolean getOmitTf() { return omitTermFreqAndPositions; }
 
+  /** @see #setOmitTermFreqAndPositions */
   public boolean getOmitTermFreqAndPositions() { return omitTermFreqAndPositions; }
   
   /** Expert:
@@ -274,8 +279,19 @@
    */
   public void setOmitNorms(boolean omitNorms) { this.omitNorms=omitNorms; }
 
+  /** @deprecated Renamed to {@link #setOmitTermFreqAndPositions} */
   public void setOmitTf(boolean omitTermFreqAndPositions) { this.omitTermFreqAndPositions=omitTermFreqAndPositions; }
 
+  /** Expert:
+   *
+   * If set, omit term freq, positions and payloads from postings for this field.
+   * <p><b>NOTE</b>: this is a dangerous option to enable.
+   * While it reduces storage space required in the index,
+   * it also means any query requiring positional
+   * information, such as {@link PhraseQuery} or {@link
+   * SpanQuery} subclasses will silently fail to find
+   * results.
+   */
   public void setOmitTermFreqAndPositions(boolean omitTermFreqAndPositions) { this.omitTermFreqAndPositions=omitTermFreqAndPositions; }
  
   public boolean isLazy() {
Index: src/java/org/apache/lucene/document/Fieldable.java
===================================================================
--- src/java/org/apache/lucene/document/Fieldable.java	(revision 762732)
+++ src/java/org/apache/lucene/document/Fieldable.java	(working copy)
@@ -147,27 +147,12 @@
    */
   void setOmitNorms(boolean omitNorms);
 
-  /** @deprecated Renamed to {@link #setOmitTermFreqAndPositions} */
+  /** @deprecated Renamed to {@link AbstractField#setOmitTermFreqAndPositions} */
   void setOmitTf(boolean omitTf);
 
-  /** @deprecated Renamed to {@link #getOmitTermFreqAndPositions} */
+  /** @deprecated Renamed to {@link AbstractField#getOmitTermFreqAndPositions} */
   boolean getOmitTf();
 
-  /** Expert:
-   *
-   * If set, omit term freq, positions and payloads from postings for this field.
-   * <p><b>NOTE</b>: this is a dangerous option to enable.
-   * While it reduces storage space required in the index,
-   * it also means any query requiring positional
-   * infromation, such as {@link PhraseQuery} or {@link
-   * SpanQuery} subclasses will silently fail to find
-   * results.
-   */
-  void setOmitTermFreqAndPositions(boolean omitTermFreqAndPositions);
-
-  /** True if tf is omitted for this indexed field */
-  boolean getOmitTermFreqAndPositions();
-
   /**
    * Indicates whether a Field is Lazy or not.  The semantics of Lazy loading are such that if a Field is lazily loaded, retrieving
    * it's values via {@link #stringValue()} or {@link #binaryValue()} is only valid as long as the {@link org.apache.lucene.index.IndexReader} that