dojox/wire/XmlWire.js

• Provides:

  • dojox.wire.XmlWire

• Requires:

  • dojox.xml.parser in common
  • dojox.wire.Wire in common

• dojox.wire.XmlWire

  • type

    Function

  • chains:
    • dojox.wire.Wire: (prototype)
    • dojox.wire.Wire: (call)
  • parameters:
    • args: (typeof Object)

      Arguments to initialize properties
      path:
      A simplified XPath to an attribute, a text or elements

  • summary

    A Wire for XML nodes or values (element, attribute and text)

  • description

    This class accesses XML nodes or value with a simplified XPath
    specified to 'path' property.
    The root object for this class must be an DOM document or element
    node.
    "@name" accesses to an attribute value of an element and "text()"
    accesses to a text value of an element.
    The hierarchy of the elements from the root node can be specified
    with slash-separated list, such as "a/b/@c", which specifies
    the value of an attribute named "c" of an element named "b" as
    a child of another element named "a" of a child of the root node.

• dojox.wire.XmlWire._wireClass

  • type

    String

• dojox.wire.XmlWire.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • args: (typeof Object)

      Arguments to initialize properties
      path:
      A simplified XPath to an attribute, a text or elements

  • summary

    Initialize properties

  • description

    'args' is just mixed in with no further processing.

• dojox.wire.XmlWire._getValue

  • parameters:
    • object: (typeof Node)

      A root node

  • returns

    Node|undefined|String||Array

  • summary

    Return an attribute value, a text value or an array of elements

  • description

    This method first uses a root node passed in 'object' argument
    and 'path' property to identify an attribute, a text or
    elements.
    If 'path' starts with a slash (absolute), the first path
    segment is ignored assuming it point to the root node.
    (That is, "/a/b/@c" and "b/@c" against a root node access
    the same attribute value, assuming the root node is an element
    with a tag name, "a".)

  • return_summary

    A value found, otherwise 'undefined'

  • type

    Function

• dojox.wire.XmlWire._setValue

  • parameters:
    • object: (typeof Node)

      A root node

    • value: (typeof String)

      A value to set

  • returns

    Node|undefined

  • summary

    Set an attribute value or a child text value to an element

  • description

    This method first uses a root node passed in 'object' argument
    and 'path' property to identify an attribute, a text or
    elements.
    If an intermediate element does not exist, it creates
    an element of the tag name in the 'path' segment as a child
    node of the current node.
    Finally, 'value' argument is set to an attribute or a text
    (a child node) of the leaf element.

  • type

    Function

• dojox.wire.XmlWire._getNodeValue

  • parameters:
    • node: (typeof Node)

      A node

    • exp: (typeof String)

      An expression for attribute, text or elements

  • returns

    String||Array

  • summary

    Return an attribute value, a text value or an array of elements

  • description

    If 'exp' starts with '@', an attribute value of the specified
    attribute is returned.
    If 'exp' is "text()", a child text value is returned.
    Otherwise, an array of child elements, the tag name of which
    match 'exp', is returned.

  • return_summary

    A value found, otherwise 'undefined'

  • type

    Function

• dojox.wire.XmlWire._setNodeValue

  • parameters:
    • node: (typeof Node)

      A node

    • exp: (typeof String)

      An expression for attribute or text

    • value: (typeof String)

      A value to set

  • summary

    Set an attribute value or a child text value to an element

  • description

    If 'exp' starts with '@', 'value' is set to the specified
    attribute.
    If 'exp' is "text()", 'value' is set to a child text.

  • type

    Function

• dojox.wire.XmlWire._getChildNode

  • parameters:
    • node: (typeof Node)

      A parent node

    • name: (typeof String)

      A tag name

  • returns

    Node|null

  • summary

    Return a child node

  • description

    A child element of the tag name specified with 'name' is
    returned.
    If 'name' ends with an array index, it is used to pick up
    the corresponding element from multiple child elements.

  • return_summary

    A child node

  • type

    Function

• dojox.wire.XmlWire._getDocument

  • parameters:
    • node: (typeof Node)
  • returns

    Document

  • summary

    Return a DOM document

  • description

    If 'node' is specified, a DOM document of the node is returned.
    Otherwise, a DOM document is created.

  • return_summary

    A DOM document

  • type

    Function

• dojox.wire

  • type

    Object

• dojox

  • type

    Object