stm:rename

Home > Books > Tutorials and Training Guides > STM Language > stm:rename

Attribute
xpath	required the target xpath into the operand document
select	optional an unambiguous xpath into the child document fragment contained by the stm:set element

The stm:rename operation renames an element located by an xpath. The children of the renamed element are unaffected and remain children of the renamed element. The new name is the value at the select xpath location of the enclosed document.

stm:rename is namespace aware and will retain the namespace prefix and namespace URI of the orginal element.

Due to limitations of the W3C DOM model renaming can be a relatively expensive operation.

Example

Example 1: Rename an element
This example renames all the <b> elements to <equine>.
<idoc>
  <seq>
    <instr>
      <type>stm</type>
      <operand>doc.xml</operand>
      <operator>
        <stm:group xmlns:stm="http://1060.org/stm">
          <stm:rename xpath="/a/b"> equine </stm:rename>
        </stm:group>
      </operator>
      <target>this:response</target>
    </instr>
  </seq>
</idoc>
Try it

Example 2: Namespace aware Rename
This example demonstrates renaming an element that has a namespace. First we use stm:apply-ns to apply the animals namespace to all elements of our example document. Secondly we rename the element <animals:b> to equine. The namespace prefix and URI are preserved.
<idoc>
  <seq>
    <instr>
      <type>stm</type>
      <operand>doc.xml</operand>
      <operator>
        <stm:group xmlns:stm="http://1060.org/stm">
          <stm:apply-ns prefix="animals" uri="http://1060.org/test" xpath="/a" />
          <stm:rename select="." xpath="/animals:a/animals:b"> equine </stm:rename>
        </stm:group>
      </operator>
      <target>this:response</target>
    </instr>
  </seq>
</idoc>
Try it