org.eclipse.smila.processing.pipelets
Class CommitRecordsPipelet

java.lang.Object
  org.eclipse.smila.processing.pipelets.CommitRecordsPipelet

All Implemented Interfaces:

Pipelet

public class CommitRecordsPipelet
extends java.lang.Object
implements Pipelet

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(AnyMap configuration) set configuration of pipelet.
java.lang.String[]	process(Blackboard blackboard, java.lang.String[] 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(AnyMap 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 Pipelet

Parameters:

configuration - configuration of pipelet.

Throws:

ProcessingException - configuration is not applicable for pipelet (missing properties, wrong datatypes)

process

public java.lang.String[] process(Blackboard blackboard,
                                  java.lang.String[] 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 Pipelet

Parameters:

blackboard - Blackboard service managing the records.

recordIds - Ids of records to process.

Returns:

Ids of result records. By default this should be the same as the passed in recordIds unless there is a specific reason not to do so. This is especially true for SearchPiplets.

Throws:

ProcessingException - error during processing.

See Also:

org.eclipse.smila.processing.Pipelet#process(org.eclipse.smila.blackboard.Blackboard, org.eclipse.smila.datamodel.id.Id[])