io.cdap.cdap.etl.api

Class Transform<IN,OUT>

java.lang.Object

io.cdap.cdap.etl.api.Transform<IN,OUT>

Type Parameters:

IN - Type of input object

OUT - Type of output object

All Implemented Interfaces:

Destroyable, PipelineConfigurable, StageLifecycle<TransformContext>, SubmitterLifecycle<StageSubmitterContext>, Transformation<IN,OUT>

Direct Known Subclasses:

ErrorTransform, SerializableTransform

@Beta
public abstract class Transform<IN,OUT>
extends Object
implements StageLifecycle<TransformContext>, SubmitterLifecycle<StageSubmitterContext>, Transformation<IN,OUT>, PipelineConfigurable

Transform Stage.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_TYPE

Constructor Summary

Constructors

Constructor and Description
Transform()

Method Summary

Modifier and Type	Method and Description
void	configurePipeline(PipelineConfigurer pipelineConfigurer) Configure an ETL pipeline.
void	destroy() Destroy the Transform Stage.
protected TransformContext	getContext()
void	initialize(TransformContext context) Initialize the Transform 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.Transformation

transform

Field Detail

PLUGIN_TYPE

public static final String PLUGIN_TYPE

See Also:

Constant Field Values

Constructor Detail

Transform

public Transform()

Method Detail

initialize

public void initialize(TransformContext context)
                throws Exception

Initialize the Transform Stage.

Specified by:

initialize in interface StageLifecycle<TransformContext>

Parameters:

context - TransformContext

Throws:

Exception - if there is any error during initialization

configurePipeline

public void configurePipeline(PipelineConfigurer pipelineConfigurer)

Configure an ETL pipeline.

Specified by:

configurePipeline in interface PipelineConfigurable

Parameters:

pipelineConfigurer - the configurer used to add required datasets and streams

destroy

public void destroy()

Destroy the Transform Stage.

Specified by:

destroy in interface Destroyable

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

getContext

protected TransformContext getContext()