org.pentaho.di.trans.ael.adapters

Class TransEngineAdapter

java.lang.Object

org.pentaho.di.trans.Trans

org.pentaho.di.trans.ael.adapters.TransEngineAdapter

All Implemented Interfaces:

ExecutorInterface, ExtensionDataInterface, HasLogChannelInterface, LoggingObjectInterface, NamedParams, VariableSpace

public class TransEngineAdapter
extends Trans

Created by nbaker on 1/24/17.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANONYMOUS_PRINCIPAL
static Map<LogLevel,org.pentaho.di.engine.api.reporting.LogLevel>	LEVEL_MAP

Fields inherited from class org.pentaho.di.trans.Trans

arguments, class_nr, CONFIGURATION_IN_EXPORT_FILENAME, containerObjectId, counters, log, logCommitSize, logLevel, metaStore, REPLAY_DATE_FORMAT, repository, resultFiles, resultRows, rowsets, STRING_FINISHED, STRING_FINISHED_WITH_ERRORS, STRING_HALTING, STRING_INITIALIZING, STRING_PAUSED, STRING_PREPARING, STRING_RUNNING, STRING_STOPPED, STRING_WAITING, transMeta, TYPE_DISP_1_1, TYPE_DISP_1_N, TYPE_DISP_N_1, TYPE_DISP_N_M, TYPE_DISP_N_N

Constructor Summary

Constructors

Constructor and Description
TransEngineAdapter(org.pentaho.di.engine.api.Engine engine, TransMeta transMeta)

Method Summary

Modifier and Type	Method and Description
RowProducer	addRowProducer(String stepname, int copynr) This adds a row producer to the transformation that just got set up.
void	killAll() Attempts to stops all running steps and subtransformations.
void	prepareExecution(String[] arguments) Prepares the transformation for execution.
void	setLogLevel(LogLevel logLogLevel) Sets the log level.
void	startThreads() Starts the threads prepared by prepareThreads().
void	stopAll() Stops all steps from running, and alerts any registered listeners.
void	waitUntilFinished() Waits until all RunThreads have finished.

Methods inherited from class org.pentaho.di.trans.Trans

activateParameters, addActiveSubTransformation, addDelegationListener, addParameterDefinition, addStepPerformanceSnapShot, addTransListener, addTransStoppedListener, beginProcessing, calculateBatchIdAndDateRange, calculateTransactionId, cleanup, cleanupCluster, cleanupSlaveServer, clearError, clearParameters, copyParametersFrom, copyVariablesFrom, createDataBase, doTopologySortOfSteps, environmentSubstitute, environmentSubstitute, eraseParameters, execute, executeClustered, executeClustered, fieldSubstitute, findBaseSteps, findDataInterface, findMappingInput, findMappingOutput, findRowSet, findRowSet, findRunThread, findStepInterface, findStepInterfaces, fireTransFinishedListeners, fireTransStartedListeners, getActiveSubjobs, getActiveSubTransformation, getActiveSubtransformations, getArguments, getBatchId, getBooleanValueOfVariable, getClusteredTransformationResult, getClusteredTransformationResult, getContainerObjectId, getCounters, getCurrentDate, getDelegationListeners, getDepDate, getEndDate, getEnded, getErrors, getExecutingServer, getExecutingUser, getExtensionDataMap, getFilename, getJobEndDate, getJobStartDate, getLastProcessed, getLogChannel, getLogChannelId, getLogDate, getLoggingHierarchy, getLogLevel, getMappingStepName, getMetaStore, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParameterDefault, getParameterDescription, getParameterValue, getParent, getParentJob, getParentTrans, getParentVariableSpace, getPassedBatchId, getPreviousResult, getRegistrationDate, getReplayDate, getRepository, getRepositoryDirectory, getResult, getResultFiles, getResultRows, getRowsets, getRunThread, getRunThread, getServletPrintWriter, getServletRequest, getServletResponse, getSocketRepository, getStartDate, getStatus, getStepDataInterface, getStepInterface, getStepPerformanceSnapShots, getSteps, getThreadName, getTransactionId, getTransListeners, getTransMeta, getTransStepExecutionStatusLookup, getTransStepIsRunningLookup, getTransStoppedListeners, getVariable, getVariable, hasHaltedSteps, hasStepStarted, initializeVariablesFrom, injectVariables, isFinished, isFinishedOrStopped, isForcingSeparateLogging, isGatheringMetrics, isInitializing, isMonitored, isPaused, isPreparing, isPreview, isReadyToStart, isRunning, isSafeModeEnabled, isStopped, listParameters, listVariables, logSummary, monitorClusteredTransformation, monitorClusteredTransformation, monitorRemoteTransformation, monitorRemoteTransformation, nrActiveSteps, nrSteps, pauseRunning, printStats, removeActiveSubTransformation, resumeRunning, sendToSlaveServer, setArguments, setBatchId, setContainerObjectId, setCounters, setDelegationListeners, setExecutingServer, setExecutingUser, setFinished, setForcingSeparateLogging, setGatheringMetrics, setInitializing, setInternalKettleVariables, setJobEndDate, setJobStartDate, setLog, setMappingStepName, setMetaStore, setMonitored, setParameterValue, setParent, setParentJob, setParentTrans, setParentVariableSpace, setPassedBatchId, setPaused, setPreparing, setPreview, setPreviousResult, setReadyToStart, setReplayDate, setRepository, setResultFiles, setResultRows, setRunning, setSafeModeEnabled, setServletPrintWriter, setServletReponse, setServletRequest, setSocketRepository, setStepPerformanceSnapShots, setSteps, setStopped, setThreadName, setTransactionId, setTransListeners, setTransMeta, setTransStoppedListeners, setVariable, shareVariablesWith, shutdownHeartbeat, startHeartbeat, toString, writeLogChannelInformation, writeMetricsInformation, writeStepLogInformation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ANONYMOUS_PRINCIPAL

public static final String ANONYMOUS_PRINCIPAL

See Also:

Constant Field Values

LEVEL_MAP

public static final Map<LogLevel,org.pentaho.di.engine.api.reporting.LogLevel> LEVEL_MAP

Constructor Detail

TransEngineAdapter

public TransEngineAdapter(org.pentaho.di.engine.api.Engine engine,
                          TransMeta transMeta)

Method Detail

setLogLevel

public void setLogLevel(LogLevel logLogLevel)

Description copied from class: Trans

Sets the log level.

Overrides:

setLogLevel in class Trans

Parameters:

logLogLevel - the new log level

killAll

public void killAll()

Description copied from class: Trans

Attempts to stops all running steps and subtransformations. If all steps have finished, the transformation is marked as Finished.

Overrides:

killAll in class Trans

stopAll

public void stopAll()

Description copied from class: Trans

Stops all steps from running, and alerts any registered listeners.

Overrides:

stopAll in class Trans

prepareExecution

public void prepareExecution(String[] arguments)
                      throws KettleException

Description copied from class: Trans

Prepares the transformation for execution. This includes setting the arguments and parameters as well as preparing and tracking the steps and hops in the transformation.

Overrides:

prepareExecution in class Trans

Parameters:

arguments - the arguments to use for this transformation

Throws:

KettleException - in case the transformation could not be prepared (initialized)

startThreads

public void startThreads()
                  throws KettleException

Description copied from class: Trans

Starts the threads prepared by prepareThreads(). Before you start the threads, you can add RowListeners to them.

Overrides:

startThreads in class Trans

Throws:

KettleException - if there is a communication error with a remote output socket.

waitUntilFinished

public void waitUntilFinished()

Description copied from class: Trans

Waits until all RunThreads have finished.

Overrides:

waitUntilFinished in class Trans

addRowProducer

public RowProducer addRowProducer(String stepname,
                                  int copynr)
                           throws KettleException

Description copied from class: Trans

This adds a row producer to the transformation that just got set up. It is preferable to run this BEFORE execute() but after prepareExecution()

Overrides:

addRowProducer in class Trans

Parameters:

stepname - The step to produce rows for

copynr - The copynr of the step to produce row for (normally 0 unless you have multiple copies running)

Returns:

the row producer

Throws:

KettleException - in case the thread/step to produce rows for could not be found.

See Also:

Trans.execute(String[]), Trans.prepareExecution(String[])