Class DOMResult

  • All Implemented Interfaces:
    Result

    public class DOMResult
    extends java.lang.Object
    implements Result

    Acts as a holder for a transformation result tree in the form of a Document Object Model (DOM) tree.

    If no output DOM source is set, the transformation will create a Document node as the holder for the result of the transformation, which may be retrieved with getNode().

    Version:
    $Revision: 569995 $, $Date: 2007-08-27 07:31:06 +0300 (Mon, 27 Aug 2007) $
    Author:
    Jeff Suttor
    • Constructor Summary

      Constructors 
      Constructor Description
      DOMResult()
      Zero-argument default constructor.
      DOMResult​(Node node)
      Use a DOM node to create a new output target.
      DOMResult​(Node node, java.lang.String systemId)
      Use a DOM node to create a new output target with the specified System ID.
      DOMResult​(Node node, Node nextSibling)
      Use a DOM node to create a new output target specifying the child node where the result nodes should be inserted before.
      DOMResult​(Node node, Node nextSibling, java.lang.String systemId)
      Use a DOM node to create a new output target specifying the child node where the result nodes should be inserted before and the specified System ID.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Node getNextSibling()
      Get the child node before which the result nodes will be inserted.
      Node getNode()
      Get the node that will contain the result DOM tree.
      java.lang.String getSystemId()
      Get the System Identifier.
      void setNextSibling​(Node nextSibling)
      Set the child node before which the result nodes will be inserted.
      void setNode​(Node node)
      Set the node that will contain the result DOM tree.
      void setSystemId​(java.lang.String systemId)
      Set the systemId that may be used in association with the node.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DOMResult

        public DOMResult()

        Zero-argument default constructor.

        node, siblingNode and systemId will be set to null.

      • DOMResult

        public DOMResult​(Node node)

        Use a DOM node to create a new output target.

        In practice, the node should be a Document node, a DocumentFragment node, or a Element node. In other words, a node that accepts children.

        siblingNode and systemId will be set to null.

        Parameters:
        node - The DOM node that will contain the result tree.
      • DOMResult

        public DOMResult​(Node node,
                         java.lang.String systemId)

        Use a DOM node to create a new output target with the specified System ID.

        In practice, the node should be a Document node, a DocumentFragment node, or a Element node. In other words, a node that accepts children.

        siblingNode will be set to null.

        Parameters:
        node - The DOM node that will contain the result tree.
        systemId - The system identifier which may be used in association with this node.
      • DOMResult

        public DOMResult​(Node node,
                         Node nextSibling)

        Use a DOM node to create a new output target specifying the child node where the result nodes should be inserted before.

        In practice, node and nextSibling should be a Document node, a DocumentFragment node, or a Element node. In other words, a node that accepts children.

        Use nextSibling to specify the child node where the result nodes should be inserted before. If nextSibling is not a sibling of node, then an IllegalArgumentException is thrown. If node is null and nextSibling is not null, then an IllegalArgumentException is thrown. If nextSibling is null, then the behavior is the same as calling DOMResult(Node node), i.e. append the result nodes as the last child of the specified node.

        systemId will be set to null.

        Parameters:
        node - The DOM node that will contain the result tree.
        nextSibling - The child node where the result nodes should be inserted before.
        Throws:
        java.lang.IllegalArgumentException - If nextSibling is not a sibling of node.
        java.lang.IllegalArgumentException - If node is null and nextSibling is not null.
        Since:
        1.5
      • DOMResult

        public DOMResult​(Node node,
                         Node nextSibling,
                         java.lang.String systemId)

        Use a DOM node to create a new output target specifying the child node where the result nodes should be inserted before and the specified System ID.

        In practice, node and nextSibling should be a Document node, a DocumentFragment node, or a Element node. In other words, a node that accepts children.

        Use nextSibling to specify the child node where the result nodes should be inserted before. If nextSibling is not a sibling of node, then an IllegalArgumentException is thrown. If node is null and nextSibling is not null, then an IllegalArgumentException is thrown. If nextSibling is null, then the behavior is the same as calling DOMResult(Node node, String systemId), i.e. append the result nodes as the last child of the specified node and use the specified System ID.

        Parameters:
        node - The DOM node that will contain the result tree.
        nextSibling - The child node where the result nodes should be inserted before.
        systemId - The system identifier which may be used in association with this node.
        Throws:
        java.lang.IllegalArgumentException - If nextSibling is not a sibling of node.
        java.lang.IllegalArgumentException - If node is null and nextSibling is not null.
        Since:
        1.5
    • Method Detail

      • setNode

        public void setNode​(Node node)

        Set the node that will contain the result DOM tree.

        In practice, the node should be a Document node, a DocumentFragment node, or a Element node. In other words, a node that accepts children.

        An IllegalStateException is thrown if nextSibling is not null and node is not a parent of nextSibling. An IllegalStateException is thrown if node is null and nextSibling is not null.

        Parameters:
        node - The node to which the transformation will be appended.
        Throws:
        java.lang.IllegalStateException - If nextSibling is not null and nextSibling is not a child of node.
        java.lang.IllegalStateException - If node is null and nextSibling is not null.
      • setNextSibling

        public void setNextSibling​(Node nextSibling)

        Set the child node before which the result nodes will be inserted.

        Use nextSibling to specify the child node before which the result nodes should be inserted. If nextSibling is not a descendant of node, then an IllegalArgumentException is thrown. If node is null and nextSibling is not null, then an IllegalStateException is thrown. If nextSibling is null, then the behavior is the same as calling DOMResult(Node node), i.e. append the result nodes as the last child of the specified node.

        Parameters:
        nextSibling - The child node before which the result nodes will be inserted.
        Throws:
        java.lang.IllegalArgumentException - If nextSibling is not a descendant of node.
        java.lang.IllegalStateException - If node is null and nextSibling is not null.
        Since:
        1.5
      • setSystemId

        public void setSystemId​(java.lang.String systemId)

        Set the systemId that may be used in association with the node.

        Specified by:
        setSystemId in interface Result
        Parameters:
        systemId - The system identifier as a URI string.