org.eclipse.smila.processing.pipelets
Class ATransformationPipelet

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

All Implemented Interfaces:

IPipelet, SimplePipelet

Direct Known Subclasses:

AXmlTransformationPipelet, CopyPipelet, HtmlToTextPipelet

public abstract class ATransformationPipelet
extends java.lang.Object
implements SimplePipelet

Abstract base class for transformation pipelets. The general properties are:

• inputName: name of the Attribute/Attachment to apply the transformation to
• outputName: name of the Attribute/Attachment to store the transformation in
• inputType: the type (Attribute or Attachment of the inputName
• outputType: the type (Attribute or Attachment of the outputtName

Field Summary

protected java.lang.String	_inputName The name of the input attribute/attachment.
protected Path	_inputPath The path of the input attribute if input type is ATTRIBUTE.
protected SourceType	_inputType The type of the inputName.
protected Log	_log local logger.
protected java.lang.String	_outputName The name of the output attribute/attachment.
protected Path	_outputPath The path of the output attribute if output type is ATTRIBUTE.
protected SourceType	_outputType The type of the outputName.
static java.lang.String	ENCODING_ATTACHMENT encoding to use for storing results as attachments.
static java.lang.String	PROP_INPUT_NAME Name of the input Attribute/Attachment.
static java.lang.String	PROP_INPUT_TYPE The type of the inputName: Attribute/Attachment.
static java.lang.String	PROP_OUTPUT_NAME Name of the output Attribute/Attachment.
static java.lang.String	PROP_OUTPUT_TYPE The type of the inputName: Attribute/Attachment.

Constructor Summary

ATransformationPipelet()

Method Summary

void	configure(PipeletConfiguration configuration) set configuration of pipelet. called once after instantiation before the pipelet is actually used in a workflow.
java.lang.String	getInputName()
Path	getInputPath()
SourceType	getInputType()
java.lang.String	getOutputName()
Path	getOutputPath()
SourceType	getOutputType()
boolean	isReadFromAttribute() Checks if to read the input from an Attribute.
boolean	isStoreInAttribute() Checks if to store the output in an Attribute.
protected byte[]	readInput(Blackboard blackboard, Id id) Reads input data from the Blackboard as byte[].
protected java.lang.String	readStringInput(Blackboard blackboard, Id id) Reads input data from the Blackboard as a String.
protected void	storeResult(Blackboard blackboard, Id id, byte[] bytes) Stores result byte[] on the blackboard.
protected void	storeResult(Blackboard blackboard, Id id, java.lang.String result) store result strings on the blackboard.
protected void	storeResults(Blackboard blackboard, Id id, java.util.Collection<java.lang.String> results) store result strings on the blackboard.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.smila.processing.SimplePipelet

process

Field Detail

PROP_INPUT_TYPE

public static final java.lang.String PROP_INPUT_TYPE

The type of the inputName: Attribute/Attachment.

See Also:

Constant Field Values

PROP_OUTPUT_TYPE

public static final java.lang.String PROP_OUTPUT_TYPE

The type of the inputName: Attribute/Attachment.

See Also:

Constant Field Values

PROP_INPUT_NAME

public static final java.lang.String PROP_INPUT_NAME

Name of the input Attribute/Attachment.

See Also:

Constant Field Values

PROP_OUTPUT_NAME

public static final java.lang.String PROP_OUTPUT_NAME

Name of the output Attribute/Attachment.

See Also:

Constant Field Values

ENCODING_ATTACHMENT

public static final java.lang.String ENCODING_ATTACHMENT

encoding to use for storing results as attachments.

See Also:

Constant Field Values

_log

protected final Log _log

local logger.

_inputType

protected SourceType _inputType

The type of the inputName.

_outputType

protected SourceType _outputType

The type of the outputName.

_inputName

protected java.lang.String _inputName

The name of the input attribute/attachment.

_outputName

protected java.lang.String _outputName

The name of the output attribute/attachment.

_inputPath

protected Path _inputPath

The path of the input attribute if input type is ATTRIBUTE.

_outputPath

protected Path _outputPath

The path of the output attribute if output type is ATTRIBUTE.

Constructor Detail

ATransformationPipelet

public ATransformationPipelet()

Method Detail

configure

public void configure(PipeletConfiguration 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 IPipelet

Parameters:

configuration - configuration of pipelet.

Throws:

ProcessingException - configuration is not applicable for pipelet (missing properties, wrong datatypes)

See Also:

#configure(org.eclipse.smila.processing.configuration.PipeletConfiguration)

getInputType

public SourceType getInputType()

Returns:

input type

getInputName

public java.lang.String getInputName()

Returns:

input name

getInputPath

public Path getInputPath()

Returns:

input path, if input type is ATTRIBUTE, else null.

getOutputType

public SourceType getOutputType()

Returns:

output type

getOutputName

public java.lang.String getOutputName()

Returns:

output name

getOutputPath

public Path getOutputPath()

Returns:

output path, if output type is ATTRIBUTE, else null.

isReadFromAttribute

public boolean isReadFromAttribute()

Checks if to read the input from an Attribute.

Returns:

true if to read the input from an Attribute, false otherwise

isStoreInAttribute

public boolean isStoreInAttribute()

Checks if to store the output in an Attribute.

Returns:

true if to store the output in an Attribute, false otherwise

storeResult

protected void storeResult(Blackboard blackboard,
                           Id id,
                           java.lang.String result)
                    throws ProcessingException

store result strings on the blackboard.

Parameters:

blackboard - blackboard

id - record id

result - result string

Throws:

ProcessingException - error.

storeResults

protected void storeResults(Blackboard blackboard,
                            Id id,
                            java.util.Collection<java.lang.String> results)
                     throws ProcessingException

store result strings on the blackboard.

Parameters:

blackboard - blackboard

id - record id

results - result strings

Throws:

ProcessingException - error.

storeResult

protected void storeResult(Blackboard blackboard,
                           Id id,
                           byte[] bytes)
                    throws java.lang.Exception

Stores result byte[] on the blackboard.

Parameters:

blackboard - the Blackboard

id - the Id of the record

bytes - the byte[] to save

Throws:

java.lang.Exception - if any error occurs

readInput

protected byte[] readInput(Blackboard blackboard,
                           Id id)
                    throws BlackboardAccessException,
                           java.io.UnsupportedEncodingException

Reads input data from the Blackboard as byte[].

Parameters:

blackboard - the Blackboard

id - the Id of the record

Returns:

a byte[]

Throws:

BlackboardAccessException - if any error occurs

java.io.UnsupportedEncodingException - if converting string to bytes fails

readStringInput

protected java.lang.String readStringInput(Blackboard blackboard,
                                           Id id)
                                    throws BlackboardAccessException,
                                           java.io.UnsupportedEncodingException

Reads input data from the Blackboard as a String.

Parameters:

blackboard - the Blackboard

id - the Id of the record

Returns:

a String

Throws:

BlackboardAccessException - if any error occurs

java.io.UnsupportedEncodingException - if converting bytes to string fails