org.eclipse.smila.jobmanager.taskgenerator

Interface TaskGenerator

All Known Implementing Classes:

CombineInputWithAllTaskGenerator, DefaultTaskGenerator, RunOnceTriggerTaskGenerator, TaskGeneratorBase, UpdatePusherTaskGenerator

public interface TaskGenerator

Interface for TaskGenerator implementations. TaskGenerators are used to create (follow-up) tasks for a specifc workflow action/worker.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<Task>	createCompletionTasks(java.util.Map<java.lang.String,Bucket> inputBuckets, java.util.Map<java.lang.String,Bucket> outputBuckets, AnyMap parameters, java.lang.String workerName) Creates tasks for the completion workflow run, i.e. the run just before the job run is completed to to some cleanup/completion work.
java.util.List<Task>	createRunOnceTasks(java.util.Map<java.lang.String,Bucket> inputBuckets, java.util.Map<java.lang.String,Bucket> outputBuckets, AnyMap parameters, java.lang.String workerName) Creates tasks for the RunOnce mode, i.e. for all objects in the input bucket of the start action.
java.util.List<Task>	createTasks(java.util.Map<java.lang.String,java.util.List<BulkInfo>> changedInput, java.util.Map<java.lang.String,Bucket> inputBuckets, java.util.Map<java.lang.String,Bucket> outputBuckets, AnyMap parameters, java.lang.String workerName)
java.util.List<Task>	createTasks(java.util.Map<java.lang.String,java.util.List<BulkInfo>> changedInput, java.util.Map<java.lang.String,Bucket> inputBuckets, java.util.Map<java.lang.String,Bucket> outputBuckets, AnyMap parameters, java.lang.String workerName, java.lang.String jobName, java.lang.String jobRunId, java.lang.String workflowRunId) Create tasks based on additional job run information.
void	finishTask(Task task, TaskCompletionStatus taskState)
java.lang.String	getName()
void	validateParameters(AnyMap parameters) Check complex parameters in some task generators if desired.

Method Detail

getName

java.lang.String getName()

Returns:

name of generator, it is used in Worker descriptions to select the generator.

createTasks

java.util.List<Task> createTasks(java.util.Map<java.lang.String,java.util.List<BulkInfo>> changedInput,
                               java.util.Map<java.lang.String,Bucket> inputBuckets,
                               java.util.Map<java.lang.String,Bucket> outputBuckets,
                               AnyMap parameters,
                               java.lang.String workerName,
                               java.lang.String jobName,
                               java.lang.String jobRunId,
                               java.lang.String workflowRunId)
                                 throws TaskGeneratorException

Create tasks based on additional job run information.

Parameters:

changedInput - key: slot containing added bulks, value: added bulks

inputBuckets - key: input slot name, value: bucket for this slot

outputBuckets - key: output slot name, value: bucket for this slot

parameters - key: param name, value: (evaluated) param value

workerName - (action) worker for which to create new tasks

jobName - name of current job

jobRunId - id of current job run

workflowRunId - id of current workflow run

Returns:

a list of new generated tasks

Throws:

TaskGeneratorException - error while generating tasks

createTasks

java.util.List<Task> createTasks(java.util.Map<java.lang.String,java.util.List<BulkInfo>> changedInput,
                               java.util.Map<java.lang.String,Bucket> inputBuckets,
                               java.util.Map<java.lang.String,Bucket> outputBuckets,
                               AnyMap parameters,
                               java.lang.String workerName)
                                 throws TaskGeneratorException

Parameters:

changedInput - key: slot containing added bulks, value: added bulks

inputBuckets - key: input slot name, value: bucket for this slot

outputBuckets - key: output slot name, value: bucket for this slot

parameters - key: param name, value: (evaluated) param value

workerName - (action) worker for which to create new tasks

Returns:

a list of new generated tasks

Throws:

TaskGeneratorException - error while generating tasks

finishTask

void finishTask(Task task,
              TaskCompletionStatus taskState)
                throws TaskGeneratorException

Parameters:

task - The task to be cleaned up

taskState - TODO

Throws:

TaskGeneratorException - error while cleaning up for finished task

createRunOnceTasks

java.util.List<Task> createRunOnceTasks(java.util.Map<java.lang.String,Bucket> inputBuckets,
                                      java.util.Map<java.lang.String,Bucket> outputBuckets,
                                      AnyMap parameters,
                                      java.lang.String workerName)
                                        throws TaskGeneratorException

Creates tasks for the RunOnce mode, i.e. for all objects in the input bucket of the start action.

Parameters:

inputBuckets - key: input slot name, value: bucket for this slot

outputBuckets - key: output slot name, value: bucket for this slot

parameters - key: param name, value: (evaluated) param value

workerName - (action) worker for which to create new tasks

Returns:

a list of new generated tasks

Throws:

TaskGeneratorException - error while generating tasks

createCompletionTasks

java.util.List<Task> createCompletionTasks(java.util.Map<java.lang.String,Bucket> inputBuckets,
                                         java.util.Map<java.lang.String,Bucket> outputBuckets,
                                         AnyMap parameters,
                                         java.lang.String workerName)
                                           throws TaskGeneratorException

Creates tasks for the completion workflow run, i.e. the run just before the job run is completed to to some cleanup/completion work.

Parameters:

inputBuckets - key: input slot name, value: bucket for this slot

outputBuckets - key: output slot name, value: bucket for this slot

parameters - key: param name, value: (evaluated) param value

workerName - (action) worker for which to create new tasks

Returns:

a list of new generated tasks

Throws:

TaskGeneratorException - error while generating tasks

validateParameters

void validateParameters(AnyMap parameters)
                        throws TaskGeneratorException

Check complex parameters in some task generators if desired. Do nothing if no check desired.

Parameters:

parameters - The map with the parameters

Throws:

TaskGeneratorException - an exception if something is wrong with the parameters