org.eclipse.smila.processing

Interface Pipelet

All Known Implementing Classes:

AbstractJdbcPipelet, AddValuesPipelet, ASesameRecordPipelet, ATransformationPipelet, AXmlTransformationPipelet, BoilerpipePipelet, CodecPipelet, CommitRecordsPipelet, CopyPipelet, CreateFileUriPipelet, CreateRelationPipelet, CreateResourcePipelet, DocumentSplitterPipelet, ExecPipelet, FileReaderPipelet, FileWriterPipelet, FilterPipelet, HtmlToTextPipelet, JdbcFetcherPipelet, JdbcLoggingPipelet, JdbcSelectPipelet, JSONReaderPipelet, JSONWriterPipelet, LanguageIdentifyPipelet, MimeTypeIdentifyPipelet, MockSearchPipelet, PushRecordsPipelet, RemoveAttributePipelet, RemoveElementFromXMLPipelet, ReplacePipelet, SampleSecurityConverterPipelet, ScriptPipelet, SesameRecordReaderPipelet, SesameRecordWriterPipelet, SetValuePipelet, SolrIndexPipelet, SolrSearchPipelet, StoreWriterPipelet, SubAttributeExtractorPipelet, TidyPipelet, TikaPipelet, XmlDocumentSplitterPipelet, 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 a pipelet description file (ending with "*.json", please note the lower cases) in a folder SMILA-INF of the providing bundle. Then they can be detected by the PipeletTracker service.

 SMILA-INF/SimpleTestPipelet.json:
 {
    "class" : "org.eclipse.smila.processing.bpel.pipelets.SimpleTestPipelet"
 }
 

Author:

jschumacher

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(AnyMap configuration) set configuration of pipelet. called once after instantiation before the pipelet is actually used in a workflow.
java.lang.String[]	process(Blackboard blackboard, java.lang.String[] recordIds) process given records.

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 given records.

Parameters:

blackboard - Blackboard holding and managing the records.

recordIds - Ids of records to process.

Returns:

Ids of records to be passed into the next pipelet. By default this should be the same as the passed in recordIds unless there is a specific (businesslogic) reason not to do so.

Throws:

ProcessingException - error during processing.