org.pentaho.di.trans.steps.delay.DelayMeta Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kettle-engine Show documentation
Show all versions of kettle-engine Show documentation
Container pom for Pentaho Data Integration modules
The newest version!
/*! ******************************************************************************
*
* Pentaho Data Integration
*
* Copyright (C) 2002-2017 by Hitachi Vantara : 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.delay;
import java.util.List;
import org.pentaho.di.core.CheckResult;
import org.pentaho.di.core.CheckResultInterface;
import org.pentaho.di.core.database.DatabaseMeta;
import org.pentaho.di.core.exception.KettleException;
import org.pentaho.di.core.exception.KettleStepException;
import org.pentaho.di.core.exception.KettleXMLException;
import org.pentaho.di.core.row.RowMetaInterface;
import org.pentaho.di.core.util.Utils;
import org.pentaho.di.core.variables.VariableSpace;
import org.pentaho.di.core.xml.XMLHandler;
import org.pentaho.di.i18n.BaseMessages;
import org.pentaho.di.repository.ObjectId;
import org.pentaho.di.repository.Repository;
import org.pentaho.di.trans.Trans;
import org.pentaho.di.trans.TransMeta;
import org.pentaho.di.trans.step.BaseStepMeta;
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;
import org.pentaho.metastore.api.IMetaStore;
import org.w3c.dom.Node;
/*
* Created on 27-06-2008
*
*/
public class DelayMeta extends BaseStepMeta implements StepMetaInterface {
private static Class PKG = DelayMeta.class; // for i18n purposes, needed by Translator2!!
private String timeout;
private String scaletime;
public static String DEFAULT_SCALE_TIME = "seconds";
// before 3.1.1 it was "millisecond","second","minute","hour"-->
// keep compatibility see PDI-1850, PDI-1532
public String[] ScaleTimeCode = { "milliseconds", "seconds", "minutes", "hours" };
public DelayMeta() {
super(); // allocate BaseStepMeta
}
public String getXML() {
StringBuilder retval = new StringBuilder();
retval.append( " " + XMLHandler.addTagValue( "timeout", timeout ) );
retval.append( " " + XMLHandler.addTagValue( "scaletime", scaletime ) );
return retval.toString();
}
public void loadXML( Node stepnode, List databases, IMetaStore metaStore ) throws KettleXMLException {
readData( stepnode );
}
public Object clone() {
Object retval = super.clone();
return retval;
}
public String getScaleTime() {
return scaletime;
}
public void setScaleTimeCode( int ScaleTimeIndex ) {
switch ( ScaleTimeIndex ) {
case 0:
scaletime = ScaleTimeCode[0]; // milliseconds
break;
case 1:
scaletime = ScaleTimeCode[1]; // second
break;
case 2:
scaletime = ScaleTimeCode[2]; // minutes
break;
case 3:
scaletime = ScaleTimeCode[3]; // hours
break;
default:
scaletime = ScaleTimeCode[1]; // seconds
break;
}
}
public int getScaleTimeCode() {
int retval = 1; // DEFAULT: seconds
if ( scaletime == null ) {
return retval;
}
if ( scaletime.equals( ScaleTimeCode[0] ) ) {
retval = 0;
} else if ( scaletime.equals( ScaleTimeCode[1] ) ) {
retval = 1;
} else if ( scaletime.equals( ScaleTimeCode[2] ) ) {
retval = 2;
} else if ( scaletime.equals( ScaleTimeCode[3] ) ) {
retval = 3;
}
return retval;
}
private void readData( Node stepnode ) throws KettleXMLException {
try {
timeout = XMLHandler.getTagValue( stepnode, "timeout" );
scaletime = XMLHandler.getTagValue( stepnode, "scaletime" );
// set all unknown values to seconds
setScaleTimeCode( getScaleTimeCode() ); // compatibility reasons for transformations before 3.1.1, see PDI-1850,
// PDI-1532
} catch ( Exception e ) {
throw new KettleXMLException( BaseMessages.getString( PKG, "DelayMeta.Exception.UnableToReadStepInfo" ), e );
}
}
public void setDefault() {
timeout = "1"; // default one second
scaletime = DEFAULT_SCALE_TIME; // defaults to "seconds"
}
public String getTimeOut() {
return timeout;
}
public void setTimeOut( String timeout ) {
this.timeout = timeout;
}
public void readRep( Repository rep, IMetaStore metaStore, ObjectId id_step, List databases ) throws KettleException {
try {
timeout = rep.getStepAttributeString( id_step, "timeout" );
scaletime = rep.getStepAttributeString( id_step, "scaletime" );
// set all unknown values to seconds
setScaleTimeCode( getScaleTimeCode() ); // compatibility reasons for transformations before 3.1.1, see PDI-1850,
// PDI-1532
} catch ( Exception e ) {
throw new KettleException( BaseMessages
.getString( PKG, "DelayMeta.Exception.UnexpectedErrorReadingStepInfo" ), e );
}
}
public void saveRep( Repository rep, IMetaStore metaStore, ObjectId id_transformation, ObjectId id_step ) throws KettleException {
try {
rep.saveStepAttribute( id_transformation, id_step, "timeout", timeout );
rep.saveStepAttribute( id_transformation, id_step, "scaletime", scaletime );
} catch ( Exception e ) {
throw new KettleException(
BaseMessages.getString( PKG, "DelayMeta.Exception.UnexpectedErrorSavingStepInfo" ), e );
}
}
public void getFields( RowMetaInterface rowMeta, String origin, RowMetaInterface[] info, StepMeta nextStep,
VariableSpace space, Repository repository, IMetaStore metaStore ) throws KettleStepException {
}
public void check( List remarks, TransMeta transMeta, StepMeta stepMeta,
RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info, VariableSpace space,
Repository repository, IMetaStore metaStore ) {
CheckResult cr;
String error_message = "";
if ( Utils.isEmpty( timeout ) ) {
error_message = BaseMessages.getString( PKG, "DelayMeta.CheckResult.TimeOutMissing" );
cr = new CheckResult( CheckResultInterface.TYPE_RESULT_ERROR, error_message, stepMeta );
} else {
error_message = BaseMessages.getString( PKG, "DelayMeta.CheckResult.TimeOutOk" );
cr = new CheckResult( CheckResultInterface.TYPE_RESULT_OK, error_message, stepMeta );
}
remarks.add( cr );
if ( prev == null || prev.size() == 0 ) {
cr =
new CheckResult( CheckResultInterface.TYPE_RESULT_WARNING, BaseMessages.getString(
PKG, "DelayMeta.CheckResult.NotReceivingFields" ), stepMeta );
} else {
cr =
new CheckResult( CheckResultInterface.TYPE_RESULT_OK, BaseMessages.getString(
PKG, "DelayMeta.CheckResult.StepRecevingData", prev.size() + "" ), stepMeta );
}
remarks.add( cr );
// See if we have input streams leading to this step!
if ( input.length > 0 ) {
cr =
new CheckResult( CheckResultInterface.TYPE_RESULT_OK, BaseMessages.getString(
PKG, "DelayMeta.CheckResult.StepRecevingData2" ), stepMeta );
} else {
cr =
new CheckResult( CheckResultInterface.TYPE_RESULT_ERROR, BaseMessages.getString(
PKG, "DelayMeta.CheckResult.NoInputReceivedFromOtherSteps" ), stepMeta );
}
remarks.add( cr );
}
public StepInterface getStep( StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr,
Trans trans ) {
return new Delay( stepMeta, stepDataInterface, cnr, tr, trans );
}
public StepDataInterface getStepData() {
return new DelayData();
}
}