org.eclipse.smila.processing.pipelets
Class FilterPipelet

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

All Implemented Interfaces:

Pipelet

public class FilterPipelet
extends java.lang.Object
implements Pipelet

Pipelet to filter records according to some expression.

If the configured expression filterExpression matches the value (simple String) in the configure metadata attribute filterAttribute the record is written to the output. Otherwise the record is ignored. The configuration has to be part of the "_parameters" attribute in each record or is contained in the pipeline definition.

E.g.

  "_parameters": {
         "filterAttribute": "_recordid",
         "filterExpression": "[0-5]{1}"
     }
 

matches only records with the record id between 0 and 5.

Constructor Summary

FilterPipelet()

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterPipelet

public FilterPipelet()

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

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.