org.eclipse.smila.lucene.pipelets
Class LuceneIndexPipelet

java.lang.Object
  org.eclipse.smila.lucene.pipelets.LuceneIndexPipelet

All Implemented Interfaces:

Pipelet

public class LuceneIndexPipelet
extends java.lang.Object
implements Pipelet

Pipelet for adding and deleting records from index.

Author:

cind01

Field Summary

static java.lang.String	ALLOW_DOUBLETS name of parameter configuring if doublets are allowed in index.
static java.lang.String	EXECUTION_MODE execution mode.
static java.lang.String	INDEX_NAME index name parameter.
static java.lang.String	INDEXING_PARAMETERS name of indexing su parameters.

Constructor Summary

LuceneIndexPipelet()

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

Field Detail

INDEXING_PARAMETERS

public static final java.lang.String INDEXING_PARAMETERS

name of indexing su parameters.

See Also:

Constant Field Values

INDEX_NAME

public static final java.lang.String INDEX_NAME

index name parameter.

See Also:

Constant Field Values

EXECUTION_MODE

public static final java.lang.String EXECUTION_MODE

execution mode.

See Also:

Constant Field Values

ALLOW_DOUBLETS

public static final java.lang.String ALLOW_DOUBLETS

name of parameter configuring if doublets are allowed in index.

See Also:

Constant Field Values

Constructor Detail

LuceneIndexPipelet

public LuceneIndexPipelet()

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.