Package org.apache.hop.execution.sampler.plugins.first

Class FirstRowsExecutionDataSampler

java.lang.Object

org.apache.hop.execution.sampler.plugins.ExecutionDataSamplerBase<FirstRowsExecutionDataSamplerStore>

org.apache.hop.execution.sampler.plugins.first.FirstRowsExecutionDataSampler

All Implemented Interfaces:

Cloneable, IExecutionDataSampler<FirstRowsExecutionDataSamplerStore>

@GuiPlugin
@ExecutionDataSamplerPlugin(id="FirstRowsExecutionDataSampler",
                            name="First output rows",
                            description="Samples the first rows of a transform output")
public class FirstRowsExecutionDataSampler
extends ExecutionDataSamplerBase<FirstRowsExecutionDataSamplerStore>
implements IExecutionDataSampler<FirstRowsExecutionDataSamplerStore>

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hop.execution.sampler.IExecutionDataSampler

IExecutionDataSampler.ExecutionDataSamplerObjectFactory

Field Summary

Fields inherited from class org.apache.hop.execution.sampler.plugins.ExecutionDataSamplerBase

pluginId, pluginName, sampleSize

Constructor Summary

Constructors

Constructor	Description
FirstRowsExecutionDataSampler()
FirstRowsExecutionDataSampler(String sampleSize)
FirstRowsExecutionDataSampler(FirstRowsExecutionDataSampler sampler)

Method Summary

Modifier and Type	Method	Description
FirstRowsExecutionDataSampler	clone()
FirstRowsExecutionDataSamplerStore	createSamplerStore(ExecutionDataSamplerMeta samplerMeta)	Create a sampler store to match the sampler.
void	sampleRow(FirstRowsExecutionDataSamplerStore samplerStore, IStream.StreamType streamType, IRowMeta rowMeta, Object[] row)	Sample one row in a stream or rows.

Methods inherited from class org.apache.hop.execution.sampler.plugins.ExecutionDataSamplerBase

equals, getPluginId, getPluginName, getSampleSize, hashCode, setPluginId, setPluginName, setSampleSize

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hop.execution.sampler.IExecutionDataSampler

getPluginId, getPluginName, setPluginId, setPluginName

Constructor Detail

FirstRowsExecutionDataSampler

public FirstRowsExecutionDataSampler()

FirstRowsExecutionDataSampler

public FirstRowsExecutionDataSampler(FirstRowsExecutionDataSampler sampler)

FirstRowsExecutionDataSampler

public FirstRowsExecutionDataSampler(String sampleSize)

Method Detail

clone

public FirstRowsExecutionDataSampler clone()

Specified by:

clone in interface IExecutionDataSampler<FirstRowsExecutionDataSamplerStore>

Specified by:

clone in class ExecutionDataSamplerBase<FirstRowsExecutionDataSamplerStore>

createSamplerStore

public FirstRowsExecutionDataSamplerStore createSamplerStore(ExecutionDataSamplerMeta samplerMeta)

Description copied from interface: IExecutionDataSampler

Create a sampler store to match the sampler. It will allow you to store your intermediate sampler results.

Specified by:

createSamplerStore in interface IExecutionDataSampler<FirstRowsExecutionDataSamplerStore>

Specified by:

createSamplerStore in class ExecutionDataSamplerBase<FirstRowsExecutionDataSamplerStore>

Parameters:

samplerMeta - Metadata about the transform we're sampling for.

Returns:

A new sampler store instance.

sampleRow

public void sampleRow(FirstRowsExecutionDataSamplerStore samplerStore,
                      IStream.StreamType streamType,
                      IRowMeta rowMeta,
                      Object[] row)

Description copied from interface: IExecutionDataSampler

Sample one row in a stream or rows. It's up to the plugin to know what to do with it.

Specified by:

sampleRow in interface IExecutionDataSampler<FirstRowsExecutionDataSamplerStore>

Parameters:

samplerStore - A place to store the samples and intermediate results

streamType - The type of stream we're sampling from. (INPUT, OUTPUT, READ, WRITTEN, ...)

rowMeta - The row metadata

row - The row data itself