Package org.pentaho.di.trans.step

Interface RowDistributionInterface

public interface RowDistributionInterface

Method Summary

Modifier and Type	Method	Description
void	distributeRow(org.pentaho.di.core.row.RowMetaInterface rowMeta, Object[] row, StepInterface stepInterface)	Do the actual row distribution in the step
String	getCode()
String	getDescription()
org.pentaho.di.core.gui.PrimitiveGCInterface.EImage	getDistributionImage()	Which mini-icon needs to be shown on the hop?

Method Detail

getCode

String getCode()

Returns:

The row distribution code (plugin id)

getDescription

String getDescription()

Returns:

The row distribution description (plugin description)

distributeRow

void distributeRow(org.pentaho.di.core.row.RowMetaInterface rowMeta,
                   Object[] row,
                   StepInterface stepInterface)
            throws org.pentaho.di.core.exception.KettleStepException

Do the actual row distribution in the step

Parameters:

rowMeta - the meta-data of the row to distribute

row - the data of the row data to distribute

stepInterface - The step to distribute the rows in

Throws:

org.pentaho.di.core.exception.KettleStepException

getDistributionImage

org.pentaho.di.core.gui.PrimitiveGCInterface.EImage getDistributionImage()

Which mini-icon needs to be shown on the hop?

Returns:

the available code EImage or null if the standard icon needs to be used.