FlattenerTargetField.java

/*! ******************************************************************************
 *
 * Pentaho Data Integration
 *
 * Copyright (C) 2002-2016 by Pentaho : http://www.pentaho.com
 *
 *******************************************************************************
 *
 * Licensed 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.pentaho.di.trans.steps.flattener;

import org.pentaho.di.core.row.value.ValueMetaFactory;
import org.pentaho.di.i18n.BaseMessages;

public class FlattenerTargetField {
  private static Class<?> PKG = FlattenerMeta.class; // for i18n purposes, needed by Translator2!!

  private String fieldName;
  private String keyValue;
  private String targetName;
  private int targetType;
  private int targetLength;
  private int targetPrecision;
  private String targetCurrencySymbol;
  private String targetDecimalSymbol;
  private String targetGroupingSymbol;
  private String targetNullString;
  private String targetFormat;
  private int targetAggregationType;

  public static final int TYPE_AGGR_NONE = 0;
  public static final int TYPE_AGGR_SUM = 1;
  public static final int TYPE_AGGR_AVERAGE = 2;
  public static final int TYPE_AGGR_MIN = 3;
  public static final int TYPE_AGGR_MAX = 4;
  public static final int TYPE_AGGR_COUNT_ALL = 5;
  public static final int TYPE_AGGR_CONCAT_COMMA = 6;

  public static final String[] typeAggrCode = /* WARNING: DO NOT TRANSLATE THIS. WE ARE SERIOUS, DON'T TRANSLATE! */
  { "-", "SUM", "AVERAGE", "MIN", "MAX", "COUNT_ALL", "CONCAT_COMMA"
  };

  public static final String[] typeAggrLongDesc =
  {
    "-", BaseMessages.getString( PKG, "FlattenerTargetField.TypeAggrLongDesc.SUM" ),
    BaseMessages.getString( PKG, "FlattenerTargetField.TypeAggrLongDesc.AVERAGE" ),
    BaseMessages.getString( PKG, "FlattenerTargetField.TypeAggrLongDesc.MIN" ),
    BaseMessages.getString( PKG, "FlattenerTargetField.TypeAggrLongDesc.MAX" ),
    BaseMessages.getString( PKG, "FlattenerTargetField.TypeAggrLongDesc.COUNT_ALL" ),
    BaseMessages.getString( PKG, "FlattenerTargetField.TypeAggrLongDesc.CONCAT_COMMA" )
  };

  /**
   * @return Returns the fieldName.
   */
  public String getFieldName() {
    return fieldName;
  }

  /**
   * @param fieldName
   *          The fieldName to set.
   */
  public void setFieldName( String fieldName ) {
    this.fieldName = fieldName;
  }

  /**
   * @return Returns the targetFormat.
   */
  public String getTargetFormat() {
    return targetFormat;
  }

  /**
   * @param targetFormat
   *          The targetFormat to set.
   */
  public void setTargetFormat( String targetFormat ) {
    this.targetFormat = targetFormat;
  }

  /**
   * Create an empty pivot target field
   */
  public FlattenerTargetField() {
  }

  /**
   * @return Returns the keyValue.
   */
  public String getKeyValue() {
    return keyValue;
  }

  /**
   * @param keyValue
   *          The keyValue to set.
   */
  public void setKeyValue( String keyValue ) {
    this.keyValue = keyValue;
  }

  /**
   * @return Returns the targetCurrencySymbol.
   */
  public String getTargetCurrencySymbol() {
    return targetCurrencySymbol;
  }

  /**
   * @param targetCurrencySymbol
   *          The targetCurrencySymbol to set.
   */
  public void setTargetCurrencySymbol( String targetCurrencySymbol ) {
    this.targetCurrencySymbol = targetCurrencySymbol;
  }

  /**
   * @return Returns the targetDecimalSymbol.
   */
  public String getTargetDecimalSymbol() {
    return targetDecimalSymbol;
  }

  /**
   * @param targetDecimalSymbol
   *          The targetDecimalSymbol to set.
   */
  public void setTargetDecimalSymbol( String targetDecimalSymbol ) {
    this.targetDecimalSymbol = targetDecimalSymbol;
  }

  /**
   * @return Returns the targetGroupingSymbol.
   */
  public String getTargetGroupingSymbol() {
    return targetGroupingSymbol;
  }

  /**
   * @param targetGroupingSymbol
   *          The targetGroupingSymbol to set.
   */
  public void setTargetGroupingSymbol( String targetGroupingSymbol ) {
    this.targetGroupingSymbol = targetGroupingSymbol;
  }

  /**
   * @return Returns the targetLength.
   */
  public int getTargetLength() {
    return targetLength;
  }

  /**
   * @param targetLength
   *          The targetLength to set.
   */
  public void setTargetLength( int targetLength ) {
    this.targetLength = targetLength;
  }

  /**
   * @return Returns the targetName.
   */
  public String getTargetName() {
    return targetName;
  }

  /**
   * @param targetName
   *          The targetName to set.
   */
  public void setTargetName( String targetName ) {
    this.targetName = targetName;
  }

  /**
   * @return Returns the targetNullString.
   */
  public String getTargetNullString() {
    return targetNullString;
  }

  /**
   * @param targetNullString
   *          The targetNullString to set.
   */
  public void setTargetNullString( String targetNullString ) {
    this.targetNullString = targetNullString;
  }

  /**
   * @return Returns the targetPrecision.
   */
  public int getTargetPrecision() {
    return targetPrecision;
  }

  /**
   * @param targetPrecision
   *          The targetPrecision to set.
   */
  public void setTargetPrecision( int targetPrecision ) {
    this.targetPrecision = targetPrecision;
  }

  /**
   * @return Returns the targetType.
   */
  public int getTargetType() {
    return targetType;
  }

  /**
   * @param targetType
   *          The targetType to set.
   */
  public void setTargetType( int targetType ) {
    this.targetType = targetType;
  }

  /**
   * @return The description of the target Value type
   */
  public String getTargetTypeDesc() {
    return ValueMetaFactory.getValueMetaName( targetType );
  }

  /**
   * Set the target type
   *
   * @param typeDesc
   *          the target value type description
   */
  public void setTargetType( String typeDesc ) {
    targetType = ValueMetaFactory.getIdForValueMeta( typeDesc );
  }

  /**
   * @return The target aggregation type: when a key-value collision occurs, what it the aggregation to use.
   */
  public int getTargetAggregationType() {
    return targetAggregationType;
  }

  /**
   * @param targetAggregationType
   *          Specify the The aggregation type: when a key-value collision occurs, what it the aggregation to use.
   */
  public void setTargetAggregationType( int targetAggregationType ) {
    this.targetAggregationType = targetAggregationType;
  }

  public static final int getAggregationType( String desc ) {
    for ( int i = 0; i < typeAggrCode.length; i++ ) {
      if ( typeAggrCode[i].equalsIgnoreCase( desc ) ) {
        return i;
      }
    }
    for ( int i = 0; i < typeAggrLongDesc.length; i++ ) {
      if ( typeAggrLongDesc[i].equalsIgnoreCase( desc ) ) {
        return i;
      }
    }
    return 0;
  }

  public static final String getAggregationTypeDesc( int i ) {
    if ( i < 0 || i >= typeAggrCode.length ) {
      return null;
    }
    return typeAggrCode[i];
  }

  public static final String getAggregationTypeDescLong( int i ) {
    if ( i < 0 || i >= typeAggrLongDesc.length ) {
      return null;
    }
    return typeAggrLongDesc[i];
  }

  public void setTargetAggregationType( String aggregationType ) {
    targetAggregationType = getAggregationType( aggregationType );
  }

  public String getTargetAggregationTypeDesc() {
    return getAggregationTypeDesc( targetAggregationType );
  }

  public String getTargetAggregationTypeDescLong() {
    return getAggregationTypeDescLong( targetAggregationType );
  }

}