io.cdap.cdap.etl.api.condition

Class Condition

java.lang.Object

io.cdap.cdap.etl.api.condition.Condition

All Implemented Interfaces:

PipelineConfigurable

public abstract class Condition
extends Object
implements PipelineConfigurable

Represents condition to be executed in the pipeline.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_TYPE

Constructor Summary

Constructors

Constructor and Description
Condition()

Method Summary

Modifier and Type	Method and Description
abstract boolean	apply(ConditionContext context) Returns the result of execution of the condition.
void	configurePipeline(PipelineConfigurer pipelineConfigurer) Configure an ETL pipeline, registering datasets and plugins that the stage needs.

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_TYPE

public static final String PLUGIN_TYPE

See Also:

Constant Field Values

Constructor Detail

Condition

public Condition()

Method Detail

apply

public abstract boolean apply(ConditionContext context)
                       throws Exception

Returns the result of execution of the condition. If true is returned, stages on the true branch will get executed, otherwise staged on the false branch will get executed.

Parameters:

context - the context which is used for evaluating the conditions

Returns:

boolean value based on which either the true branch or false branch will get executed

Throws:

Exception - if any error occurred while evaluating the condition

configurePipeline

public void configurePipeline(PipelineConfigurer pipelineConfigurer)

Description copied from interface: PipelineConfigurable

Configure an ETL pipeline, registering datasets and plugins that the stage needs. Validation should be performed in this method, throwing a ValidationException if there are any invalid config properties, or if the input or output schema is not compatible. Output schema should also be set. This method is called many times during the lifecycle of a pipeline so it should not generate any side effects. When the pipeline is being constructed, this is called in order to validate the pipeline and propagate schema. Any datasets registered at this time will be ignored. Config properties that contain macros will not have been evaluated yet. When the pipeline is deployed, this is called in order to validate the pipeline and create any datasets that are registered. Config properties that contain macros will not have been evaluated yet.

Specified by:

configurePipeline in interface PipelineConfigurable

Parameters:

pipelineConfigurer - the configurer used to register required datasets and plugins