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

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

All Implemented Interfaces:

Pipelet

public class XmlSplitterPipelet
extends ATransformationPipelet

Pipelet that splits a XML stream into multiple xml snippets. For each snippet a new Record is created where the XML snippet is stored in either an attribute or attachment. The created records are not returned as a PipeletResult (this is just the same as the incoming RecordIds) but are directly send to the ConnectivityManager and are routed once more to the Queue. On each created record the Annotation MessageProperties is set with the key value pair isXmlSnippet=true. This can be used in Listener rules to select for XML snippets to process.The possible properties are:

• beginTagName: the name of the tag to start the xml snippet
• isBeginClosingTag: boolean flag if the beginTagName is a closing tag (true) or not (false)
• endTagName: the name of the tag to end the xml snippet
• isEndClosingTag: boolean flag if the endTagName is a closing tag (true) or not (false)
• keyTagName: the name of the tag used to create a record id
• maxBufferSize: the maximum size of the internal record buffer (optional, default is 20)
• 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 outputtName

Field Summary

static java.lang.String	DEFAULT_ID_SEPARATOR default id separator.
static int	DEFAULT_MAX_BUFFER_SIZE Constant for the default max buffer size (20).
static java.lang.String	PROP_BEGIN_TAG_NAME Constant for the property beginTagName.
static java.lang.String	PROP_END_TAG_NAME Constant for the property endTagName.
static java.lang.String	PROP_ID_SEPARATOR Constant for the property idSeparator.
static java.lang.String	PROP_IS_BEGIN_CLOSING_TAG Constant for the property isBeginClosingTag.
static java.lang.String	PROP_IS_END_CLOSING_TAG Constant for the property isEndClosingTag.
static java.lang.String	PROP_KEY_TAG_NAME Constant for the property keyTagName.
static java.lang.String	PROP_MAX_BUFFER_SIZE Constant for the property maxBufferSize.

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

XmlSplitterPipelet()

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.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_BEGIN_TAG_NAME

public static final java.lang.String PROP_BEGIN_TAG_NAME

Constant for the property beginTagName.

See Also:

Constant Field Values

PROP_IS_BEGIN_CLOSING_TAG

public static final java.lang.String PROP_IS_BEGIN_CLOSING_TAG

Constant for the property isBeginClosingTag.

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_IS_END_CLOSING_TAG

public static final java.lang.String PROP_IS_END_CLOSING_TAG

Constant for the property isEndClosingTag.

See Also:

Constant Field Values

PROP_KEY_TAG_NAME

public static final java.lang.String PROP_KEY_TAG_NAME

Constant for the property keyTagName.

See Also:

Constant Field Values

PROP_MAX_BUFFER_SIZE

public static final java.lang.String PROP_MAX_BUFFER_SIZE

Constant for the property maxBufferSize.

See Also:

Constant Field Values

PROP_ID_SEPARATOR

public static final java.lang.String PROP_ID_SEPARATOR

Constant for the property idSeparator.

See Also:

Constant Field Values

DEFAULT_ID_SEPARATOR

public static final java.lang.String DEFAULT_ID_SEPARATOR

default id separator.

See Also:

Constant Field Values

DEFAULT_MAX_BUFFER_SIZE

public static final int DEFAULT_MAX_BUFFER_SIZE

Constant for the default max buffer size (20).

See Also:

Constant Field Values

Constructor Detail

XmlSplitterPipelet

public XmlSplitterPipelet()

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.