SMILA 1.0 API documentation

org.eclipse.smila.processing.worker
Class PipelineProcessorWorker

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

public class PipelineProcessorWorker
extends ProcessingWorker

A worker that is able to execute a pipeline.


Field Summary
static int DEFAULT_PIPELINERUN_BULKSIZE
          default number of parallel records to be processed in one go.
static java.lang.String KEY_PIPELINE_NAME
          key for the pipeline's name.
static java.lang.String KEY_PIPELINERUN_BULKSIZE
          key for the number of parallel records for one execution of the pipeline.
static java.lang.String WORKER_NAME
          worker's name.
 
Fields inherited from class org.eclipse.smila.processing.worker.ProcessingWorker
_binStorageAvailable, _blackboardFactory, _log, INPUT_SLOT_NAME, KEY_KEEPATTACHMENTSINMEMORY, KEY_WRITEATTACHMENTSTOOUTPUT, OUTPUT_SLOT_NAME, s_noBinStorageAvailableLogged
 
Constructor Summary
PipelineProcessorWorker()
           
 
Method Summary
 java.lang.String getName()
           
 boolean perform(AnyMap parameters, RecordInput recordInput, RecordOutput recordOutput, TaskContext taskContext)
          
 void setProcessor(WorkflowProcessor processor)
          set workflow processor reference (used by DS).
 void unsetProcessor(WorkflowProcessor processor)
          remove workflow processor reference (used by DS).
 
Methods inherited from class org.eclipse.smila.processing.worker.ProcessingWorker
cleanupBlackboard, getBlackboard, perform, setBlackboardFactory, unsetBlackboardFactory, writeResultRecords
 
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_PIPELINERUN_BULKSIZE

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

See Also:
Constant Field Values

DEFAULT_PIPELINERUN_BULKSIZE

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

See Also:
Constant Field Values
Constructor Detail

PipelineProcessorWorker

public PipelineProcessorWorker()
Method Detail

getName

public java.lang.String getName()
Returns:
"pipelineProcessor"

perform

public boolean perform(AnyMap parameters,
                       RecordInput recordInput,
                       RecordOutput recordOutput,
                       TaskContext taskContext)
                throws java.lang.Exception

Specified by:
perform in class ProcessingWorker
Parameters:
parameters - task parameters, converted to an AnyMap
recordInput - input bulk
recordOutput - output bulk, can be null
taskContext - task context
Returns:
true if at least one record was processed successfully.
Throws:
java.lang.Exception - bulk could not be processed

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).


SMILA 1.0 API documentation