io.cdap.cdap.api.workflow

Class AbstractWorkflow

java.lang.Object

io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable<T>

io.cdap.cdap.internal.api.AbstractPluginConfigurable<WorkflowConfigurer>

io.cdap.cdap.api.workflow.AbstractWorkflow

All Implemented Interfaces:

ProgramLifecycle<WorkflowContext>, Workflow

public abstract class AbstractWorkflow
extends AbstractPluginConfigurable<WorkflowConfigurer>
implements Workflow, ProgramLifecycle<WorkflowContext>

Provides a default implementation of Workflow methods for easy extension.

Example of configuring a workflow:

    
       @Override
      public void configure() {
        setName("PurchaseHistoryWorkflow");
        setDescription("PurchaseHistoryWorkflow description");
        addMapReduce("PurchaseHistoryBuilder");
      }
    
  

See the Purchase example application.

Constructor Summary

Constructors

Constructor and Description
AbstractWorkflow()

Method Summary

Modifier and Type	Method and Description
protected void	addAction(CustomAction action) Adds a custom action to the Workflow.
protected void	addMapReduce(String mapReduce) Adds a MapReduce program to the Workflow.
protected void	addSpark(String spark) Adds a Spark program to the Workflow.
protected WorkflowConditionConfigurer<? extends WorkflowConfigurer>	condition(Condition condition) Adds a condition to the Workflow.
protected WorkflowConditionConfigurer<? extends WorkflowConfigurer>	condition(Predicate<WorkflowContext> predicate) Adds a condition to the Workflow.
protected abstract void	configure() Override this method to configure this Workflow.
void	configure(WorkflowConfigurer configurer) Configures a Workflow using the given WorkflowConfigurer.
protected void	createLocalDataset(String datasetName, Class<? extends Dataset> datasetClass) Adds a local dataset instance with DatasetProperties.EMPTY to the Workflow.
protected void	createLocalDataset(String datasetName, Class<? extends Dataset> datasetClass, DatasetProperties props) Adds a local dataset instance to the Workflow.
protected void	createLocalDataset(String datasetName, String typeName) Adds a local dataset instance with DatasetProperties.EMPTY to the Workflow.
protected void	createLocalDataset(String datasetName, String typeName, DatasetProperties properties) Adds a local dataset instance to the Workflow.
void	destroy() Destroy is the last thing that gets called before the program is shutdown.
protected WorkflowForkConfigurer<? extends WorkflowConfigurer>	fork() Adds a fork to the Workflow.
protected WorkflowConfigurer	getConfigurer() Returns the WorkflowConfigurer, only available at configuration time.
protected WorkflowContext	getContext() Return an instance of the WorkflowContext.
void	initialize(WorkflowContext context) Initializes a Program.
protected void	setDescription(String description) Sets the description of the Workflow.
protected void	setName(String name) Sets the name of the Workflow.
protected void	setProperties(Map<String,String> properties) Sets the properties that will be available through the WorkflowSpecification.getProperties() at runtime.

Methods inherited from class io.cdap.cdap.internal.api.AbstractPluginConfigurable

usePlugin, usePlugin, usePluginClass, usePluginClass

Methods inherited from class io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable

addDatasetModule, addDatasetType, createDataset, createDataset, createDataset, createDataset

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWorkflow

public AbstractWorkflow()

Method Detail

configure

public final void configure(WorkflowConfigurer configurer)

Description copied from interface: Workflow

Configures a Workflow using the given WorkflowConfigurer.

Specified by:

configure in interface Workflow

configure

protected abstract void configure()

Override this method to configure this Workflow.

getConfigurer

protected final WorkflowConfigurer getConfigurer()

Returns the WorkflowConfigurer, only available at configuration time.

Specified by:

getConfigurer in class AbstractPluginConfigurable<WorkflowConfigurer>

setName

protected final void setName(String name)

Sets the name of the Workflow.

setDescription

protected final void setDescription(String description)

Sets the description of the Workflow.

setProperties

protected final void setProperties(Map<String,String> properties)

Sets the properties that will be available through the WorkflowSpecification.getProperties() at runtime.

Parameters:

properties - the properties to set

addAction

protected final void addAction(CustomAction action)

Adds a custom action to the Workflow.

Parameters:

action - the action to be added

addMapReduce

protected final void addMapReduce(String mapReduce)

Adds a MapReduce program to the Workflow.

Parameters:

mapReduce - the name of MapReduce program to be added

addSpark

protected final void addSpark(String spark)

Adds a Spark program to the Workflow.

Parameters:

spark - the name of the Spark program to be added

fork

protected final WorkflowForkConfigurer<? extends WorkflowConfigurer> fork()

Adds a fork to the Workflow.

Returns:

the WorkflowForkConfigurer to configure actions in the fork

condition

protected final WorkflowConditionConfigurer<? extends WorkflowConfigurer> condition(Predicate<WorkflowContext> predicate)

Adds a condition to the Workflow.

Parameters:

predicate - the Predicate to be evaluated to determine which branch to take

Returns:

the WorkflowConditionConfigurer to configure the branches in the condition

condition

protected final WorkflowConditionConfigurer<? extends WorkflowConfigurer> condition(Condition condition)

Adds a condition to the Workflow.

Parameters:

condition - the Condition to be evaluated to determine which branch to take

Returns:

the WorkflowConditionConfigurer to configure the branches in the condition

createLocalDataset

protected final void createLocalDataset(String datasetName,
                                        String typeName,
                                        DatasetProperties properties)

Adds a local dataset instance to the Workflow.

Local datasets are created at the start of every Workflow run and deleted once the run is complete. User can decide to keep the local datasets even after the run is complete by specifying the runtime arguments - dataset.dataset_name.keep.local=true.

Parameters:

datasetName - name of the dataset instance

typeName - name of the dataset type

properties - dataset instance properties

createLocalDataset

protected final void createLocalDataset(String datasetName,
                                        String typeName)

Adds a local dataset instance with DatasetProperties.EMPTY to the Workflow.

Local datasets are created at the start of every Workflow run and deleted once the run is complete. User can decide to keep the local datasets even after the run is complete by specifying the runtime arguments - dataset.dataset_name.keep.local=true.

Parameters:

datasetName - name of the dataset instance

typeName - name of the dataset type

createLocalDataset

protected final void createLocalDataset(String datasetName,
                                        Class<? extends Dataset> datasetClass,
                                        DatasetProperties props)

Adds a local dataset instance to the Workflow. Also deploys the dataset type represented by the datasetClass parameter in the current namespace.

Local datasets are created at the start of every Workflow run and deleted once the run is complete. User can decide to keep the local datasets even after the run is complete by specifying the runtime arguments - dataset.dataset_name.keep.local=true.

Parameters:

datasetName - name of the dataset instance

datasetClass - dataset class to create the Dataset type from

props - dataset instance properties

createLocalDataset

protected final void createLocalDataset(String datasetName,
                                        Class<? extends Dataset> datasetClass)

Adds a local dataset instance with DatasetProperties.EMPTY to the Workflow. Also deploys the dataset type represented by the datasetClass parameter in the current namespace.

Local datasets are created at the start of every Workflow run and deleted once the run is complete. User can decide to keep the local datasets even after the run is complete by specifying the runtime arguments - dataset.dataset_name.keep.local=true.

Parameters:

datasetName - name of the dataset instance

datasetClass - dataset class to create the Dataset type from

initialize

public void initialize(WorkflowContext context)
                throws Exception

Description copied from interface: ProgramLifecycle

Initializes a Program.

This method will be called only once per ProgramLifecycle instance.

Specified by:

initialize in interface ProgramLifecycle<WorkflowContext>

Parameters:

context - An instance of RuntimeContext

Throws:

Exception - If there is any error during initialization.

destroy

public void destroy()

Description copied from interface: ProgramLifecycle

Destroy is the last thing that gets called before the program is shutdown. So, if there are any cleanups then they can be specified here.

Specified by:

destroy in interface ProgramLifecycle<WorkflowContext>

getContext

protected final WorkflowContext getContext()

Return an instance of the WorkflowContext.