jp.co.yahoo.yosegi.binary.ColumnBinaryMakerConfig Maven / Gradle / Ivy

Go to download
/**
 * 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 jp.co.yahoo.yosegi.binary;

import jp.co.yahoo.yosegi.binary.maker.DumpSpreadColumnBinaryMaker;
import jp.co.yahoo.yosegi.binary.maker.DumpUnionColumnBinaryMaker;
import jp.co.yahoo.yosegi.binary.maker.FlagIndexedOptimizedNullArrayDumpBooleanColumnBinaryMaker;
import jp.co.yahoo.yosegi.binary.maker.IColumnBinaryMaker;
import jp.co.yahoo.yosegi.binary.maker.MaxLengthBasedArrayColumnBinaryMaker;
import jp.co.yahoo.yosegi.binary.maker.OptimizedNullArrayDumpBooleanColumnBinaryMaker;
import jp.co.yahoo.yosegi.binary.maker.OptimizedNullArrayDumpBytesColumnBinaryMaker;
import jp.co.yahoo.yosegi.binary.maker.OptimizedNullArrayDumpDoubleColumnBinaryMaker;
import jp.co.yahoo.yosegi.binary.maker.OptimizedNullArrayDumpFloatColumnBinaryMaker;
import jp.co.yahoo.yosegi.binary.maker.OptimizedNullArrayDumpLongColumnBinaryMaker;
import jp.co.yahoo.yosegi.binary.maker.OptimizedNullArrayDumpStringColumnBinaryMaker;
import jp.co.yahoo.yosegi.binary.maker.UnsupportedColumnBinaryMaker;
import jp.co.yahoo.yosegi.compressor.CompressionPolicy;
import jp.co.yahoo.yosegi.compressor.FindCompressor;
import jp.co.yahoo.yosegi.compressor.GzipCompressor;
import jp.co.yahoo.yosegi.compressor.ICompressor;
import jp.co.yahoo.yosegi.config.Configuration;
import jp.co.yahoo.yosegi.spread.column.ColumnType;

import java.io.IOException;

/**
 * This class holds the settings for serialization of IColumnBinaryMaker.
 * The internal variables consist of a combination of type and IColumnBinaryMaker,
 * compression codec, and parameters related to compression optimization.
 * The default IColumnBinaryMaker should be a class that is efficient and stable on average.
 *
 * 
This class is intended to define default settings and column-specific settings respectively.
 *
 * 
This class does not determine if IColumnBinaryMaker is appropriate for the type.
 *
 * Multi-threading is not supported because references to variables are made directly.
 */
public class ColumnBinaryMakerConfig {

  public Configuration param = new Configuration();

  public ICompressor compressorClass;

  public IColumnBinaryMaker unionMakerClass;
  public IColumnBinaryMaker arrayMakerClass;
  public IColumnBinaryMaker spreadMakerClass;

  public IColumnBinaryMaker booleanMakerClass;
  public IColumnBinaryMaker byteMakerClass;
  public IColumnBinaryMaker bytesMakerClass;
  public IColumnBinaryMaker doubleMakerClass;
  public IColumnBinaryMaker floatMakerClass;
  public IColumnBinaryMaker integerMakerClass;
  public IColumnBinaryMaker longMakerClass;
  public IColumnBinaryMaker shortMakerClass;
  public IColumnBinaryMaker stringMakerClass;

  public CompressionPolicy compressionPolicy;
  public double allowedRatio;

  /**
   * Initialize with the default value.
   * Each variable is set to the newly created object.
   *
   * @throws IOException Occurs when a class does not exist when an instance is created.
   *         However, it should not occur because we are assigning names from classes.
   */
  public ColumnBinaryMakerConfig() throws IOException {
    compressorClass = FindCompressor.get( GzipCompressor.class.getName() );

    unionMakerClass = FindColumnBinaryMaker.get( DumpUnionColumnBinaryMaker.class.getName() );
    arrayMakerClass = FindColumnBinaryMaker.get(
        MaxLengthBasedArrayColumnBinaryMaker.class.getName() );
    spreadMakerClass = FindColumnBinaryMaker.get( DumpSpreadColumnBinaryMaker.class.getName() );

    booleanMakerClass = FindColumnBinaryMaker.get(
        FlagIndexedOptimizedNullArrayDumpBooleanColumnBinaryMaker.class.getName() );
    byteMakerClass = FindColumnBinaryMaker.get(
        OptimizedNullArrayDumpLongColumnBinaryMaker.class.getName() );
    doubleMakerClass = FindColumnBinaryMaker.get(
        OptimizedNullArrayDumpDoubleColumnBinaryMaker.class.getName() );
    floatMakerClass = FindColumnBinaryMaker.get(
        OptimizedNullArrayDumpFloatColumnBinaryMaker.class.getName() );
    integerMakerClass = FindColumnBinaryMaker.get(
        OptimizedNullArrayDumpLongColumnBinaryMaker.class.getName() );
    longMakerClass = FindColumnBinaryMaker.get(
        OptimizedNullArrayDumpLongColumnBinaryMaker.class.getName() );
    shortMakerClass = FindColumnBinaryMaker.get(
        OptimizedNullArrayDumpLongColumnBinaryMaker.class.getName() );

    stringMakerClass = FindColumnBinaryMaker.get(
        OptimizedNullArrayDumpStringColumnBinaryMaker.class.getName() );
    bytesMakerClass = FindColumnBinaryMaker.get(
        OptimizedNullArrayDumpBytesColumnBinaryMaker.class.getName() );

    compressionPolicy = CompressionPolicy.DEFAULT;
    allowedRatio = 1.15d;
  }

  /**
   * Initialize with other Config settings.
   * The purpose of this constructor is to prevent creating unnecessary
   * objects when you want to create the same settings.
   * For example, if you want to duplicate the same settings in a nested column.
   */
  public ColumnBinaryMakerConfig( final ColumnBinaryMakerConfig otherConfig ) {
    this.compressorClass = otherConfig.compressorClass;
    this.unionMakerClass = otherConfig.unionMakerClass;
    this.arrayMakerClass = otherConfig.arrayMakerClass;
    this.spreadMakerClass = otherConfig.spreadMakerClass;
    this.booleanMakerClass = otherConfig.booleanMakerClass;
    this.byteMakerClass = otherConfig.byteMakerClass;
    this.bytesMakerClass = otherConfig.bytesMakerClass;
    this.doubleMakerClass = otherConfig.doubleMakerClass;
    this.floatMakerClass = otherConfig.floatMakerClass;
    this.integerMakerClass = otherConfig.integerMakerClass;
    this.longMakerClass = otherConfig.longMakerClass;
    this.shortMakerClass = otherConfig.shortMakerClass;
    this.stringMakerClass = otherConfig.stringMakerClass;
    this.compressionPolicy = otherConfig.compressionPolicy;
    this.allowedRatio = otherConfig.allowedRatio;
  }

  /**
   * Select IColumnBinaryMaker from column type.
   * The purpose of this method is to prevent it from being duplicated
   * in classes that use type-specific judgment processing.
   *
   * @return Returns the appropriate variable for the type.
   */
  public IColumnBinaryMaker getColumnMaker( final ColumnType columnType ) {
    switch ( columnType ) {
      case UNION:
        return unionMakerClass;
      case ARRAY:
        return arrayMakerClass;
      case SPREAD:
        return spreadMakerClass;

      case BOOLEAN:
        return booleanMakerClass;
      case BYTE:
        return byteMakerClass;
      case BYTES:
        return bytesMakerClass;
      case DOUBLE:
        return doubleMakerClass;
      case FLOAT:
        return floatMakerClass;
      case INTEGER:
        return integerMakerClass;
      case LONG:
        return longMakerClass;
      case SHORT:
        return shortMakerClass;
      case STRING:
        return stringMakerClass;

      case NULL:
      case EMPTY_ARRAY:
      case EMPTY_SPREAD:
      default:
        return new UnsupportedColumnBinaryMaker();
    }
  }

}