org.eclipse.smila.processing.pipelets.xmlprocessing

Class TidyPipelet

java.lang.Object

org.eclipse.smila.processing.pipelets.ATransformationPipelet

org.eclipse.smila.processing.pipelets.xmlprocessing.AXmlTransformationPipelet

org.eclipse.smila.processing.pipelets.xmlprocessing.TidyPipelet

All Implemented Interfaces:

Pipelet

public class TidyPipelet
extends AXmlTransformationPipelet

Pipelet that performs an Tidy transformation on an attribute or attachment value. The possible properties are:

• tidyFile: the name of the tidy configuration file (optional)
• inputName: name of the Attribute/Attachment to apply the XSL transformation to
• outputName: name of the Attribute/Attachment to store the XSL transformation in
• inputType: the type (Attribute or Attachment of the inputName
• outputType: the type (Attribute or Attachment of the outputtName

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_TIDY_FILE The name of the tidy config file used for the transformation.

Fields inherited from class org.eclipse.smila.processing.pipelets.ATransformationPipelet

_config, _log, 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
TidyPipelet()

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.
protected void	processRecord(Blackboard blackboard, ParameterAccessor paramAccessor, java.lang.String id) Processing of a single input record.

Methods inherited from class org.eclipse.smila.processing.pipelets.xmlprocessing.AXmlTransformationPipelet

createDocument, process, storeDocument, storeDocument

Methods inherited from class org.eclipse.smila.processing.pipelets.ATransformationPipelet

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

Field Detail

PROP_TIDY_FILE

public static final java.lang.String PROP_TIDY_FILE

The name of the tidy config file used for the transformation.

See Also:

Constant Field Values

Constructor Detail

TidyPipelet

public TidyPipelet()

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

Overrides:

configure in class ATransformationPipelet

Parameters:

configuration - configuration of pipelet.

Throws:

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

processRecord

protected void processRecord(Blackboard blackboard,
                 ParameterAccessor paramAccessor,
                 java.lang.String id)
                      throws java.lang.Exception

Description copied from class: AXmlTransformationPipelet

Processing of a single input record.

Specified by:

processRecord in class AXmlTransformationPipelet

Parameters:

blackboard - Blackboard service managing the records.

paramAccessor - Parameter accessor configured with pipelet configuration and current record. Should be used to access pipelet parameters.

id - id of the record to process

Throws:

java.lang.Exception