SMILA (incubation) API documentation

org.eclipse.smila.processing.worker
Class PipelineProcessingWorker

java.lang.Object
  extended by org.eclipse.smila.processing.worker.PipelineProcessingWorker
All Implemented Interfaces:
Worker

public class PipelineProcessingWorker
extends java.lang.Object
implements Worker

A worker that is able to execute a pipeline.


Field Summary
static int DEFAULT_NUMBER_OF_PARALLEL_RECORDS
          default number of parallel records to be processed in one go.
static java.lang.String INPUT_SLOT_NAME
          the workers input slot name .
static java.lang.String KEY_NUMBER_OF_PARALLEL_RECORDS
          key for the number of parallel records for one execution of the pipeline.
static java.lang.String KEY_PIPELINE_NAME
          key for the pipeline's name.
static java.lang.String OUTPUT_SLOT_NAME
          the workers output slot name .
static java.lang.String WORKER_NAME
          worker's name.
 
Constructor Summary
PipelineProcessingWorker()
           
 
Method Summary
 java.lang.String getName()
           
 void perform(TaskContext taskContext)
          Performs a computation on the data available in the TaskContext, such as a task for this worker, input and (if configured) output slots.
 void setBlackboardFactory(BlackboardFactory factory)
          set blackboard factory reference (used by DS).
 void setProcessor(WorkflowProcessor processor)
          set workflow processor reference (used by DS).
 void unsetBlackboardFactory(BlackboardFactory factory)
          remove blackboard factory reference (used by DS).
 void unsetProcessor(WorkflowProcessor processor)
          remove workflow processor reference (used by DS).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WORKER_NAME

public static final java.lang.String WORKER_NAME
worker's name.

See Also:
Constant Field Values

KEY_PIPELINE_NAME

public static final java.lang.String KEY_PIPELINE_NAME
key for the pipeline's name.

See Also:
Constant Field Values

KEY_NUMBER_OF_PARALLEL_RECORDS

public static final java.lang.String KEY_NUMBER_OF_PARALLEL_RECORDS
key for the number of parallel records for one execution of the pipeline.

See Also:
Constant Field Values

DEFAULT_NUMBER_OF_PARALLEL_RECORDS

public static final int DEFAULT_NUMBER_OF_PARALLEL_RECORDS
default number of parallel records to be processed in one go.

See Also:
Constant Field Values

INPUT_SLOT_NAME

public static final java.lang.String INPUT_SLOT_NAME
the workers input slot name .

See Also:
Constant Field Values

OUTPUT_SLOT_NAME

public static final java.lang.String OUTPUT_SLOT_NAME
the workers output slot name .

See Also:
Constant Field Values
Constructor Detail

PipelineProcessingWorker

public PipelineProcessingWorker()
Method Detail

perform

public void perform(TaskContext taskContext)
             throws java.lang.Exception
Performs a computation on the data available in the TaskContext, such as a task for this worker, input and (if configured) output slots. An implementor must make sure, calls to this method must be thread-safe!

Specified by:
perform in interface Worker
Parameters:
taskContext - the TaskContext information with which this operation can be performed.
Throws:
java.lang.Exception

getName

public java.lang.String getName()
Specified by:
getName in interface Worker
Returns:
"pipelineProcessingWorker"

setProcessor

public void setProcessor(WorkflowProcessor processor)
set workflow processor reference (used by DS).


unsetProcessor

public void unsetProcessor(WorkflowProcessor processor)
remove workflow processor reference (used by DS).


setBlackboardFactory

public void setBlackboardFactory(BlackboardFactory factory)
set blackboard factory reference (used by DS).


unsetBlackboardFactory

public void unsetBlackboardFactory(BlackboardFactory factory)
remove blackboard factory reference (used by DS).


SMILA (incubation) API documentation