org.pentaho.di.trans.steps.userdefinedjavaclass
Class TransformClassBase

java.lang.Object
  org.pentaho.di.trans.steps.userdefinedjavaclass.TransformClassBase

public abstract class TransformClassBase
extends Object

Nested Class Summary

static class

TransformClassBase.Fields

Constructor Summary

TransformClassBase(UserDefinedJavaClass parent, UserDefinedJavaClassMeta meta, UserDefinedJavaClassData data)

Method Summary

void	addResultFile(ResultFile resultFile)
void	addRowListener(RowListener rowListener)
void	addStepListener(StepListener stepListener)
boolean	checkFeedback(long lines)
void	cleanup()
Object[]	createOutputRow(Object[] inputRow, int outputRowSize)
long	decrementLinesRead()
long	decrementLinesWritten()
void	dispose(StepMetaInterface smi, StepDataInterface sdi)
RowSet	findInfoRowSet(String tag)
RowSet	findInputRowSet(String sourceStep)
RowSet	findInputRowSet(String from, int fromcopy, String to, int tocopy)
RowSet	findOutputRowSet(String targetStep)
RowSet	findOutputRowSet(String from, int fromcopy, String to, int tocopy)
RowSet	findTargetRowSet(String tag)
FieldHelper	get(TransformClassBase.Fields type, String name)
int	getClusterSize()
int	getCopy()
RowMetaInterface	getErrorRowMeta()
long	getErrors()
static void	getFields(boolean clearResultFields, RowMetaInterface row, String originStepname, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space, List<?> fields)
static String[]	getInfoSteps()
RowMetaInterface	getInputRowMeta()
List<RowSet>	getInputRowSets()
long	getLinesInput()
long	getLinesOutput()
long	getLinesRead()
long	getLinesRejected()
long	getLinesSkipped()
long	getLinesUpdated()
long	getLinesWritten()
List<RowSet>	getOutputRowSets()
String	getParameter(String tag)
String	getPartitionID()
Map<String,BlockingRowSet>	getPartitionTargets()
long	getProcessed()
int	getRepartitioning()
Map<String,ResultFile>	getResultFiles()
Object[]	getRow()
Object[]	getRowFrom(RowSet rowSet)
List<RowListener>	getRowListeners()
long	getRuntime()
int	getSlaveNr()
SocketRepository	getSocketRepository()
BaseStepData.StepExecutionStatus	getStatus()
String	getStatusDescription()
StepDataInterface	getStepDataInterface()
String	getStepID()
static StepIOMetaInterface	getStepIOMeta(UserDefinedJavaClassMeta meta)
List<StepListener>	getStepListeners()
StepMeta	getStepMeta()
String	getStepname()
Trans	getTrans()
TransMeta	getTransMeta()
String	getTypeId()
int	getUniqueStepCountAcrossSlaves()
int	getUniqueStepNrAcrossSlaves()
String	getVariable(String variableName)
String	getVariable(String variableName, String defaultValue)
long	incrementLinesInput()
long	incrementLinesOutput()
long	incrementLinesRead()
long	incrementLinesRejected()
long	incrementLinesSkipped()
long	incrementLinesUpdated()
long	incrementLinesWritten()
boolean	init(StepMetaInterface stepMetaInterface, StepDataInterface stepDataInterface)
void	initBeforeStart()
boolean	isDistributed()
boolean	isInitialising()
boolean	isPartitioned()
boolean	isSafeModeEnabled()
boolean	isStopped()
boolean	isUsingThreadPriorityManagment()
void	logBasic(String s)
void	logDebug(String s)
void	logDetailed(String s)
void	logError(String s)
void	logError(String s, Throwable e)
void	logMinimal(String s)
void	logRowlevel(String s)
void	logSummary()
void	markStart()
void	markStop()
void	openRemoteInputStepSocketsOnce()
void	openRemoteOutputStepSocketsOnce()
boolean	outputIsDone()
abstract boolean	processRow(StepMetaInterface smi, StepDataInterface sdi)
void	putError(RowMetaInterface rowMeta, Object[] row, long nrErrors, String errorDescriptions, String fieldNames, String errorCodes)
void	putRow(RowMetaInterface row, Object[] data)
void	putRowTo(RowMetaInterface rowMeta, Object[] row, RowSet rowSet)
void	removeRowListener(RowListener rowListener)
int	rowsetInputSize()
int	rowsetOutputSize()
void	safeModeChecking(RowMetaInterface row)
void	setErrors(long errors)
void	setInputRowMeta(RowMetaInterface rowMeta)
void	setInputRowSets(List<RowSet> inputRowSets)
void	setLinesInput(long newLinesInputValue)
void	setLinesOutput(long newLinesOutputValue)
void	setLinesRead(long newLinesReadValue)
void	setLinesRejected(long linesRejected)
void	setLinesSkipped(long newLinesSkippedValue)
void	setLinesUpdated(long newLinesUpdatedValue)
void	setLinesWritten(long newLinesWrittenValue)
void	setOutputDone()
void	setOutputRowSets(List<RowSet> outputRowSets)
void	setStepListeners(List<StepListener> stepListeners)
void	setVariable(String variableName, String variableValue)
void	stopAll()
void	stopRunning(StepMetaInterface stepMetaInterface, StepDataInterface stepDataInterface)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformClassBase

public TransformClassBase(UserDefinedJavaClass parent,
                          UserDefinedJavaClassMeta meta,
                          UserDefinedJavaClassData data)
                   throws KettleStepException

Throws:

KettleStepException

Method Detail

addResultFile

public void addResultFile(ResultFile resultFile)

addRowListener

public void addRowListener(RowListener rowListener)

addStepListener

public void addStepListener(StepListener stepListener)

checkFeedback

public boolean checkFeedback(long lines)

cleanup

public void cleanup()

decrementLinesRead

public long decrementLinesRead()

decrementLinesWritten

public long decrementLinesWritten()

dispose

public void dispose(StepMetaInterface smi,
                    StepDataInterface sdi)

findInputRowSet

public RowSet findInputRowSet(String sourceStep)
                       throws KettleStepException

Throws:

KettleStepException

findInputRowSet

public RowSet findInputRowSet(String from,
                              int fromcopy,
                              String to,
                              int tocopy)

findOutputRowSet

public RowSet findOutputRowSet(String targetStep)
                        throws KettleStepException

Throws:

KettleStepException

findOutputRowSet

public RowSet findOutputRowSet(String from,
                               int fromcopy,
                               String to,
                               int tocopy)

getClusterSize

public int getClusterSize()

getCopy

public int getCopy()

getErrorRowMeta

public RowMetaInterface getErrorRowMeta()

getErrors

public long getErrors()

getInputRowMeta

public RowMetaInterface getInputRowMeta()

getInputRowSets

public List<RowSet> getInputRowSets()

getLinesInput

public long getLinesInput()

getLinesOutput

public long getLinesOutput()

getLinesRead

public long getLinesRead()

getLinesRejected

public long getLinesRejected()

getLinesSkipped

public long getLinesSkipped()

getLinesUpdated

public long getLinesUpdated()

getLinesWritten

public long getLinesWritten()

getOutputRowSets

public List<RowSet> getOutputRowSets()

getPartitionID

public String getPartitionID()

getPartitionTargets

public Map<String,BlockingRowSet> getPartitionTargets()

getProcessed

public long getProcessed()

getRepartitioning

public int getRepartitioning()

getResultFiles

public Map<String,ResultFile> getResultFiles()

getRow

public Object[] getRow()
                throws KettleException

Throws:

KettleException

getRowFrom

public Object[] getRowFrom(RowSet rowSet)
                    throws KettleStepException

Throws:

KettleStepException

getRowListeners

public List<RowListener> getRowListeners()

getRuntime

public long getRuntime()

getSlaveNr

public int getSlaveNr()

getSocketRepository

public SocketRepository getSocketRepository()

getStatus

public BaseStepData.StepExecutionStatus getStatus()

getStatusDescription

public String getStatusDescription()

getStepDataInterface

public StepDataInterface getStepDataInterface()

getStepID

public String getStepID()

getStepListeners

public List<StepListener> getStepListeners()

getStepMeta

public StepMeta getStepMeta()

getStepname

public String getStepname()

getTrans

public Trans getTrans()

getTransMeta

public TransMeta getTransMeta()

getTypeId

public String getTypeId()

getUniqueStepCountAcrossSlaves

public int getUniqueStepCountAcrossSlaves()

getUniqueStepNrAcrossSlaves

public int getUniqueStepNrAcrossSlaves()

getVariable

public String getVariable(String variableName)

getVariable

public String getVariable(String variableName,
                          String defaultValue)

incrementLinesInput

public long incrementLinesInput()

incrementLinesOutput

public long incrementLinesOutput()

incrementLinesRead

public long incrementLinesRead()

incrementLinesRejected

public long incrementLinesRejected()

incrementLinesSkipped

public long incrementLinesSkipped()

incrementLinesUpdated

public long incrementLinesUpdated()

incrementLinesWritten

public long incrementLinesWritten()

init

public boolean init(StepMetaInterface stepMetaInterface,
                    StepDataInterface stepDataInterface)

initBeforeStart

public void initBeforeStart()
                     throws KettleStepException

Throws:

KettleStepException

isDistributed

public boolean isDistributed()

isInitialising

public boolean isInitialising()

isPartitioned

public boolean isPartitioned()

isSafeModeEnabled

public boolean isSafeModeEnabled()

isStopped

public boolean isStopped()

isUsingThreadPriorityManagment

public boolean isUsingThreadPriorityManagment()

logBasic

public void logBasic(String s)

logDebug

public void logDebug(String s)

logDetailed

public void logDetailed(String s)

logError

public void logError(String s)

logError

public void logError(String s,
                     Throwable e)

logMinimal

public void logMinimal(String s)

logRowlevel

public void logRowlevel(String s)

logSummary

public void logSummary()

markStart

public void markStart()

markStop

public void markStop()

openRemoteInputStepSocketsOnce

public void openRemoteInputStepSocketsOnce()
                                    throws KettleStepException

Throws:

KettleStepException

openRemoteOutputStepSocketsOnce

public void openRemoteOutputStepSocketsOnce()
                                     throws KettleStepException

Throws:

KettleStepException

outputIsDone

public boolean outputIsDone()

processRow

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

Throws:

KettleException

putError

public void putError(RowMetaInterface rowMeta,
                     Object[] row,
                     long nrErrors,
                     String errorDescriptions,
                     String fieldNames,
                     String errorCodes)
              throws KettleStepException

Throws:

KettleStepException

putRow

public void putRow(RowMetaInterface row,
                   Object[] data)
            throws KettleStepException

Throws:

KettleStepException

putRowTo

public void putRowTo(RowMetaInterface rowMeta,
                     Object[] row,
                     RowSet rowSet)
              throws KettleStepException

Throws:

KettleStepException

removeRowListener

public void removeRowListener(RowListener rowListener)

rowsetInputSize

public int rowsetInputSize()

rowsetOutputSize

public int rowsetOutputSize()

safeModeChecking

public void safeModeChecking(RowMetaInterface row)
                      throws KettleRowException

Throws:

KettleRowException

setErrors

public void setErrors(long errors)

setInputRowMeta

public void setInputRowMeta(RowMetaInterface rowMeta)

setInputRowSets

public void setInputRowSets(List<RowSet> inputRowSets)

setLinesInput

public void setLinesInput(long newLinesInputValue)

setLinesOutput

public void setLinesOutput(long newLinesOutputValue)

setLinesRead

public void setLinesRead(long newLinesReadValue)

setLinesRejected

public void setLinesRejected(long linesRejected)

setLinesSkipped

public void setLinesSkipped(long newLinesSkippedValue)

setLinesUpdated

public void setLinesUpdated(long newLinesUpdatedValue)

setLinesWritten

public void setLinesWritten(long newLinesWrittenValue)

setOutputDone

public void setOutputDone()

setOutputRowSets

public void setOutputRowSets(List<RowSet> outputRowSets)

setStepListeners

public void setStepListeners(List<StepListener> stepListeners)

setVariable

public void setVariable(String variableName,
                        String variableValue)

stopAll

public void stopAll()

stopRunning

public void stopRunning(StepMetaInterface stepMetaInterface,
                        StepDataInterface stepDataInterface)
                 throws KettleException

Throws:

KettleException

toString

public String toString()

Overrides:

toString in class Object

getInfoSteps

public static String[] getInfoSteps()

getFields

public static void getFields(boolean clearResultFields,
                             RowMetaInterface row,
                             String originStepname,
                             RowMetaInterface[] info,
                             StepMeta nextStep,
                             VariableSpace space,
                             List<?> fields)
                      throws KettleStepException

Throws:

KettleStepException

getStepIOMeta

public static StepIOMetaInterface getStepIOMeta(UserDefinedJavaClassMeta meta)

getParameter

public String getParameter(String tag)

findInfoRowSet

public RowSet findInfoRowSet(String tag)
                      throws KettleException

Throws:

KettleException

findTargetRowSet

public RowSet findTargetRowSet(String tag)
                        throws KettleException

Throws:

KettleException

get

public FieldHelper get(TransformClassBase.Fields type,
                       String name)
                throws KettleStepException

Throws:

KettleStepException

createOutputRow

public Object[] createOutputRow(Object[] inputRow,
                                int outputRowSize)