org.eclipse.smila.processing.pipelets.xmlprocessing
Class RemoveElementFromXMLPipelet

java.lang.Object
  org.eclipse.smila.processing.pipelets.ATransformationPipelet
      org.eclipse.smila.processing.pipelets.xmlprocessing.AXmlTransformationPipelet
          org.eclipse.smila.processing.pipelets.xmlprocessing.RemoveElementFromXMLPipelet

All Implemented Interfaces:

Pipelet

public class RemoveElementFromXMLPipelet
extends AXmlTransformationPipelet

Pipelet that removes a selected element from an XML document. The possible properties are:

• elementId: the id of the XML element
• inputName: name of the Attribute/Attachment to read the XML Document from
• outputName: name of the Attribute/Attachment to store the manipulated XML Document in
• inputType: the type (Attribute or Attachment of the inputName
• outputType: the type (Attribute or Attachment of the outputtName

Field Summary

static java.lang.String

PROP_ELEMENT_ID Property for the Id of the XML element..

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

_dataFactory, _inputName, _inputType, _log, _outputName, _outputType, ENCODING_ATTACHMENT, PROP_INPUT_NAME, PROP_INPUT_TYPE, PROP_OUTPUT_NAME, PROP_OUTPUT_TYPE

Constructor Summary

RemoveElementFromXMLPipelet()

Method Summary

void	configure(AnyMap configuration) set configuration of pipelet.
java.lang.String[]	process(Blackboard blackboard, java.lang.String[] recordIds) process records on Blackboard service.

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

createDocument, storeDocument

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

getInputName, getInputType, getOutputName, getOutputType, isReadFromAttribute, isStoreInAttribute, readInput, readStringInput, storeResult, storeResult, storeResults

Methods inherited from class java.lang.Object

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

Field Detail

PROP_ELEMENT_ID

public static final java.lang.String PROP_ELEMENT_ID

Property for the Id of the XML element..

See Also:

Constant Field Values

Constructor Detail

RemoveElementFromXMLPipelet

public RemoveElementFromXMLPipelet()

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)

process

public java.lang.String[] process(Blackboard blackboard,
                                  java.lang.String[] recordIds)
                           throws ProcessingException

process records on Blackboard service.

Parameters:

blackboard - Blackboard service managing the records.

recordIds - Ids of records to process.

Returns:

Ids of result records. By default this should be the same as the passed in recordIds unless there is a specific reason not to do so. This is especially true for SearchPiplets.

Throws:

ProcessingException - error during processing.