SMILA (incubation) API documentation

org.eclipse.smila.processing.pipelets
Class RemoveAttributePipelet

java.lang.Object
  extended by org.eclipse.smila.processing.pipelets.RemoveAttributePipelet
All Implemented Interfaces:
Pipelet

public class RemoveAttributePipelet
extends java.lang.Object
implements Pipelet

Simple pipelet to remove an attribute.

Author:
jschumacher

Constructor Summary
RemoveAttributePipelet()
           
 
Method Summary
 void configure(AnyMap configuration)
          set configuration of pipelet.
 java.lang.String[] process(Blackboard blackboard, java.lang.String[] recordIds)
          remove configured attribute.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RemoveAttributePipelet

public RemoveAttributePipelet()
Method Detail

process

public java.lang.String[] process(Blackboard blackboard,
                                  java.lang.String[] recordIds)
                           throws ProcessingException
remove configured attribute. 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.

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)

SMILA (incubation) API documentation