Jump to: navigation, search

Difference between revisions of "SMILA/Documentation/Bundle org.eclipse.smila.processing.pipelets.xmlprocessing"

Line 3: Line 3:
 
=== Description ===
 
=== Description ===
  
Pipelet that performs an XSL transformation on an attribute or attachment value and stores the transformed document in an attribute or attachment.
+
This pipelet performs an XSL transformation on an attribute or attachment value and stores the transformed document in an attribute or attachment.
  
 
=== Configuration ===
 
=== Configuration ===
Line 10: Line 10:
 
!Property!!Type!!Description
 
!Property!!Type!!Description
 
|-
 
|-
|inputType||String : ATTACHMENT, ATTRIBUTE||selects if the XML input is found in an attachment or attribute of the record
+
|''inputType''||String : ATTACHMENT, ATTRIBUTE||Defines whether the XML input is found in an attachment or in an attribute of the record.
 
|-
 
|-
|outputType||String : ATTACHMENT, ATTRIBUTE||selects if the transformed output should be stored in an attachment or attribute of the record
+
|''outputType''||String : ATTACHMENT, ATTRIBUTE||Defines whether the transformed output should be stored in an attachment or in an attribute of the record.
 
|-
 
|-
|inputName||String||name of input attachment or path to input attribute (process literals of attribute)
+
|''inputName''||String||The name of the input attachment or the path to the input attribute (process literals of attribute).
 
|-
 
|-
|outputName||String|| name of output attachment or path to output attribute (store result as literals of attribute)
+
|''outputName''||String||The name of the output attachment or the path to the output attribute (store result as literals of attribute).
 
|-
 
|-
|xslFile||String||the name (with relative or absolute path) of the XSL file to use for transformation
+
|''xslFile''||String||The name (with relative or absolute path) of the XSL file to be used for transformation.
 
|}
 
|}
  
 
==== Example ====
 
==== Example ====
  
'''PipeletConfiguration for XslTransformationPipelet'''
+
'''Pipelet configuration for XslTransformationPipelet'''
 +
 
 
<source lang="xml">
 
<source lang="xml">
<PipeletConfiguration xmlns="http://www.eclipse.org/smila/processor">
+
<proc:configuration>
    <Property name="xslFile" type="java.lang.String">
+
     <rec:Val key="inputType">ATTRIBUTE<rec:Val>
        <Value>./configuration/data/author.xsl</Value>
+
     <rec:Val key="outputType">ATTRIBUTE<rec:Val>
     </Property>
+
     <rec:Val key="inputName">xmlIn<rec:Val>
    <Property name="inputType" type="java.lang.String">
+
     <rec:Val key="outputName">xmlOut<rec:Val>
        <Value>ATTRIBUTE</Value>
+
     <rec:Val key="xslFile">./configuration/data/author.xsl<rec:Val>
     </Property>
+
</proc:configuration>
    <Property name="outputType" type="java.lang.String">
+
        <Value>ATTRIBUTE</Value>
+
     </Property>
+
    <Property name="inputName" type="java.lang.String">
+
        <Value>xmlIn</Value>
+
     </Property>
+
    <Property name="outputName" type="java.lang.String">
+
        <Value>xmlOut</Value>
+
     </Property>
+
</PipeletConfiguration>
+
 
</source>
 
</source>
 
  
 
== <tt>org.eclipse.smila.processing.pipelets.xmlprocessing.XPathExtractorPipelet</tt> ==
 
== <tt>org.eclipse.smila.processing.pipelets.xmlprocessing.XPathExtractorPipelet</tt> ==
Line 49: Line 39:
 
=== Description ===
 
=== Description ===
  
Pipelet that extracts elements selected by XPath, converts them in appropriate data types (Boolean, Double, String) and stores the transformed value in an attribute or attachment.
+
This pipelet extracts elements selected by XPath, converts them to appropriate data types (Boolean, Double, String), and stores the transformed value in an attribute or attachment.
  
 
=== Configuration ===
 
=== Configuration ===
Line 56: Line 46:
 
!Property!!Type!!Description
 
!Property!!Type!!Description
 
|-
 
|-
|inputType||String : ATTACHMENT, ATTRIBUTE||selects if the XML input is found in an attachment or attribute of the record
+
|''inputType''||String : ATTACHMENT, ATTRIBUTE||Defines whether the XML input is found in an attachment or in an attribute of the record.
 
|-
 
|-
|outputType||String : ATTACHMENT, ATTRIBUTE||selects if the transformed output should be stored in an attachment or attribute of the record
+
|''outputType''||String : ATTACHMENT, ATTRIBUTE||Defines whether the transformed output should be stored in an attachment or in an attribute of the record.
 
|-
 
|-
|inputName||String||name of input attachment or path to input attribute (process literals of attribute)
+
|''inputName''||String||The name of the input attachment or the path to the input attribute (process literals of attribute).
 
|-
 
|-
|outputName||String|| name of output attachment or path to output attribute (store result as literals of attribute)
+
|''outputName''||String||The name of the output attachment or the path to the output attribute (store result as literals of attribute).
 
|-
 
|-
|xpath||String||the XPATH to evaluate
+
|''xpath''||String||The XPath expression to be evaluated.
 
|-
 
|-
|seperator||String||the seperator (optional)
+
|''separator''||String||The optional separator.
 
|-
 
|-
|namespace||String||the XML namespace (optional)
+
|''namespace''||String||The optional XML namespace.
 
|}
 
|}
  
 
==== Example ====
 
==== Example ====
  
'''PipeletConfiguration for XPathExtractorPipelet'''
+
'''Pipelet configuration for XPathExtractorPipelet'''
 
<source lang="xml">
 
<source lang="xml">
<PipeletConfiguration xmlns="http://www.eclipse.org/smila/processor">
+
<proc:configuration>
<Property name="xpath" type="java.lang.String">
+
    <rec:Val key="inputType">ATTRIBUTE<rec:Val>
<Value>author/email</Value>
+
    <rec:Val key="outputType">ATTRIBUTE<rec:Val>
</Property>
+
    <rec:Val key="inputName">xmlIn<rec:Val>
<Property name="seperator" type="java.lang.String">
+
    <rec:Val key="outputName">xmlOut<rec:Val>
<Value></Value>
+
    <rec:Val key="xpath">author/email<rec:Val>
</Property>
+
    <rec:Val key="separator"><rec:Val>
<Property name="namespace" type="java.lang.String">
+
    <rec:Val key="namespace"><rec:Val>
<Value></Value>
+
</proc:configuration>
</Property>
+
<Property name="inputType" type="java.lang.String">
+
<Value>ATTRIBUTE</Value>
+
</Property>
+
<Property name="outputType" type="java.lang.String">
+
<Value>ATTRIBUTE</Value>
+
</Property>
+
<Property name="inputName" type="java.lang.String">
+
<Value>xmlIn</Value>
+
</Property>
+
<Property name="outputName" type="java.lang.String">
+
<Value>xmlOut</Value>
+
</Property>
+
</PipeletConfiguration>
+
 
</source>
 
</source>
  
Line 106: Line 82:
 
=== Description ===
 
=== Description ===
  
Pipelet that filters elements by XPath (either include or exclude mode) and stores the filtered elements as a new document in an attribute or attachment.
+
This pipelet filters elements by XPath expressions (either using include or exclude mode) and stores the filtered elements as a new document in an attribute or attachment.
  
 
=== Configuration ===
 
=== Configuration ===
Line 113: Line 89:
 
!Property!!Type!!Description
 
!Property!!Type!!Description
 
|-
 
|-
|inputType||String : ATTACHMENT, ATTRIBUTE||selects if the XML input is found in an attachment or attribute of the record
+
|''inputType''||String : ATTACHMENT, ATTRIBUTE||Defines whether the XML input is found in an attachment or in an attribute of the record.
 
|-
 
|-
|outputType||String : ATTACHMENT, ATTRIBUTE||selects if the transformed output should be stored in an attachment or attribute of the record
+
|''outputType''||String : ATTACHMENT, ATTRIBUTE||Defines whether the transformed output should be stored in an attachment or in an attribute of the record.
 
|-
 
|-
|inputName||String||name of input attachment or path to input attribute (process literals of attribute)
+
|''inputName''||String||The name of the input attachment or the path to the input attribute (process literals of attribute).
 
|-
 
|-
|outputName||String|| name of output attachment or path to output attribute (store result as literals of attribute)
+
|''outputName''||String||The name of the output attachment or the path to the output attribute (store result as literals of attribute).
 
|-
 
|-
|xpath||String||the XPATHs to evaluate (multivalue)
+
|''xpath''||String||The XPath expressions to be evaluated (multi-valued property).
 
|-
 
|-
|filterMode||String : INCLUDE, EXCLUDE||the filter mode, if to include or exclude the elements specified by xpath
+
|''filterMode''||String : INCLUDE, EXCLUDE||The filter mode, defining whether to include or exclude the elements matched by the XPath expressions.
 
|-
 
|-
|seperator||String||the seperator (optional)
+
|''separator''||String||The optional separator.
 
|-
 
|-
|namespace||String||the XML namespace (optional)
+
|''namespace''||String||The optional XML namespace.
 
|}
 
|}
  
==== Example ====
+
==== Examples ====
 +
 
 +
'''Pipelet configuration for XPathFilterPipelet with multi-valued xpath'''
 +
<source lang="xml">
 +
<proc:configuration>
 +
    <rec:Val key="inputType">ATTRIBUTE<rec:Val>
 +
    <rec:Val key="outputType">ATTRIBUTE<rec:Val>
 +
    <rec:Val key="inputName">xmlIn<rec:Val>
 +
    <rec:Val key="outputName">xmlOut<rec:Val>
 +
    <rec:Seq key="xpath">
 +
        <rec:Val>author/email<rec:Val>
 +
        <rec:Val>author/name<rec:Val>
 +
    </rec:Seq>
 +
    <rec:Val key="filterMode">EXCLUDE<rec:Val>
 +
    <rec:Val key="seperator"><rec:Val>
 +
    <rec:Val key="namespace"><rec:Val>
 +
</proc:configuration>
 +
</source>
  
'''PipeletConfiguration for XPathFilterPipelet'''
+
'''Pipelet configuration for XPathFilterPipelet with single-valued xpath'''
 
<source lang="xml">
 
<source lang="xml">
<PipeletConfiguration xmlns="http://www.eclipse.org/smila/processor">
+
<proc:configuration>
<Property name="xpath" type="java.lang.String">
+
    <rec:Val key="inputType">ATTRIBUTE<rec:Val>
<Value>author/name</Value>
+
    <rec:Val key="outputType">ATTRIBUTE<rec:Val>
</Property>
+
    <rec:Val key="inputName">xmlIn<rec:Val>
<Property name="xpath" type="java.lang.String">
+
    <rec:Val key="outputName">xmlOut<rec:Val>
<Value>author/email</Value>
+
    <rec:Val key="xpath">author/email<rec:Val>
</Property>
+
    <rec:Val key="filterMode">EXCLUDE<rec:Val>
<Property name="filterMode" type="java.lang.String">
+
    <rec:Val key="seperator"><rec:Val>
<Value>EXCLUDE</Value>
+
    <rec:Val key="namespace"><rec:Val>
</Property>
+
</proc:configuration>
<Property name="seperator" type="java.lang.String">
+
<Value></Value>
+
</Property>
+
<Property name="namespace" type="java.lang.String">
+
<Value></Value>
+
</Property>
+
<Property name="inputType" type="java.lang.String">
+
<Value>ATTRIBUTE</Value>
+
</Property>
+
<Property name="outputType" type="java.lang.String">
+
<Value>ATTRIBUTE</Value>
+
</Property>
+
<Property name="inputName" type="java.lang.String">
+
<Value>xmlIn</Value>
+
</Property>
+
<Property name="outputName" type="java.lang.String">
+
<Value>xmlOut</Value>
+
</Property>
+
</PipeletConfiguration>
+
 
</source>
 
</source>
  
Line 171: Line 145:
 
=== Description ===
 
=== Description ===
  
Pipelet that removes a selected element from an XML document and stores the remaining document in an attribute or attachment.
+
This pipelet removes a selected element from an XML document and stores the manipulated document in an attribute or attachment.
  
 
=== Configuration ===
 
=== Configuration ===
Line 178: Line 152:
 
!Property!!Type!!Description
 
!Property!!Type!!Description
 
|-
 
|-
|inputType||String : ATTACHMENT, ATTRIBUTE||selects if the XML input is found in an attachment or attribute of the record
+
|''inputType''||String : ATTACHMENT, ATTRIBUTE||Defines whether the XML input is found in an attachment or in an attribute of the record.
 
|-
 
|-
|outputType||String : ATTACHMENT, ATTRIBUTE||selects if the transformed output should be stored in an attachment or attribute of the record
+
|''outputType''||String : ATTACHMENT, ATTRIBUTE||Defines whether the transformed output should be stored in an attachment or in an attribute of the record.
 
|-
 
|-
|inputName||String||name of input attachment or path to input attribute (process literals of attribute)
+
|''inputName''||String||The name of the input attachment or the path to the input attribute (process literals of attribute).
 
|-
 
|-
|outputName||String|| name of output attachment or path to output attribute (store result as literals of attribute)
+
|''outputName''||String||The name of the output attachment or the path to the output attribute (store result as literals of attribute).
 
|-
 
|-
|elementId||String||the id of the XML element to remove
+
|''elementId''||String||The ID of the XML element to be removed.
 
|}
 
|}
  
 
==== Example ====
 
==== Example ====
  
'''PipeletConfiguration for RemoveElementFromXMLPipelet'''
+
'''Pipelet configuration for RemoveElementFromXMLPipelet'''
 
<source lang="xml">
 
<source lang="xml">
<PipeletConfiguration xmlns="http://www.eclipse.org/smila/processor">
+
<proc:configuration>
<Property name="elementId" type="java.lang.String">
+
    <rec:Val key="inputType">ATTRIBUTE<rec:Val>
<Value>1</Value>
+
    <rec:Val key="outputType">ATTRIBUTE<rec:Val>
</Property>
+
    <rec:Val key="inputName">xmlIn<rec:Val>
<Property name="inputType" type="java.lang.String">
+
    <rec:Val key="outputName">xmlOut<rec:Val>
<Value>ATTACHMENT</Value>
+
    <rec:Val key="elementId">title<rec:Val>
</Property>
+
</proc:configuration>
<Property name="outputType" type="java.lang.String">
+
<Value>ATTACHMENT</Value>
+
</Property>
+
<Property name="inputName" type="java.lang.String">
+
<Value>xmlIn</Value>
+
</Property>
+
<Property name="outputName" type="java.lang.String">
+
<Value>xmlOut</Value>
+
</Property>
+
</PipeletConfiguration>
+
 
</source>
 
</source>
  
Line 218: Line 182:
 
=== Description ===
 
=== Description ===
  
Pipelet that performs a Tidy transformation on an attribute or attachment value and stores the result in an attribute or attachment.
+
This pipelet performs a Tidy transformation on an attribute or attachment value and stores the result in an attribute or attachment.
  
 
=== Configuration ===
 
=== Configuration ===
Line 225: Line 189:
 
!Property!!Type!!Description
 
!Property!!Type!!Description
 
|-
 
|-
|inputType||String : ATTACHMENT, ATTRIBUTE||selects if the XML input is found in an attachment or attribute of the record
+
|''inputType''||String : ATTACHMENT, ATTRIBUTE||Defines whether the XML input is found in an attachment or in an attribute of the record.
 
|-
 
|-
|outputType||String : ATTACHMENT, ATTRIBUTE||selects if the transformed output should be stored in an attachment or attribute of the record
+
|''outputType''||String : ATTACHMENT, ATTRIBUTE||Defines whether the transformed output should be stored in an attachment or in an attribute of the record.
 
|-
 
|-
|inputName||String||name of input attachment or path to input attribute (process literals of attribute)
+
|''inputName''||String||The name of the input attachment or the path to the input attribute (process literals of attribute).
 
|-
 
|-
|outputName||String|| name of output attachment or path to output attribute (store result as literals of attribute)
+
|''outputName''||String||The name of the output attachment or the path to the output attribute (store result as literals of attribute).
 
|-
 
|-
|tidyFile||String||the name (with relative or absolute path) of the tidy configuration file to use
+
|''tidyFile''||String||The name (with relative or absolute path) of the Tidy configuration file to be used by the transformation.
 
|}
 
|}
  
 
==== Example ====
 
==== Example ====
  
'''PipeletConfiguration for TidyPipelet'''
+
'''Pipelet configuration for TidyPipelet'''
 
<source lang="xml">
 
<source lang="xml">
<PipeletConfiguration xmlns="http://www.eclipse.org/smila/processor">
+
<proc:configuration>
<Property name="tidyFile" type="java.lang.String">
+
    <rec:Val key="inputType">ATTRIBUTE<rec:Val>
<Value>./configuration/data/tidy_config.txt</Value>
+
    <rec:Val key="outputType">ATTRIBUTE<rec:Val>
</Property>
+
    <rec:Val key="inputName">xmlIn<rec:Val>
<Property name="inputType" type="java.lang.String">
+
    <rec:Val key="outputName">xmlOut<rec:Val>
<Value>ATTRIBUTE</Value>
+
    <rec:Val key="tidyFile">./configuration/data/tidy_config.txt<rec:Val>
</Property>
+
</proc:configuration>
<Property name="outputType" type="java.lang.String">
+
<Value>ATTRIBUTE</Value>
+
</Property>
+
<Property name="inputName" type="java.lang.String">
+
<Value>xmlIn</Value>
+
</Property>
+
<Property name="outputName" type="java.lang.String">
+
<Value>xmlOut</Value>
+
</Property>
+
</PipeletConfiguration>
+
 
</source>
 
</source>
 
 
 
  
 
== <tt>org.eclipse.smila.processing.pipelets.xmlprocessing.XmlSplitterPipelet</tt> ==
 
== <tt>org.eclipse.smila.processing.pipelets.xmlprocessing.XmlSplitterPipelet</tt> ==
Line 266: Line 217:
 
=== Description ===
 
=== Description ===
  
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.
+
This pipelet splits an 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 sent to the ConnectivityManager and are routed once more to the queue.
  
On each created record the Annotation <tt>MessageProperties</tt> is set with the key value pair <tt>isXmlSnippet</tt>=<tt>true</tt>. This can  be used in Listener rules to select for XML snippets to process.
+
On each created record the annotation <tt>MessageProperties</tt> is set with the key-value pair <tt>isXmlSnippet</tt>=<tt>true</tt>. This can  be used in Listener rules to select particular XML snippets for processing.
  
 
=== Configuration ===
 
=== Configuration ===
Line 275: Line 226:
 
!Property!!Type!!Description
 
!Property!!Type!!Description
 
|-
 
|-
|inputType||String : ATTACHMENT, ATTRIBUTE||selects if the XML input is found in an attachment or attribute of the record. An input Attribute is not interpreted as content but as a file path or an URL to the XML document.
+
|''inputType''||String : ATTACHMENT, ATTRIBUTE||Defines whether the XML input is found in an attachment or in an attribute of the record. An input attribute is not interpreted as to contain XML content itself but rather as a file path or an URL to the XML document.
 +
|-
 +
|''outputType''||String : ATTACHMENT, ATTRIBUTE||Defines whether the XML snippet should be stored in an attachment or in an attribute of the newly created record.  
 
|-
 
|-
|outputType||String : ATTACHMENT, ATTRIBUTE||selects if the XML snippet should be stored in an attachment or attribute of the newly created record
+
|''inputName''||String||The name of the input attachment or the path to the input attribute.
 
|-
 
|-
|inputName||String||name of input attachment or path to input attribute.
+
|''outputName''||String||The name of the output attachment or the path to the output attribute (store result as literals of attribute).  
 
|-
 
|-
|outputName||String|| name of output attachment or path to output attribute (store result as literals of attribute)
+
|''beginTagName''||String||The name of the tag to start the XML snippet with.
 
|-
 
|-
|beginTagName||String|| the name of the tag to start the xml snippet
+
|''isBeginClosingTag''||Boolean||A boolean flag defining whether ''beginTagName'' is a closing tag (true) or not (false).
 
|-
 
|-
|isBeginClosingTag||Boolean|| flag if the beginTagName is a closing tag (true) or not (false)
+
|''endTagName''||String||The name of the tag to end the xml snippet with.
 
|-
 
|-
|endTagName||String|| the name of the tag to end the xml snippet
+
|''isEndClosingTag''||Boolean||A boolean flag defining whether ''endTagName'' is a closing tag (true) or not (false).
 
|-
 
|-
isEndClosingTag||Boolean|| flag if the endTagName is a closing tag (true) or not (false)
+
|''keyTagName''||String||The name of the tag used to create a record ID.
 
|-
 
|-
|keyTagName||String|| the name of the tag used to create a record id
+
|''maxBufferSize''||Integer||The maximum size of the internal record buffer (optional, default is 20).
 
|-
 
|-
|maxBufferSize||Integer|| the maximum size of the internal record buffer (optional, default is 20)
+
|''idSeparator''||String||The separator used to create the record IDs of the split records (optional, default is "#").
 
|}
 
|}
  
 
==== Example ====
 
==== Example ====
  
'''PipeletConfiguration for XmlSplitterPipelet'''
+
'''Pipelet configuration for XmlSplitterPipelet'''
 
<source lang="xml">
 
<source lang="xml">
<PipeletConfiguration xmlns="http://www.eclipse.org/smila/processor">
+
<proc:configuration>
     <Property name="inputType" type="java.lang.String">
+
     <rec:Val key="inputType">ATTRIBUTE<rec:Val>
        <Value>ATTRIBUTE</Value>
+
     <rec:Val key="outputType">ATTRIBUTE<rec:Val>
     </Property>      
+
     <rec:Val key="inputName">xmlIn<rec:Val>
    <Property name="outputType" type="java.lang.String">
+
     <rec:Val key="outputName">xmlOut<rec:Val>
        <Value>ATTRIBUTE</Value>
+
     <rec:Val key="beginTagName">document<rec:Val>
     </Property>
+
     <rec:Val key="isBeginClosingTag">false<rec:Val>
    <Property name="inputName" type="java.lang.String">
+
     <rec:Val key="endTagName">document<rec:Val>
        <Value>Path</Value>
+
     <rec:Val key="isEndClosingTag">true<rec:Val>
     </Property>
+
     <rec:Val key="keyTagName">docId<rec:Val>
    <Property name="outputName" type="java.lang.String">
+
     <rec:Val key="idSeparator">#<rec:Val>
        <Value>Content</Value>
+
</proc:configuration>
     </Property>
+
    <Property name="beginTagName" type="java.lang.String">
+
        <Value>doc</Value>
+
     </Property>
+
    <Property name="isBeginClosingTag" type="java.lang.Boolean">
+
        <Value>false</Value>
+
     </Property>
+
    <Property name="endTagName" type="java.lang.String">
+
        <Value>doc</Value>
+
     </Property>
+
    <Property name="isEndClosingTag" type="java.lang.Boolean">
+
        <Value>true</Value>
+
     </Property>
+
    <Property name="keyTagName" type="java.lang.String">
+
        <Value>docId</Value>
+
     </Property>
+
</PipeletConfiguration>
+
 
</source>
 
</source>
  
  
The former configuration would split the following XML format
+
The above configuration would split this XML format:
 
<source lang="xml">
 
<source lang="xml">
 
<sampleCollection>
 
<sampleCollection>
Line 350: Line 286:
 
</source>
 
</source>
  
into XML snippets like this one
+
into XML snippets like this one:
 
<source lang="xml">
 
<source lang="xml">
 
<document>
 
<document>
Line 360: Line 296:
 
</source>
 
</source>
  
And each for each snippet a record would be created:
+
And for each snippet a record would be created:
  
 
<source lang="xml">
 
<source lang="xml">
<Record version="1.0">
+
<Record xmlns="http://www.eclipse.org/smila/record" version="2.0">
  <Id version="1.0" xmlns="http://www.eclipse.org/smila/id">
+
  <Val key="_recordid">xmlsplitter:someBigXmlfile.xml#4711</Val>
    < Source>xmlsplitter</ Source>
+
  <Val key="_source">xmlsplitter</Val>
    <Key name="Path">someeBigXmlfile.xml</Key>
+
   <Map key="_messageProperties">  
    <id:Fragment>4711</id:Fragment>
+
       <Val key="isXmlSnippet">true</Val>
   </Id> 
+
   </Map
  <A n="MessageProperties">
+
   <Val key="xmlOut">
       <V n="isXmlSnippet">true</V>
+
        <document>
   </A>
+
   <A n="Content">
+
    <L>
+
      <V>
+
        <document>
+
 
             <docId>4711</docId>
 
             <docId>4711</docId>
 
             <title>Some title</title>
 
             <title>Some title</title>
Line 381: Line 312:
 
             <text>Some text</text>
 
             <text>Some text</text>
 
         </document>   
 
         </document>   
      </V>
+
   </Val>
    </L>
+
   </A>  
+
 
</Record>  
 
</Record>  
 
</source>
 
</source>

Revision as of 10:25, 20 April 2011

org.eclipse.smila.processing.pipelets.xmlprocessing.XslTransformationPipelet

Description

This pipelet performs an XSL transformation on an attribute or attachment value and stores the transformed document in an attribute or attachment.

Configuration

Property Type Description
inputType String : ATTACHMENT, ATTRIBUTE Defines whether the XML input is found in an attachment or in an attribute of the record.
outputType String : ATTACHMENT, ATTRIBUTE Defines whether the transformed output should be stored in an attachment or in an attribute of the record.
inputName String The name of the input attachment or the path to the input attribute (process literals of attribute).
outputName String The name of the output attachment or the path to the output attribute (store result as literals of attribute).
xslFile String The name (with relative or absolute path) of the XSL file to be used for transformation.

Example

Pipelet configuration for XslTransformationPipelet

<proc:configuration>
    <rec:Val key="inputType">ATTRIBUTE<rec:Val>
    <rec:Val key="outputType">ATTRIBUTE<rec:Val>
    <rec:Val key="inputName">xmlIn<rec:Val>
    <rec:Val key="outputName">xmlOut<rec:Val>
    <rec:Val key="xslFile">./configuration/data/author.xsl<rec:Val>
</proc:configuration>

org.eclipse.smila.processing.pipelets.xmlprocessing.XPathExtractorPipelet

Description

This pipelet extracts elements selected by XPath, converts them to appropriate data types (Boolean, Double, String), and stores the transformed value in an attribute or attachment.

Configuration

Property Type Description
inputType String : ATTACHMENT, ATTRIBUTE Defines whether the XML input is found in an attachment or in an attribute of the record.
outputType String : ATTACHMENT, ATTRIBUTE Defines whether the transformed output should be stored in an attachment or in an attribute of the record.
inputName String The name of the input attachment or the path to the input attribute (process literals of attribute).
outputName String The name of the output attachment or the path to the output attribute (store result as literals of attribute).
xpath String The XPath expression to be evaluated.
separator String The optional separator.
namespace String The optional XML namespace.

Example

Pipelet configuration for XPathExtractorPipelet

<proc:configuration>
    <rec:Val key="inputType">ATTRIBUTE<rec:Val>
    <rec:Val key="outputType">ATTRIBUTE<rec:Val>
    <rec:Val key="inputName">xmlIn<rec:Val>
    <rec:Val key="outputName">xmlOut<rec:Val>
    <rec:Val key="xpath">author/email<rec:Val>
    <rec:Val key="separator"><rec:Val>
    <rec:Val key="namespace"><rec:Val>
</proc:configuration>

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

Description

This pipelet filters elements by XPath expressions (either using include or exclude mode) and stores the filtered elements as a new document in an attribute or attachment.

Configuration

Property Type Description
inputType String : ATTACHMENT, ATTRIBUTE Defines whether the XML input is found in an attachment or in an attribute of the record.
outputType String : ATTACHMENT, ATTRIBUTE Defines whether the transformed output should be stored in an attachment or in an attribute of the record.
inputName String The name of the input attachment or the path to the input attribute (process literals of attribute).
outputName String The name of the output attachment or the path to the output attribute (store result as literals of attribute).
xpath String The XPath expressions to be evaluated (multi-valued property).
filterMode String : INCLUDE, EXCLUDE The filter mode, defining whether to include or exclude the elements matched by the XPath expressions.
separator String The optional separator.
namespace String The optional XML namespace.

Examples

Pipelet configuration for XPathFilterPipelet with multi-valued xpath

<proc:configuration>
    <rec:Val key="inputType">ATTRIBUTE<rec:Val>
    <rec:Val key="outputType">ATTRIBUTE<rec:Val>
    <rec:Val key="inputName">xmlIn<rec:Val>
    <rec:Val key="outputName">xmlOut<rec:Val>
    <rec:Seq key="xpath">
        <rec:Val>author/email<rec:Val>
        <rec:Val>author/name<rec:Val>
    </rec:Seq>
    <rec:Val key="filterMode">EXCLUDE<rec:Val>
    <rec:Val key="seperator"><rec:Val>
    <rec:Val key="namespace"><rec:Val>
</proc:configuration>

Pipelet configuration for XPathFilterPipelet with single-valued xpath

<proc:configuration>
    <rec:Val key="inputType">ATTRIBUTE<rec:Val>
    <rec:Val key="outputType">ATTRIBUTE<rec:Val>
    <rec:Val key="inputName">xmlIn<rec:Val>
    <rec:Val key="outputName">xmlOut<rec:Val>
    <rec:Val key="xpath">author/email<rec:Val>
    <rec:Val key="filterMode">EXCLUDE<rec:Val>
    <rec:Val key="seperator"><rec:Val>
    <rec:Val key="namespace"><rec:Val>
</proc:configuration>

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

Description

This pipelet removes a selected element from an XML document and stores the manipulated document in an attribute or attachment.

Configuration

Property Type Description
inputType String : ATTACHMENT, ATTRIBUTE Defines whether the XML input is found in an attachment or in an attribute of the record.
outputType String : ATTACHMENT, ATTRIBUTE Defines whether the transformed output should be stored in an attachment or in an attribute of the record.
inputName String The name of the input attachment or the path to the input attribute (process literals of attribute).
outputName String The name of the output attachment or the path to the output attribute (store result as literals of attribute).
elementId String The ID of the XML element to be removed.

Example

Pipelet configuration for RemoveElementFromXMLPipelet

<proc:configuration>
    <rec:Val key="inputType">ATTRIBUTE<rec:Val>
    <rec:Val key="outputType">ATTRIBUTE<rec:Val>
    <rec:Val key="inputName">xmlIn<rec:Val>
    <rec:Val key="outputName">xmlOut<rec:Val>
    <rec:Val key="elementId">title<rec:Val>
</proc:configuration>

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

Description

This pipelet performs a Tidy transformation on an attribute or attachment value and stores the result in an attribute or attachment.

Configuration

Property Type Description
inputType String : ATTACHMENT, ATTRIBUTE Defines whether the XML input is found in an attachment or in an attribute of the record.
outputType String : ATTACHMENT, ATTRIBUTE Defines whether the transformed output should be stored in an attachment or in an attribute of the record.
inputName String The name of the input attachment or the path to the input attribute (process literals of attribute).
outputName String The name of the output attachment or the path to the output attribute (store result as literals of attribute).
tidyFile String The name (with relative or absolute path) of the Tidy configuration file to be used by the transformation.

Example

Pipelet configuration for TidyPipelet

<proc:configuration>
    <rec:Val key="inputType">ATTRIBUTE<rec:Val>
    <rec:Val key="outputType">ATTRIBUTE<rec:Val>
    <rec:Val key="inputName">xmlIn<rec:Val>
    <rec:Val key="outputName">xmlOut<rec:Val>
    <rec:Val key="tidyFile">./configuration/data/tidy_config.txt<rec:Val>
</proc:configuration>

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

Description

This pipelet splits an 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 sent 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 particular XML snippets for processing.

Configuration

Property Type Description
inputType String : ATTACHMENT, ATTRIBUTE Defines whether the XML input is found in an attachment or in an attribute of the record. An input attribute is not interpreted as to contain XML content itself but rather as a file path or an URL to the XML document.
outputType String : ATTACHMENT, ATTRIBUTE Defines whether the XML snippet should be stored in an attachment or in an attribute of the newly created record.
inputName String The name of the input attachment or the path to the input attribute.
outputName String The name of the output attachment or the path to the output attribute (store result as literals of attribute).
beginTagName String The name of the tag to start the XML snippet with.
isBeginClosingTag Boolean A boolean flag defining whether beginTagName is a closing tag (true) or not (false).
endTagName String The name of the tag to end the xml snippet with.
isEndClosingTag Boolean A boolean flag defining whether endTagName is a closing tag (true) or not (false).
keyTagName String The name of the tag used to create a record ID.
maxBufferSize Integer The maximum size of the internal record buffer (optional, default is 20).
idSeparator String The separator used to create the record IDs of the split records (optional, default is "#").

Example

Pipelet configuration for XmlSplitterPipelet

<proc:configuration>
    <rec:Val key="inputType">ATTRIBUTE<rec:Val>
    <rec:Val key="outputType">ATTRIBUTE<rec:Val>
    <rec:Val key="inputName">xmlIn<rec:Val>
    <rec:Val key="outputName">xmlOut<rec:Val>
    <rec:Val key="beginTagName">document<rec:Val>
    <rec:Val key="isBeginClosingTag">false<rec:Val>
    <rec:Val key="endTagName">document<rec:Val>
    <rec:Val key="isEndClosingTag">true<rec:Val>
    <rec:Val key="keyTagName">docId<rec:Val>
    <rec:Val key="idSeparator">#<rec:Val>
</proc:configuration>


The above configuration would split this XML format:

<sampleCollection>
    ...
    <document>
        <docId>4711</docId>
        <title>Some title</title>
        ...
        <text>Some text</text>
    </document>
    <document>
        <docId>0815</docId>  
        ...
    </document>
    ...
</sampleCollection>

into XML snippets like this one:

<document>
    <docId>4711</docId>
    <title>Some title</title>
    ...
    <text>Some text</text>
</document>

And for each snippet a record would be created:

<Record xmlns="http://www.eclipse.org/smila/record" version="2.0">
  <Val key="_recordid">xmlsplitter:someBigXmlfile.xml#4711</Val>
  <Val key="_source">xmlsplitter</Val>
  <Map key="_messageProperties"> 
      <Val key="isXmlSnippet">true</Val>
  </Map
  <Val key="xmlOut">
         <document>
            <docId>4711</docId>
            <title>Some title</title>
            ...
            <text>Some text</text>
        </document>   
  </Val>
</Record>


The Listener rules to split the XML files and to process the XML snippets could look like this:

 <Rule Name="Splitter Rule" WaitMessageTimeout="10" Threads="2" MaxMessageBlockSize="1">
    <Source BrokerId="broker1" Queue="SMILA.connectivity"/>
    <Condition>Operation='ADD' and DataSourceID LIKE '%xmlsplitting%' and NOT(isXmlSnippet='true')</Condition>
    <Task>
      <Process Workflow="SplitterPipeline"/>
    </Task>
  </Rule>    
 
 <Rule Name="Snippet Rule" WaitMessageTimeout="10" Threads="4" MaxMessageBlockSize="20">
    <Source BrokerId="broker1" Queue="SMILA.connectivity"/>
    <Condition>Operation='ADD' and DataSourceID LIKE '%xmlsplitting%' and isXmlSnippet='true'</Condition>
    <Task>
      <Process Workflow="Snippetipeline"/>
    </Task>
  </Rule>