org.eclipse.smila.processing.pipelets.xmlprocessing

Class XmlDocumentSplitterPipelet

java.lang.Object

org.eclipse.smila.processing.pipelets.ATransformationPipelet

org.eclipse.smila.processing.pipelets.xmlprocessing.XmlDocumentSplitterPipelet

All Implemented Interfaces:

Pipelet

public class XmlDocumentSplitterPipelet
extends ATransformationPipelet

The possible properties are:

• beginTagName: the name of the tag to start the xml snippet
• beginTagNamespace: the (optional) namespace of the tag to start the xml snippet
• endTagName: the name of the tag to end the xml snippet
• endTagNamespace: the (optional) namespace of the tag to end the xml snippet
• 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). An input Attribute is not interpreted as content but as a file path or an URL to the XML document
• outputType: the type (Attribute or Attachment of the outputName)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_BEGIN_TAG_NAME Constant for the property beginTagName.
static java.lang.String	PROP_BEGIN_TAG_NAMESPACE Constant for the property beginTagNamespace.
static java.lang.String	PROP_END_TAG_NAME Constant for the property endTagName.
static java.lang.String	PROP_END_TAG_NAMESPACE Constant for the property endTagNamespace.

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
XmlDocumentSplitterPipelet()

Method Summary

Methods

Modifier and Type	Method and Description
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

Field Detail

PROP_BEGIN_TAG_NAME

public static final java.lang.String PROP_BEGIN_TAG_NAME

Constant for the property beginTagName.

See Also:

Constant Field Values

PROP_BEGIN_TAG_NAMESPACE

public static final java.lang.String PROP_BEGIN_TAG_NAMESPACE

Constant for the property beginTagNamespace.

See Also:

Constant Field Values

PROP_END_TAG_NAME

public static final java.lang.String PROP_END_TAG_NAME

Constant for the property endTagName.

See Also:

Constant Field Values

PROP_END_TAG_NAMESPACE

public static final java.lang.String PROP_END_TAG_NAMESPACE

Constant for the property endTagNamespace.

See Also:

Constant Field Values

Constructor Detail

XmlDocumentSplitterPipelet

public XmlDocumentSplitterPipelet()

Method Detail

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.