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

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

All Implemented Interfaces:

IPipelet, SimplePipelet

public class XPathFilterPipelet
extends AXmlTransformationPipelet

Pipelet that filters elements by XPath (either include or exclude mode). The possible properties are:

• xpath: the XPaths (multivalue)
• seperator: the seperator (optional)
• namespace: the namespace (optional)
• inputName: name of the Attribute/Attachment to read the XML Document from
• outputName: name of the Attribute/Attachment to store the extracted value in
• inputType: the type (Attribute or Attachment of the inputName
• outputType: the type (Attribute or Attachment of the outputtName

Nested Class Summary

static class

XPathFilterPipelet.XPathFilerMode The XPathFilerMode, either include or exclude.

Field Summary

static java.lang.String	PROP_FILTER_MODE Property for the XPathFilerMode to execute.
static java.lang.String	PROP_NAMESPACE The rootElement property.
static java.lang.String	PROP_ROOT_ELEMENT The namespace property.
static java.lang.String	PROP_SEPERATOR The seperator property.
static java.lang.String	PROP_XPATH The name of the XSLT file used for the transformation.

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

_inputName, _inputPath, _inputType, _log, _outputName, _outputPath, _outputType, ENCODING_ATTACHMENT, PROP_INPUT_NAME, PROP_INPUT_TYPE, PROP_OUTPUT_NAME, PROP_OUTPUT_TYPE

Constructor Summary

XPathFilterPipelet()

Method Summary

void	configure(PipeletConfiguration configuration) set configuration of pipelet. called once after instantiation before the pipelet is actually used in a workflow.
Id[]	process(Blackboard blackboard, Id[] 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, getInputPath, getInputType, getOutputName, getOutputPath, 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_XPATH

public static final java.lang.String PROP_XPATH

The name of the XSLT file used for the transformation.

See Also:

Constant Field Values

PROP_FILTER_MODE

public static final java.lang.String PROP_FILTER_MODE

Property for the XPathFilerMode to execute.

See Also:

Constant Field Values

PROP_SEPERATOR

public static final java.lang.String PROP_SEPERATOR

The seperator property.

See Also:

Constant Field Values

PROP_NAMESPACE

public static final java.lang.String PROP_NAMESPACE

The rootElement property. Only valid for filter mode include.

See Also:

Constant Field Values

PROP_ROOT_ELEMENT

public static final java.lang.String PROP_ROOT_ELEMENT

The namespace property.

See Also:

Constant Field Values

Constructor Detail

XPathFilterPipelet

public XPathFilterPipelet()

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

Overrides:

configure in class ATransformationPipelet

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)

process

public Id[] process(Blackboard blackboard,
                    Id[] 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.

Throws:

ProcessingException - error during processing.

See Also:

SimplePipelet.process(org.eclipse.smila.blackboard.Blackboard, org.eclipse.smila.datamodel.id.Id[])