FieldsChangeSequence.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.fieldschangesequence;

import org.pentaho.di.core.Const;
import org.pentaho.di.core.exception.KettleException;
import org.pentaho.di.core.row.RowDataUtil;
import org.pentaho.di.core.row.ValueMetaInterface;
import org.pentaho.di.i18n.BaseMessages;
import org.pentaho.di.trans.Trans;
import org.pentaho.di.trans.TransMeta;
import org.pentaho.di.trans.step.BaseStep;
import org.pentaho.di.trans.step.StepDataInterface;
import org.pentaho.di.trans.step.StepInterface;
import org.pentaho.di.trans.step.StepMeta;
import org.pentaho.di.trans.step.StepMetaInterface;

/**
 * Add sequence to each input row.
 *
 * @author Samatar
 * @since 30-06-2008
 */

public class FieldsChangeSequence extends BaseStep implements StepInterface {
  private static Class<?> PKG = FieldsChangeSequenceMeta.class; // for i18n purposes, needed by Translator2!!

  private FieldsChangeSequenceMeta meta;
  private FieldsChangeSequenceData data;

  public FieldsChangeSequence( StepMeta stepMeta, StepDataInterface stepDataInterface, int copyNr,
    TransMeta transMeta, Trans trans ) {
    super( stepMeta, stepDataInterface, copyNr, transMeta, trans );
  }

  @Override
  public boolean processRow( StepMetaInterface smi, StepDataInterface sdi ) throws KettleException {
    meta = (FieldsChangeSequenceMeta) smi;
    data = (FieldsChangeSequenceData) sdi;

    Object[] r = getRow(); // get row, set busy!
    if ( r == null ) { // no more input to be expected...

      setOutputDone();
      return false;
    }

    if ( first ) {
      // get the RowMeta
      data.previousMeta = getInputRowMeta().clone();
      data.nextIndexField = data.previousMeta.size();
      data.outputRowMeta = getInputRowMeta().clone();
      meta.getFields( data.outputRowMeta, getStepname(), null, null, this, repository, metaStore );

      if ( meta.getFieldName() == null || meta.getFieldName().length > 0 ) {
        data.fieldnr = meta.getFieldName().length;
        data.fieldnrs = new int[data.fieldnr];
        data.previousValues = new Object[data.fieldnr];
        data.fieldnrsMeta = new ValueMetaInterface[data.fieldnr];
        for ( int i = 0; i < data.fieldnr; i++ ) {
          data.fieldnrs[i] = data.previousMeta.indexOfValue( meta.getFieldName()[i] );
          if ( data.fieldnrs[i] < 0 ) {
            logError( BaseMessages.getString(
              PKG, "FieldsChangeSequence.Log.CanNotFindField", meta.getFieldName()[i] ) );
            throw new KettleException( BaseMessages.getString(
              PKG, "FieldsChangeSequence.Log.CanNotFindField", meta.getFieldName()[i] ) );
          }
          data.fieldnrsMeta[i] = data.previousMeta.getValueMeta( data.fieldnrs[i] );
        }
      } else {
        data.fieldnr = data.previousMeta.size();
        data.fieldnrs = new int[data.fieldnr];
        data.previousValues = new Object[data.fieldnr];
        data.fieldnrsMeta = new ValueMetaInterface[data.fieldnr];
        for ( int i = 0; i < data.previousMeta.size(); i++ ) {
          data.fieldnrs[i] = i;
          data.fieldnrsMeta[i] = data.previousMeta.getValueMeta( i );
        }
      }

      data.startAt = Const.toInt( environmentSubstitute( meta.getStart() ), 1 );
      data.incrementBy = Const.toInt( environmentSubstitute( meta.getIncrement() ), 1 );
      data.seq = data.startAt;
    } // end if first

    try {
      boolean change = false;

      // Loop through fields
      for ( int i = 0; i < data.fieldnr; i++ ) {
        if ( !first ) {
          if ( data.fieldnrsMeta[i].compare( data.previousValues[i], r[data.fieldnrs[i]] ) != 0 ) {
            change = true;
          }
        }
        data.previousValues[i] = r[data.fieldnrs[i]];
      }
      if ( first ) {
        first = false;
      }

      if ( change ) {
        data.seq = data.startAt;
      }

      if ( log.isRowLevel() ) {
        logRowlevel( BaseMessages.getString( PKG, "FieldsChangeSequence.Log.ReadRow" )
          + getLinesRead() + " : " + getInputRowMeta().getString( r ) );
      }

      // reserve room and add value!
      Object[] outputRowData = RowDataUtil.addValueData( r, data.nextIndexField, data.seq );

      putRow( data.outputRowMeta, outputRowData ); // copy row to possible alternate rowset(s).

      data.seq += data.incrementBy;

      if ( log.isRowLevel() ) {
        logRowlevel( BaseMessages.getString( PKG, "FieldsChangeSequence.Log.WriteRow" )
          + getLinesWritten() + " : " + getInputRowMeta().getString( r ) );
      }

      if ( checkFeedback( getLinesRead() ) ) {
        if ( log.isBasic() ) {
          logBasic( BaseMessages.getString( PKG, "FieldsChangeSequence.Log.LineNumber" ) + getLinesRead() );
        }
      }

    } catch ( Exception e ) {
      boolean sendToErrorRow = false;
      String errorMessage = null;
      if ( getStepMeta().isDoingErrorHandling() ) {
        sendToErrorRow = true;
        errorMessage = e.toString();
      } else {
        logError( BaseMessages.getString( PKG, "FieldsChangeSequence.ErrorInStepRunning" ) + e.getMessage() );
        logError( Const.getStackTracker( e ) );
        setErrors( 1 );
        stopAll();
        setOutputDone(); // signal end to receiver(s)
        return false;
      }
      if ( sendToErrorRow ) {
        // Simply add this row to the error row
        putError( getInputRowMeta(), r, 1, errorMessage, meta.getResultFieldName(), "FieldsChangeSequence001" );
      }
    }
    return true;
  }

  @Override
  public boolean init( StepMetaInterface smi, StepDataInterface sdi ) {
    meta = (FieldsChangeSequenceMeta) smi;
    data = (FieldsChangeSequenceData) sdi;

    if ( super.init( smi, sdi ) ) {
      // Add init code here.
      return true;
    }
    return false;
  }

  @Override
  public void dispose( StepMetaInterface smi, StepDataInterface sdi ) {
    meta = (FieldsChangeSequenceMeta) smi;
    data = (FieldsChangeSequenceData) sdi;

    data.previousValues = null;
    data.fieldnrs = null;
    super.dispose( smi, sdi );
  }
}