org.pentaho.di.trans.steps.tableagilemart
Class TableAgileMart

java.lang.Object
  org.pentaho.di.trans.step.BaseStep
      org.pentaho.di.trans.steps.tableoutput.TableOutput
          org.pentaho.di.trans.steps.tableagilemart.TableAgileMart

All Implemented Interfaces:

HasLogChannelInterface, LoggingObjectInterface, TableManager, VariableSpace, StepInterface

public class TableAgileMart
extends TableOutput
implements TableManager

Field Summary

Fields inherited from class org.pentaho.di.trans.step.BaseStep

first, linesInput, linesOutput, linesRead, linesRejected, linesSkipped, linesUpdated, linesWritten, terminator, terminator_rows

Constructor Summary

TableAgileMart(StepMeta stepMeta, StepDataInterface stepDataInterface, int copyNr, TransMeta transMeta, Trans trans)

Method Summary

boolean	adjustSchema() Adjust schema.
boolean	dropTable() Drops the current table.
boolean	flush() Flushes the current in-memory buffer to the storage system.
String	getMessage() Returns a human-readable message about any errors that have occurred.
boolean	init(StepMetaInterface smi, StepDataInterface sdi) Initialize and do work where other steps need to wait for...
boolean	processRow(StepMetaInterface smi, StepDataInterface sdi) Perform the equivalent of processing one row.
void	setRowLimit(long rowLimit) Sets the row limit.
void	setTableName(String tableName) Sets the table name.
boolean	truncateTable() Truncates the current table.

Methods inherited from class org.pentaho.di.trans.steps.tableoutput.TableOutput

dispose

Methods inherited from class org.pentaho.di.trans.step.BaseStep

addResultFile, addRowListener, addStepListener, batchComplete, buildLog, canProcessOneRow, cleanup, closeQuietly, copyVariablesFrom, decrementLinesRead, decrementLinesWritten, dispatch, environmentSubstitute, environmentSubstitute, findInputRowSet, findInputRowSet, findOutputRowSet, findOutputRowSet, getBooleanValueOfVariable, getClusterSize, getContainerObjectId, getCopy, getDispatcher, getErrorRowMeta, getErrors, getFilename, getInputRowMeta, getInputRowSets, getLinesInput, getLinesOutput, getLinesRead, getLinesRejected, getLinesSkipped, getLinesUpdated, getLinesWritten, getLogChannel, getLogChannelId, getLogFields, getLogLevel, getNextClassNr, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getOutputRowSets, getParent, getParentVariableSpace, getPartitionID, getPartitionTargets, getPreviewRowMeta, getProcessed, getRegistrationDate, getRemoteInputSteps, getRemoteOutputSteps, getRepartitioning, getRepositoryDirectory, getResultFiles, getRow, getRowFrom, getRowListeners, getRuntime, getServerSockets, getSlaveNr, getSocketRepository, getStatus, getStatusDescription, getStepDataInterface, getStepID, getStepListeners, getStepMeta, getStepMetaInterface, getStepname, getTrans, getTransMeta, getTypeId, getUniqueStepCountAcrossSlaves, getUniqueStepNrAcrossSlaves, getVariable, getVariable, identifyErrorOutput, incrementLinesInput, incrementLinesOutput, incrementLinesRead, incrementLinesRejected, incrementLinesSkipped, incrementLinesUpdated, incrementLinesWritten, initBeforeStart, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDistributed, isInitialising, isMapping, isPartitioned, isPaused, isRowLevel, isRunning, isStopped, isUsingThreadPriorityManagment, listVariables, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, logSummary, markStart, markStop, outputIsDone, pauseRunning, putError, putRow, putRowTo, removeRowListener, resumeRunning, rowsetInputSize, rowsetOutputSize, safeModeChecking, setCarteObjectId, setCopy, setDistributed, setErrorRowMeta, setErrors, setInputRowMeta, setInputRowSets, setInternalVariables, setLinesInput, setLinesOutput, setLinesRead, setLinesRejected, setLinesSkipped, setLinesUpdated, setLinesWritten, setLogLevel, setOutputDone, setOutputRowSets, setParentVariableSpace, setPartitioned, setPartitionID, setPartitionTargets, setPaused, setPaused, setPreviewRowMeta, setRepartitioning, setRunning, setServerSockets, setSocketRepository, setStepDataInterface, setStepListeners, setStepMeta, setStepMetaInterface, setStepname, setStopped, setTransMeta, setUsingThreadPriorityManagment, setVariable, shareVariablesWith, stopAll, stopRunning, stopRunning, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.di.trans.step.StepInterface

addRowListener, addStepListener, batchComplete, canProcessOneRow, cleanup, getCopy, getErrors, getInputRowSets, getLinesInput, getLinesOutput, getLinesRead, getLinesRejected, getLinesUpdated, getLinesWritten, getLogChannel, getOutputRowSets, getPartitionID, getProcessed, getResultFiles, getRow, getRowListeners, getRuntime, getStatus, getStepID, getStepMeta, getStepname, getTrans, identifyErrorOutput, initBeforeStart, isMapping, isPartitioned, isPaused, isRunning, isStopped, isUsingThreadPriorityManagment, markStart, markStop, pauseRunning, putRow, removeRowListener, resumeRunning, rowsetInputSize, rowsetOutputSize, setErrors, setLinesRejected, setOutputDone, setPartitioned, setPartitionID, setRepartitioning, setRunning, setStopped, setUsingThreadPriorityManagment, stopAll, stopRunning

Methods inherited from interface org.pentaho.di.core.variables.VariableSpace

copyVariablesFrom, environmentSubstitute, environmentSubstitute, getBooleanValueOfVariable, getParentVariableSpace, getVariable, getVariable, initializeVariablesFrom, injectVariables, listVariables, setParentVariableSpace, setVariable, shareVariablesWith

Constructor Detail

TableAgileMart

public TableAgileMart(StepMeta stepMeta,
                      StepDataInterface stepDataInterface,
                      int copyNr,
                      TransMeta transMeta,
                      Trans trans)

Method Detail

init

public boolean init(StepMetaInterface smi,
                    StepDataInterface sdi)

Description copied from interface: StepInterface

Initialize and do work where other steps need to wait for...

Specified by:

init in interface StepInterface

Overrides:

init in class TableOutput

Parameters:

smi - The metadata to work with

sdi - The data to initialize

adjustSchema

public boolean adjustSchema()

Description copied from interface: TableManager

Adjust schema. This is used to change the schema when the input fields change.

Specified by:

adjustSchema in interface TableManager

Returns:

true if the operation succeeded

flush

public boolean flush()

Description copied from interface: TableManager

Flushes the current in-memory buffer to the storage system. This is called during cancel operations when the current set of data is still wanted.

Specified by:

flush in interface TableManager

Returns:

true if the operation succeeded

processRow

public boolean processRow(StepMetaInterface smi,
                          StepDataInterface sdi)
                   throws KettleException

Description copied from interface: StepInterface

Perform the equivalent of processing one row. Typically this means reading a row from input (getRow()) and passing a row to output (putRow)).

Specified by:

processRow in interface StepInterface

Overrides:

processRow in class TableOutput

Parameters:

smi - The steps metadata to work with

sdi - The steps temporary working data to work with (database connections, result sets, caches, temporary variables, etc.)

Returns:

false if no more rows can be processed or an error occurred.

Throws:

KettleException

dropTable

public boolean dropTable()

Description copied from interface: TableManager

Drops the current table. This is used during management operations.

Specified by:

dropTable in interface TableManager

Returns:

true if the operation succeeded

getMessage

public String getMessage()

Description copied from interface: TableManager

Returns a human-readable message about any errors that have occurred. If any of the operations (dropTable, flush, truncateTable) fail, this method should return a nice, accurate message describing the problem that was encountered.

Specified by:

getMessage in interface TableManager

Returns:

setRowLimit

public void setRowLimit(long rowLimit)

Description copied from interface: TableManager

Sets the row limit. This is used to limit the data loaded during a specific execution. This value might change every time the transformation is executed.

Specified by:

setRowLimit in interface TableManager

setTableName

public void setTableName(String tableName)

Description copied from interface: TableManager

Sets the table name. If the name of the database table is determined programatically this method can be used to set the table name.

Specified by:

setTableName in interface TableManager

truncateTable

public boolean truncateTable()

Description copied from interface: TableManager

Truncates the current table. This is used during management operations.

Specified by:

truncateTable in interface TableManager

Returns:

true if the operation succeeded