CopyPipelet (SMILA 1.2 API documentation)

SMILA 1.2 API documentation

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.eclipse.smila.processing.pipelets.ATransformationPipelet
- - org.eclipse.smila.processing.pipelets.CopyPipelet

All Implemented Interfaces:

Pipelet
```
public class CopyPipelet
extends ATransformationPipelet
```
Simple pipelet that copies a String value between attributes and or attachments. It supports two modes:
COPY: copies the value from the input to the output attribute/attachment
MOVE: same as copy, but deletes the value from the input attribute/attachment

Field Summary
- Fields inherited from class org.eclipse.smila.processing.pipelets.ATransformationPipelet
  _config, ENCODING_ATTACHMENT, ENCODING_CHARSET, PROP_INPUT_NAME, PROP_INPUT_TYPE, PROP_OUTPUT_NAME, PROP_OUTPUT_TYPE, PROP_OUTPUT_VALUE_TYPE

Constructor Summary

Constructors
Constructor and Description

CopyPipelet()

Method Summary

Methods
Modifier and Type	Method and Description
`protected org.eclipse.smila.processing.pipelets.CopyPipelet.Mode`	`getMode(ParameterAccessor paramAccessor)`
`java.lang.String[]`	`process(Blackboard blackboard, java.lang.String[] recordIds)` process given records.

Methods inherited from class org.eclipse.smila.processing.pipelets.ATransformationPipelet
configure, getInputName, getInputStream, getInputType, getOutputName, getOutputType, getOutputValueType, isReadFromAttribute, isStoreInAttribute, readInput, readStringInput, storeResult, storeResult, storeResult, storeResults

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CopyPipelet
```
public CopyPipelet()
```
- Method Detail
  - getMode
```
protected org.eclipse.smila.processing.pipelets.CopyPipelet.Mode getMode(ParameterAccessor paramAccessor)
                                                                  throws MissingParameterException
```
    Returns:
    The execution mode. Default is copy.
    
    Throws:
    
    MissingParameterException
  - process
```
public java.lang.String[] process(Blackboard blackboard,
                         java.lang.String[] recordIds)
                           throws ProcessingException
```
    process given records.
    
    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.

SMILA 1.2 API documentation

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method