io.cdap.cdap.etl.api

Class SplitterTransform<T,E>

java.lang.Object

io.cdap.cdap.etl.api.SplitterTransform<T,E>

Type Parameters:

T - type of input record

E - type of error records emitted. Usually the same as the input record type

All Implemented Interfaces:

Destroyable, MultiOutputPipelineConfigurable, MultiOutputTransformation<T,E>, StageLifecycle<TransformContext>, SubmitterLifecycle<StageSubmitterContext>

public abstract class SplitterTransform<T,E>
extends Object
implements MultiOutputTransformation<T,E>, MultiOutputPipelineConfigurable, StageLifecycle<TransformContext>, SubmitterLifecycle<StageSubmitterContext>

A Transform that can split its input among multiple output ports.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_TYPE

Constructor Summary

Constructors

Constructor and Description
SplitterTransform()

Method Summary

Modifier and Type	Method and Description
void	configurePipeline(MultiOutputPipelineConfigurer multiOutputPipelineConfigurer) Configure a pipeline, adding datasets and streams that the stage needs.
void	destroy() Invoked for resources cleanup.
void	initialize(TransformContext context) Initialize the Stage.
void	onRunFinish(boolean succeeded, StageSubmitterContext context) Invoked after the run finishes.
void	prepareRun(StageSubmitterContext context) Prepare the run.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.cdap.cdap.etl.api.MultiOutputTransformation

transform

Field Detail

PLUGIN_TYPE

public static final String PLUGIN_TYPE

See Also:

Constant Field Values

Constructor Detail

SplitterTransform

public SplitterTransform()

Method Detail

configurePipeline

public void configurePipeline(MultiOutputPipelineConfigurer multiOutputPipelineConfigurer)

Description copied from interface: MultiOutputPipelineConfigurable

Configure a pipeline, adding datasets and streams that the stage needs.

Specified by:

configurePipeline in interface MultiOutputPipelineConfigurable

Parameters:

multiOutputPipelineConfigurer - the configurer used to add required datasets and streams

initialize

public void initialize(TransformContext context)
                throws Exception

Description copied from interface: StageLifecycle

Initialize the Stage. Can be used to setup resources.

Specified by:

initialize in interface StageLifecycle<TransformContext>

Parameters:

context - execution context

Throws:

Exception - if there is any error during initialization

prepareRun

public void prepareRun(StageSubmitterContext context)
                throws Exception

Description copied from interface: SubmitterLifecycle

Prepare the run. Used to configure the job before starting the run.

Specified by:

prepareRun in interface SubmitterLifecycle<StageSubmitterContext>

Parameters:

context - submitter context

Throws:

Exception - if there's an error during this method invocation

onRunFinish

public void onRunFinish(boolean succeeded,
                        StageSubmitterContext context)

Description copied from interface: SubmitterLifecycle

Invoked after the run finishes. Used to perform any end of the run logic.

Specified by:

onRunFinish in interface SubmitterLifecycle<StageSubmitterContext>

Parameters:

succeeded - defines the result of batch execution: true if run succeeded, false otherwise

context - submitter context

destroy

public void destroy()

Description copied from interface: Destroyable

Invoked for resources cleanup.

Specified by:

destroy in interface Destroyable