SMILA 1.0 API documentation

org.eclipse.smila.processing.worker
Class PipeletProcessorWorker

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

public class PipeletProcessorWorker
extends ProcessingWorker

A worker that is able to execute a single pipelet directly, without pipeline overhead.


Field Summary
static java.lang.String KEY_PIPELET_NAME
          key for the pipelets name.
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
PipeletProcessorWorker()
           
 
Method Summary
 java.lang.String getName()
           
 boolean perform(AnyMap parameters, RecordInput recordInput, RecordOutput recordOutput, TaskContext taskContext)
          
 void setPipeletTracker(PipeletTracker pipeletTracker)
          set pipelet tracker reference (used by DS).
 void unsetPipeletTracker(PipeletTracker pipeletTracker)
          remove pipelet tracker 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_PIPELET_NAME

public static final java.lang.String KEY_PIPELET_NAME
key for the pipelets name.

See Also:
Constant Field Values
Constructor Detail

PipeletProcessorWorker

public PipeletProcessorWorker()
Method Detail

getName

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

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

setPipeletTracker

public void setPipeletTracker(PipeletTracker pipeletTracker)
set pipelet tracker reference (used by DS).


unsetPipeletTracker

public void unsetPipeletTracker(PipeletTracker pipeletTracker)
remove pipelet tracker reference (used by DS).


SMILA 1.0 API documentation