org.apache.solr.schema.CompressableField Maven / Gradle / Ivy

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.solr.schema;

import org.apache.lucene.document.Field;
import org.apache.solr.common.params.MapSolrParams;
import org.apache.solr.common.params.SolrParams;
import java.util.Map;

/** CompressableField is an abstract field type which enables a
 * field to be compressed (by specifying compressed="true" at the
 * field definition level) and provides optional support for specifying a
 * threshold at which compression is enabled.
 *
 * Optional settings:
 * 
 *  compressThreshold: length, in characters, at which point the 
 *      field contents should be compressed [default: 0]
 * 

 * 
 * TODO: Enable compression level specification (not yet in lucene)
 * 
 * @version $Id: CompressableField.java 565144 2007-08-12 20:47:42Z ryan $
 */
public abstract class CompressableField extends FieldType {
  /* if field size (in characters) is greater than this threshold, the field 
     will be stored compressed */
  public static int DEFAULT_COMPRESS_THRESHOLD = 0;

  int compressThreshold;

  private static String CT = "compressThreshold";

  protected void init(IndexSchema schema, Map args) {
    SolrParams p = new MapSolrParams(args);
    compressThreshold = p.getInt(CT, DEFAULT_COMPRESS_THRESHOLD);
    args.remove(CT);
    super.init(schema, args);    
  }

    /* Helpers for field construction */
  protected Field.Store getFieldStore(SchemaField field,
                                      String internalVal) {
    /* compress field if length exceeds threshold */
    if(field.isCompressed()) {
      return internalVal.length() >= compressThreshold ? 
        Field.Store.COMPRESS : Field.Store.YES;
    } else
      return super.getFieldStore(field, internalVal);
  } 
}