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

java.lang.Object
  extended by org.pentaho.platform.engine.core.system.PentahoBase
      extended by org.pentaho.platform.engine.services.PentahoMessenger
          extended by org.pentaho.platform.engine.services.solution.ComponentBase
              extended by org.pentaho.platform.plugin.action.kettle.KettleComponent
All Implemented Interfaces:
Serializable, org.pentaho.di.trans.step.RowListener, IAuditable, IComponent, ILogger, IParameterResolver
Direct Known Subclasses:
Custom1

public class KettleComponent
extends ComponentBase
implements org.pentaho.di.trans.step.RowListener

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

Author:
Matt
See Also:
Serialized Form

Field Summary
static String PARAMETER_MAP_CMD_ARG
           
static String PARAMETER_MAP_PARAMETER
           
static String PARAMETER_MAP_VARIABLE
           
 
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(org.pentaho.di.core.row.RowMetaInterface rowMeta, Object[] row)
           
 boolean executeAction()
          Execute the specified transformation in the chosen repository.
 org.apache.commons.logging.Log getLogger()
           
 boolean init()
          Initialize the Component.
 void processRow(org.pentaho.commons.connection.memory.MemoryResultSet memResults, org.pentaho.di.core.row.RowMetaInterface rowMeta, Object[] row)
           
 void rowReadEvent(org.pentaho.di.core.row.RowMetaInterface row, Object[] values)
           
 void rowWrittenEvent(org.pentaho.di.core.row.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, 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
 

Field Detail

PARAMETER_MAP_CMD_ARG

public static final String PARAMETER_MAP_CMD_ARG
See Also:
Constant Field Values

PARAMETER_MAP_VARIABLE

public static final String PARAMETER_MAP_VARIABLE
See Also:
Constant Field Values

PARAMETER_MAP_PARAMETER

public static final String PARAMETER_MAP_PARAMETER
See Also:
Constant Field Values
Constructor Detail

KettleComponent

public KettleComponent()
Method Detail

getLogger

public org.apache.commons.logging.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(org.pentaho.di.core.row.RowMetaInterface row,
                         Object[] values)
Specified by:
rowReadEvent in interface org.pentaho.di.trans.step.RowListener

rowWrittenEvent

public void rowWrittenEvent(org.pentaho.di.core.row.RowMetaInterface rowMeta,
                            Object[] row)
                     throws org.pentaho.di.core.exception.KettleStepException
Specified by:
rowWrittenEvent in interface org.pentaho.di.trans.step.RowListener
Throws:
org.pentaho.di.core.exception.KettleStepException

errorRowWrittenEvent

public void errorRowWrittenEvent(org.pentaho.di.core.row.RowMetaInterface rowMeta,
                                 Object[] row)
                          throws org.pentaho.di.core.exception.KettleStepException
Specified by:
errorRowWrittenEvent in interface org.pentaho.di.trans.step.RowListener
Throws:
org.pentaho.di.core.exception.KettleStepException

processRow

public void processRow(org.pentaho.commons.connection.memory.MemoryResultSet memResults,
                       org.pentaho.di.core.row.RowMetaInterface rowMeta,
                       Object[] row)
                throws org.pentaho.di.core.exception.KettleStepException
Throws:
org.pentaho.di.core.exception.KettleStepException