org.pentaho.platform.plugin.action.kettle
Class KettleComponent

java.lang.Object
  org.pentaho.platform.engine.core.system.PentahoBase
      org.pentaho.platform.engine.services.PentahoMessenger
          org.pentaho.platform.engine.services.solution.ComponentBase
              org.pentaho.platform.plugin.action.kettle.KettleComponent

All Implemented Interfaces:

Serializable, IAuditable, IComponent, ILogger, IParameterResolver

Direct Known Subclasses:

Custom1

public class KettleComponent
extends ComponentBase

KettleComponent shows a list of available transformations in the root of the choosen repository.

Author:

Matt Legitimate outputs: EXECUTION_STATUS_OUTPUT - (execution-status) [JOB | TRANS] Returns the resultant execution status EXECUTION_LOG_OUTPUT - (execution-log) [JOB | TRANS] Returns the resultant log TRANSFORM_SUCCESS_OUTPUT - (transformation-written) [Requires MONITORSTEP to be defined] [TRANS] Returns a "result-set" for all successful rows written (Unless error handling is not defined for the specified step, in which case ALL rows are returned here) TRANSFORM_ERROR_OUTPUT - (transformation-errors) [Requires MONITORSTEP to be defined] [TRANS] Returns a "result-set" for all rows written that have caused an error TRANSFORM_SUCCESS_COUNT_OUTPUT - (transformation-written-count) [Requires MONITORSTEP to be defined] [TRANS] Returns a count of all rows returned in TRANSFORM_SUCCESS_OUTPUT TRANSFORM_ERROR_COUNT_OUTPUT - (transformation-errors-count) [Requires MONITORSTEP to be defined] [TRANS] Returns a count of all rows returned in TRANSFORM_ERROR_OUTPUT Legitimate inputs: MONITORSTEP Takes the name of the step from which success and error rows can be detected KETTLELOGLEVEL Sets the logging level to be used in the EXECUTION_LOG_OUTPUT Valid settings: basic detail error debug minimal rowlevel

See Also:

Serialized Form

Field Summary

Fields inherited from class org.pentaho.platform.engine.services.solution.ComponentBase

COMPONENT_EXECUTE_FAIL, MISSING_SESSION

Fields inherited from class org.pentaho.platform.engine.core.system.PentahoBase

EMPTYLOGID, LOGID_MASK1, LOGID_MASK2, LOGID_SEPARATOR

Fields inherited from interface org.pentaho.platform.api.engine.ILogger

ACTIVITY_LOG, DEBUG, ERROR, FATAL, INFO, INSTANCE_LOG, SESSION_LOG, SOLUTION_LOG, TRACE, UNKNOWN, WARN

Constructor Summary

KettleComponent()

Method Summary

void	done() Allows the component to perform any cleanup after the execution of the action.
void	errorRowWrittenEvent(RowMetaInterface rowMeta, Object[] row)
boolean	executeAction() Execute the specified transformation in the chosen repository.
Log	getLogger()
boolean	init() Initialize the Component.
void	processRow(MemoryResultSet memResults, RowMetaInterface rowMeta, Object[] row)
void	rowReadEvent(RowMetaInterface row, Object[] values)
void	rowWrittenEvent(RowMetaInterface rowMeta, Object[] row)
boolean	validateAction()

Methods inherited from class org.pentaho.platform.engine.services.solution.ComponentBase

createFeedbackParameter, createFeedbackParameter, createNewInstance, execute, getActionDefinition, getActionName, getActionTitle, getComponentDefinition, getComponentDefinition, getId, getInitFailMessage, getInitOk, getInstanceId, getLogId, getObjectName, getProcessId, getResourceAsString, getRuntimeContext, getSession, inputMissingError, outputMissingError, promptNeeded, promptNow, resolveParameter, resourceComponentSettingError, resourceMissingError, setActionDefinition, setActionName, setComponentDefinition, setComponentDefinitionMap, setInstanceId, setProcessId, setRuntimeContext, setSession, validate

Methods inherited from class org.pentaho.platform.engine.services.PentahoMessenger

debug, debug, error, error, fatal, fatal, getMessages, getUserString, info, info, setMessages, trace, trace, warn, warn

Methods inherited from class org.pentaho.platform.engine.core.system.PentahoBase

genLogIdFromInfo, genLogIdFromInfo, genLogIdFromSession, getLoggingLevel, setLoggingLevel, setLogId

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pentaho.platform.api.engine.IComponent

getMessages, setMessages

Methods inherited from interface org.pentaho.platform.api.engine.ILogger

debug, debug, error, error, fatal, fatal, getLoggingLevel, info, info, setLoggingLevel, trace, trace, warn, warn

Constructor Detail

KettleComponent

public KettleComponent()

Method Detail

getLogger

public Log getLogger()

Specified by:

getLogger in class PentahoBase

init

public boolean init()

Description copied from interface: IComponent

Initialize the Component. This method is typically called on construction.

Specified by:

init in interface IComponent

Specified by:

init in class ComponentBase

Returns:

returns true if the Component initialized successfully, otherwise returns false

validateAction

public boolean validateAction()

executeAction

public boolean executeAction()

Execute the specified transformation in the chosen repository.

done

public void done()

Description copied from interface: IComponent

Allows the component to perform any cleanup after the execution of the action.

Specified by:

done in interface IComponent

Specified by:

done in class ComponentBase

rowReadEvent

public void rowReadEvent(RowMetaInterface row,
                         Object[] values)

rowWrittenEvent

public void rowWrittenEvent(RowMetaInterface rowMeta,
                            Object[] row)
                     throws KettleStepException

Throws:

KettleStepException

errorRowWrittenEvent

public void errorRowWrittenEvent(RowMetaInterface rowMeta,
                                 Object[] row)
                          throws KettleStepException

Throws:

KettleStepException

processRow

public void processRow(MemoryResultSet memResults,
                       RowMetaInterface rowMeta,
                       Object[] row)
                throws KettleStepException

Throws:

KettleStepException