2.287 .root

This attribute defines the position, where the transformation in a XML tree or in an IDM object hierarchy started. Therefore the value of the attribute is only meaningful during a transformation (i.e. during invocation of the :apply() method). Otherwise, the value should be null.

Definition

  • Data type

    string, object

  • Access

    get, set

  • changed event

    no

  • C

    Identifier: AT_root

    Data type: DT_string, DT_object

  • COBOL

    Identifier: AT-root

    Data type: DT-string, DT-object

  • Classification

    object-specific attribute

  • Objects

    transformer

In its default implementation, the :apply() method of the transformer sets this attribute as follows:

  • If a document object is transferred in the Src parameter, .root is assigned an empty string "", which represents the root of the document.
  • If a doccursor object is transferred, .root is assigned a string that determines the position in the XML tree to which the doccursor points, i.e. .root := Src.path.
  • If a different IDM object is transferred, .root is assigned this object itself.

When leaving the :apply() method, .root is set to null.