org.eclipse.smila.processing.pipelets

Class DocumentSplitterPipelet

java.lang.Object

org.eclipse.smila.processing.pipelets.DocumentSplitterPipelet

All Implemented Interfaces:

Pipelet

public class DocumentSplitterPipelet
extends java.lang.Object
implements Pipelet

Pipelet to split input record(s) with (multiple) parts in separate records. The parts are stored in a record attribute whose name is given as parameter for the pipelet. This record attribute's value must be a Sequence of Maps. If the partsAttribute parameter is not set or the input records don't have parts, they are returned unchanged.

Author:

Andreas Weber

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DOCUMENT_ID id where the link to the original record is stored in the spilt record.
static java.lang.String	PROP_PARTS_ATTRIBUTE Configuration property containing the record attribute name where the parts to split are stored.
static java.lang.String	SPLIT_ID_SEPARATOR separator used to create the record id of the split records.

Constructor Summary

Constructors

Constructor and Description
DocumentSplitterPipelet()

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.

Methods inherited from class java.lang.Object

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

Field Detail

PROP_PARTS_ATTRIBUTE

public static final java.lang.String PROP_PARTS_ATTRIBUTE

Configuration property containing the record attribute name where the parts to split are stored.

See Also:

Constant Field Values

DOCUMENT_ID

public static final java.lang.String DOCUMENT_ID

id where the link to the original record is stored in the spilt record.

See Also:

Constant Field Values

SPLIT_ID_SEPARATOR

public static final java.lang.String SPLIT_ID_SEPARATOR

separator used to create the record id of the split records.

See Also:

Constant Field Values

Constructor Detail

DocumentSplitterPipelet

public DocumentSplitterPipelet()

Method Detail

configure

public void configure(AnyMap configuration)
               throws ProcessingException

Description copied from interface: Pipelet

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

Description copied from interface: Pipelet

process given records.

Specified by:

process in interface Pipelet

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.