SMILA (incubation) API documentation

org.eclipse.smila.processing.pipelets
Class CommitRecordsPipelet

java.lang.Object
  extended by org.eclipse.smila.processing.pipelets.CommitRecordsPipelet
All Implemented Interfaces:
IPipelet, SimplePipelet

public class CommitRecordsPipelet
extends java.lang.Object
implements SimplePipelet

Pipelet that commits all records on the blackboard. No configuration is needed. Commit errors are logged, but no exception is thrown.

Author:
jschumacher

Constructor Summary
CommitRecordsPipelet()
           
 
Method Summary
 void configure(PipeletConfiguration configuration)
          set configuration of pipelet. called once after instantiation before the pipelet is actually used in a workflow.
 Id[] process(Blackboard blackboard, Id[] recordIds)
          set configured annotation on each record on blackboard as specified by the recordIds.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CommitRecordsPipelet

public CommitRecordsPipelet()
Method Detail

configure

public void configure(PipeletConfiguration configuration)
               throws ProcessingException
set configuration of pipelet. called once after instantiation before the pipelet is actually used in a workflow.

Specified by:
configure in interface IPipelet
Parameters:
configuration - configuration of pipelet.
Throws:
ProcessingException - configuration is not applicable for pipelet (missing properties, wrong datatypes)
See Also:
#configure(org.eclipse.smila.processing.configuration.PipeletConfiguration)

process

public Id[] process(Blackboard blackboard,
                    Id[] recordIds)
             throws ProcessingException
set configured annotation on each record on blackboard as specified by the recordIds. process records on Blackboard service.

Specified by:
process in interface SimplePipelet
Parameters:
blackboard - Blackboard service managing the records.
recordIds - Ids of records to process.
Returns:
Ids of result records.
Throws:
ProcessingException - error during processing.
See Also:
SimplePipelet.process(org.eclipse.smila.blackboard.Blackboard, org.eclipse.smila.datamodel.id.Id[])

SMILA (incubation) API documentation