libjava/javax/xml/transform/dom/DOMResult.java

   1 /* DOMResult.java --
   2    Copyright (C) 2004, 2005  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package javax.xml.transform.dom;
  39
  40 import javax.xml.transform.Result;
  41 import org.w3c.dom.Node;
  42
  43 /**
  44  * Output result specified as a W3C DOM object graph.
  45  * The result tree may be appended to an existing tree.
  46  * If no target node is specified, the result tree will be made available by
  47  * the {@link #getNode} method after the transformation.
  48  *
  49  * @author (a href='mailto:dog@gnu.org'>Chris Burdess</a)
  50  */
  51 public class DOMResult
  52   implements Result
  53 {
  54
  55   /**
  56    * Factory feature indicating that DOM results are supported.
  57    */
  58   public static final String FEATURE =
  59     "http://javax.xml.transform.dom.DOMResult/feature";
  60
  61   private Node node;
  62   private Node nextSibling;
  63   private String systemId;
  64
  65   /**
  66    * Default constructor.
  67    */
  68   public DOMResult()
  69   {
  70     this(null, null, null);
  71   }
  72
  73   /**
  74    * Constructor with the node to append to.
  75    */
  76   public DOMResult(Node node)
  77   {
  78     this(node, null, null);
  79   }
  80
  81   /**
  82    * Constructor with the node to append to and the child node before which
  83    * the result should be appended.
  84    * @since 1.3
  85    */
  86   public DOMResult(Node node, Node nextSibling)
  87   {
  88     this(node, nextSibling, null);
  89   }
  90
  91   /**
  92    * Constructor with the node to append to and the system ID.
  93    */
  94   public DOMResult(Node node, String systemID)
  95   {
  96     this(node, null, systemID);
  97   }
  98
  99   /**
 100    * Constructor with the node to append to, the child node before which
 101    * the result should be appended, and the system ID.
 102    * @since 1.3
 103    */
 104   public DOMResult(Node node, Node nextSibling, String systemID)
 105   {
 106     this.node = node;
 107     this.nextSibling = nextSibling;
 108     this.systemId = systemID;
 109   }
 110
 111   /**
 112    * Sets the node to which the result tree will be appended.
 113    * @param node the node
 114    */
 115   public void setNode(Node node)
 116   {
 117     this.node = node;
 118   }
 119
 120   /**
 121    * Returns the node to which the result tree is to be appended,
 122    * or the result tree after transformation if no node was previously set.
 123    */
 124   public Node getNode()
 125   {
 126     return node;
 127   }
 128
 129   /**
 130    * Sets the child node before which the result nodes will be inserted.
 131    * @since 1.3
 132    */
 133   public void setNextSibling(Node nextSibling)
 134   {
 135     this.nextSibling = nextSibling;
 136   }
 137
 138   /**
 139    * Returns the child node before which the result nodes will be inserted.
 140    * @since 1.3
 141    */
 142   public Node getNextSibling()
 143   {
 144     return nextSibling;
 145   }
 146
 147   /**
 148    * Sets the system ID used to resolve external entities.
 149    */
 150   public void setSystemId(String systemId)
 151   {
 152     this.systemId = systemId;
 153   }
 154
 155   /**
 156    * Returns the system ID used to resolve external entities.
 157    */
 158   public String getSystemId()
 159   {
 160     return systemId;
 161   }
 162
 163 }