org.eclipse.smila.processing.pipelets
Class FileWriterPipelet

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

All Implemented Interfaces:

Pipelet

public class FileWriterPipelet
extends java.lang.Object
implements Pipelet

This pipelet writes an attachment into a file described by a path attribute.

Author:

Tobias Liefke

Field Summary

static java.lang.String	PROPERTY_APPEND The name of the property that indicates to append the attachment to the file.
static java.lang.String	PROPERTY_CONTENT_ATTACHMENT The name of the property that contains the content attachment name.
static java.lang.String	PROPERTY_PATH_ATTRIBUTE The name of the property that contains the path attribute name.

Constructor Summary

FileWriterPipelet()

Method Summary

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

PROPERTY_PATH_ATTRIBUTE

public static final java.lang.String PROPERTY_PATH_ATTRIBUTE

The name of the property that contains the path attribute name.

See Also:

Constant Field Values

PROPERTY_CONTENT_ATTACHMENT

public static final java.lang.String PROPERTY_CONTENT_ATTACHMENT

The name of the property that contains the content attachment name.

See Also:

Constant Field Values

PROPERTY_APPEND

public static final java.lang.String PROPERTY_APPEND

The name of the property that indicates to append the attachment to the file.

See Also:

Constant Field Values

Constructor Detail

FileWriterPipelet

public FileWriterPipelet()

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