org.eclipse.smila.processing
Interface Pipelet

All Known Implementing Classes:

AddValuesPipelet, ASesameRecordPipelet, ATransformationPipelet, AXmlTransformationPipelet, CommitRecordsPipelet, CopyPipelet, CreateFileUriPipelet, CreateRelationPipelet, CreateResourcePipelet, FileReaderPipelet, FilterPipelet, HighlightingPipelet, HtmlToTextPipelet, LuceneIndexPipelet, LuceneSearchPipelet, MimeTypeIdentifyPipelet, MockSearchPipelet, RemoveAttributePipelet, RemoveElementFromXMLPipelet, SampleSecurityConverterPipelet, SesameRecordReaderPipelet, SesameRecordWriterPipelet, SolrIndexPipelet, SolrIndexPipelet, SolrSearchPipelet, SolrSearchPipelet, SubAttributeExtractorPipelet, TidyPipelet, XmlSplitterPipelet, XPathExtractorPipelet, XPathFilterPipelet, XslTransformationPipelet

public interface Pipelet

Interface of Pipelets. Their lifecycle and configuration is managed by the workflow engine. They are not shared by multiple workflows, each occurrence of a pipelet in a workflow uses a different pipelet instance. Pipelets must have a public no-argument constructor. The pipelet class name must be registered in META-INF/MANIFEST.MF of the providing bundle using the header name "SMILA-Pipelets". Then they can be detected by the PipeletTracker service.

 SMILA-Pipelets: org.eclipse.smila.processing.bpel.pipelets.SimpleTestPipelet
 

Multiple classes can be registered separeted by comma:

 SMILA-Pipelets: org.eclipse.smila.processing.test.Test1Pipelet,org.eclipse.smila.processing.test.Test2Pipelet
 

Author:

jschumacher

Method Summary

void	configure(AnyMap configuration) set configuration of pipelet.
java.lang.String[]	process(Blackboard blackboard, java.lang.String[] recordIds) process records on Blackboard service.

Method Detail

configure

void configure(AnyMap configuration)
               throws ProcessingException

set configuration of pipelet. called once after instantiation before the pipelet is actually used in a workflow.

Parameters:

configuration - configuration of pipelet.

Throws:

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

process

java.lang.String[] process(Blackboard blackboard,
                           java.lang.String[] recordIds)
                           throws ProcessingException

process records on Blackboard service.

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.