From 6ae1c862f430cf429af1b6b0affe9a0b024df197 Mon Sep 17 00:00:00 2001
From: Yonik Seeley <yonik@apache.org>
Date: Mon, 23 Feb 2009 03:27:43 +0000
Subject: [PATCH] SOLR-739: Add support for OmitTf

git-svn-id: https://svn.apache.org/repos/asf/lucene/solr/trunk@746868 13f79535-47bb-0310-9956-ffa450edef68
---
 CHANGES.txt                                    |  1 +
 example/solr/conf/schema.xml                   |  7 ++++---
 .../org/apache/solr/common/luke/FieldFlag.java |  1 +
 .../solr/handler/admin/LukeRequestHandler.java |  1 +
 .../apache/solr/schema/FieldProperties.java    | 18 ++++++++++--------
 src/java/org/apache/solr/schema/FieldType.java |  4 +++-
 .../org/apache/solr/schema/SchemaField.java    |  3 ++-
 src/java/org/apache/solr/schema/TextField.java |  2 ++
 8 files changed, 24 insertions(+), 13 deletions(-)

diff --git a/CHANGES.txt b/CHANGES.txt
index 84b594c308b..b1747c73389 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -158,6 +158,7 @@ New Features
 
 27. SOLR-1026: Add protected words support to SnowballPorterFilterFactory (ehatcher)
 
+28. SOLR-739: Add support for OmitTf (Mark Miller via yonik)
 
 Optimizations
 ----------------------
diff --git a/example/solr/conf/schema.xml b/example/solr/conf/schema.xml
index 62221e7c7ad..cc8c6eeae2c 100755
--- a/example/solr/conf/schema.xml
+++ b/example/solr/conf/schema.xml
@@ -32,13 +32,14 @@
  be used for benchmarking.
 -->
 
-<schema name="example" version="1.1">
+<schema name="example" version="1.2">
   <!-- attribute "name" is the name of this schema and is only used for display purposes.
        Applications should change this to reflect the nature of the search collection.
-       version="1.1" is Solr's version number for the schema syntax and semantics.  It should
+       version="1.2" is Solr's version number for the schema syntax and semantics.  It should
        not normally be changed by applications.
        1.0: multiValued attribute did not exist, all fields are multiValued by nature
-       1.1: multiValued attribute introduced, false by default -->
+       1.1: multiValued attribute introduced, false by default 
+       1.2: omitTf attribute introduced, true by default -->
 
   <types>
     <!-- field type definitions. The "name" attribute is
diff --git a/src/common/org/apache/solr/common/luke/FieldFlag.java b/src/common/org/apache/solr/common/luke/FieldFlag.java
index 63d835682a4..63bb8330512 100644
--- a/src/common/org/apache/solr/common/luke/FieldFlag.java
+++ b/src/common/org/apache/solr/common/luke/FieldFlag.java
@@ -30,6 +30,7 @@ public enum FieldFlag {
   TERM_VECTOR_OFFSET('o', "Store Offset With TermVector"),
   TERM_VECTOR_POSITION('p', "Store Position With TermVector"),
   OMIT_NORMS('O', "Omit Norms"), 
+  OMIT_TF('F', "Omit Tf"), 
   LAZY('L', "Lazy"), 
   BINARY('B', "Binary"), 
   COMPRESSED('C', "Compressed"),
diff --git a/src/java/org/apache/solr/handler/admin/LukeRequestHandler.java b/src/java/org/apache/solr/handler/admin/LukeRequestHandler.java
index 6e06b44ff2d..17bdc0c2cae 100644
--- a/src/java/org/apache/solr/handler/admin/LukeRequestHandler.java
+++ b/src/java/org/apache/solr/handler/admin/LukeRequestHandler.java
@@ -198,6 +198,7 @@ public class LukeRequestHandler extends RequestHandlerBase
     flags.append( (f != null && f.storeTermOffsets() )   ? FieldFlag.TERM_VECTOR_OFFSET.getAbbreviation() : '-' );
     flags.append( (f != null && f.storeTermPositions() ) ? FieldFlag.TERM_VECTOR_POSITION.getAbbreviation() : '-' );
     flags.append( (f != null && f.omitNorms())           ? FieldFlag.OMIT_NORMS.getAbbreviation() : '-' );
+    flags.append( (f != null && f.omitTf())              ? FieldFlag.OMIT_TF.getAbbreviation() : '-' );
     flags.append( (lazy)                                 ? FieldFlag.LAZY.getAbbreviation() : '-' );
     flags.append( (binary)                               ? FieldFlag.BINARY.getAbbreviation() : '-' );
     flags.append( (f != null && f.isCompressed())        ? FieldFlag.COMPRESSED.getAbbreviation() : '-' );
diff --git a/src/java/org/apache/solr/schema/FieldProperties.java b/src/java/org/apache/solr/schema/FieldProperties.java
index b9228134781..edbca4ab0ee 100644
--- a/src/java/org/apache/solr/schema/FieldProperties.java
+++ b/src/java/org/apache/solr/schema/FieldProperties.java
@@ -35,19 +35,21 @@ abstract class FieldProperties {
   final static int BINARY              = 0x00000008;
   final static int COMPRESSED          = 0x00000010;
   final static int OMIT_NORMS          = 0x00000020;
-  final static int STORE_TERMVECTORS   = 0x00000040;
-  final static int STORE_TERMPOSITIONS = 0x00000080;
-  final static int STORE_TERMOFFSETS   = 0x00000100;
+  final static int OMIT_TF             = 0x00000040;
+  final static int STORE_TERMVECTORS   = 0x00000080;
+  final static int STORE_TERMPOSITIONS = 0x00000100;
+  final static int STORE_TERMOFFSETS   = 0x00000200;
 
-  final static int MULTIVALUED         = 0x00000200;
-  final static int SORT_MISSING_FIRST  = 0x00000400;
-  final static int SORT_MISSING_LAST   = 0x00000800;
+
+  final static int MULTIVALUED         = 0x00000400;
+  final static int SORT_MISSING_FIRST  = 0x00000800;
+  final static int SORT_MISSING_LAST   = 0x00001000;
   
-  final static int REQUIRED            = 0x00001000;
+  final static int REQUIRED            = 0x00002000;
   
   static final String[] propertyNames = {
           "indexed", "tokenized", "stored",
-          "binary", "compressed", "omitNorms",
+          "binary", "compressed", "omitNorms", "omitTf",
           "termVectors", "termPositions", "termOffsets",
           "multiValued",
           "sortMissingFirst","sortMissingLast","required"
diff --git a/src/java/org/apache/solr/schema/FieldType.java b/src/java/org/apache/solr/schema/FieldType.java
index 507a36afd4e..2fb3b5a4b82 100644
--- a/src/java/org/apache/solr/schema/FieldType.java
+++ b/src/java/org/apache/solr/schema/FieldType.java
@@ -86,9 +86,10 @@ public abstract class FieldType extends FieldProperties {
 
   // Handle additional arguments...
   void setArgs(IndexSchema schema, Map<String,String> args) {
-    // default to STORED and INDEXED, and MULTIVALUED depending on schema version
+    // default to STORED, INDEXED, OMIT_TF and MULTIVALUED depending on schema version
     properties = (STORED | INDEXED);
     if (schema.getVersion()< 1.1f) properties |= MULTIVALUED;
+    if (schema.getVersion()> 1.1f) properties |= OMIT_TF;
 
     this.args=args;
     Map<String,String> initArgs = new HashMap<String,String>(args);
@@ -199,6 +200,7 @@ public abstract class FieldType extends FieldProperties {
                         getFieldIndex(field, val),
                         getFieldTermVec(field, val));
     f.setOmitNorms(field.omitNorms());
+    f.setOmitTf(field.omitTf());
     f.setBoost(boost);
     return f;
   }
diff --git a/src/java/org/apache/solr/schema/SchemaField.java b/src/java/org/apache/solr/schema/SchemaField.java
index 8005aa797bc..d8b6a46a1a5 100644
--- a/src/java/org/apache/solr/schema/SchemaField.java
+++ b/src/java/org/apache/solr/schema/SchemaField.java
@@ -79,6 +79,7 @@ public final class SchemaField extends FieldProperties {
   public boolean storeTermPositions() { return (properties & STORE_TERMPOSITIONS)!=0; }
   public boolean storeTermOffsets() { return (properties & STORE_TERMOFFSETS)!=0; }
   public boolean omitNorms() { return (properties & OMIT_NORMS)!=0; }
+  public boolean omitTf() { return (properties & OMIT_TF)!=0; }
   public boolean multiValued() { return (properties & MULTIVALUED)!=0; }
   public boolean sortMissingFirst() { return (properties & SORT_MISSING_FIRST)!=0; }
   public boolean sortMissingLast() { return (properties & SORT_MISSING_LAST)!=0; }
@@ -136,7 +137,7 @@ public final class SchemaField extends FieldProperties {
     }
 
     if (on(falseProps,INDEXED)) {
-      int pp = (INDEXED | OMIT_NORMS
+      int pp = (INDEXED | OMIT_NORMS | OMIT_TF 
               | STORE_TERMVECTORS | STORE_TERMPOSITIONS | STORE_TERMOFFSETS
               | SORT_MISSING_FIRST | SORT_MISSING_LAST);
       if (on(pp,trueProps)) {
diff --git a/src/java/org/apache/solr/schema/TextField.java b/src/java/org/apache/solr/schema/TextField.java
index 98c1458c916..cdca8db09d0 100644
--- a/src/java/org/apache/solr/schema/TextField.java
+++ b/src/java/org/apache/solr/schema/TextField.java
@@ -32,6 +32,8 @@ import java.io.IOException;
 public class TextField extends CompressableField {
   protected void init(IndexSchema schema, Map<String,String> args) {
     properties |= TOKENIZED;
+    if (schema.getVersion()> 1.1f) properties &= ~OMIT_TF;
+    
     super.init(schema, args);    
   }