org.eclipse.smila.search.highlighting
Class HighlightingPipelet

java.lang.Object
  org.eclipse.smila.search.highlighting.HighlightingPipelet

All Implemented Interfaces:

Pipelet

public class HighlightingPipelet
extends java.lang.Object
implements Pipelet

HighlightingService using HighlightingTransformer services.

Constructor Summary

HighlightingPipelet()

Method Summary

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

HighlightingPipelet

public HighlightingPipelet()

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[] message)
                           throws ProcessingException

process records on Blackboard service.

Specified by:

process in interface Pipelet

Parameters:

blackboard - Blackboard service managing the records.

message - 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.