1. /*

  2.  * The Apache Software License, Version 1.1

  3.  *

  4.  *

  5.  * Copyright (c) 1999 The Apache Software Foundation.  All rights 

  6.  * reserved.

  7.  *

  8.  * Redistribution and use in source and binary forms, with or without

  9.  * modification, are permitted provided that the following conditions

  10.  * are met:

  11.  *

  12.  * 1. Redistributions of source code must retain the above copyright

  13.  *    notice, this list of conditions and the following disclaimer. 

  14.  *

  15.  * 2. Redistributions in binary form must reproduce the above copyright

  16.  *    notice, this list of conditions and the following disclaimer in

  17.  *    the documentation and/or other materials provided with the

  18.  *    distribution.

  19.  *

  20.  * 3. The end-user documentation included with the redistribution,

  21.  *    if any, must include the following acknowledgment:  

  22.  *       "This product includes software developed by the

  23.  *        Apache Software Foundation (http://www.apache.org/)."

  24.  *    Alternately, this acknowledgment may appear in the software itself,

  25.  *    if and wherever such third-party acknowledgments normally appear.

  26.  *

  27.  * 4. The names "Xalan" and "Apache Software Foundation" must

  28.  *    not be used to endorse or promote products derived from this

  29.  *    software without prior written permission. For written 

  30.  *    permission, please contact apache@apache.org.

  31.  *

  32.  * 5. Products derived from this software may not be called "Apache",

  33.  *    nor may "Apache" appear in their name, without prior written

  34.  *    permission of the Apache Software Foundation.

  35.  *

  36.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED

  37.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES

  38.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

  39.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR

  40.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

  41.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

  42.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

  43.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

  44.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

  45.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT

  46.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

  47.  * SUCH DAMAGE.

  48.  * ====================================================================

  49.  *

  50.  * This software consists of voluntary contributions made by many

  51.  * individuals on behalf of the Apache Software Foundation and was

  52.  * originally based on software copyright (c) 1999, Lotus

  53.  * Development Corporation., http://www.lotus.com.  For more

  54.  * information on the Apache Software Foundation, please see

  55.  * <http://www.apache.org/>.

  56.  */

  57. package org.apache.xalan.transformer;

  58. 

  59. import org.apache.xalan.templates.Stylesheet;

  60. 

  61. import org.apache.xml.dtm.DTM;

  62. import org.apache.xml.dtm.DTMIterator;

  63. import org.apache.xml.dtm.DTMFilter;

  64. import org.apache.xml.utils.XMLString;

  65. 

  66. import javax.xml.transform.TransformerException;

  67. import org.xml.sax.Attributes;

  68. 

  69. import org.apache.xpath.XPathContext;

  70. import org.apache.xalan.res.XSLTErrorResources;

  71. 

  72. /**

  73.  * <meta name="usage" content="internal"/>

  74.  * Class used to clone a node, possibly including its children to 

  75.  * a result tree.

  76.  */

  77. public class ClonerToResultTree

  78. {

  79. 

  80.   /** Result tree handler for the cloned tree           */

  81.   private ResultTreeHandler m_rth;

  82. 

  83.   /** Transformer instance to use for cloning          */

  84.   private TransformerImpl m_transformer;

  85. 

  86.   /**

  87.    * Constructor ClonerToResultTree

  88.    *

  89.    *

  90.    * @param transformer non-null transformer instance to use for the cloning

  91.    * @param rth non-null result tree handler for the cloned tree

  92.    */

  93.   public ClonerToResultTree(TransformerImpl transformer,

  94.                             ResultTreeHandler rth)

  95.   {

  96.     m_rth = rth;

  97.     m_transformer = transformer;

  98.   }

  99. 

  100. //  /**

  101. //   * Clone an element with or without children.

  102. //   * TODO: Fix or figure out node clone failure!

  103. //   * the error condition is severe enough to halt processing.

  104. //   *

  105. //   * @param node The node to clone

  106. //   * @param shouldCloneAttributes Flag indicating whether to 

  107. //   * clone children attributes

  108. //   * 

  109. //   * @throws TransformerException

  110. //   */

  111. //  public void cloneToResultTree(int node, boolean shouldCloneAttributes)

  112. //    throws TransformerException

  113. //  {

  114. //

  115. //    try

  116. //    {

  117. //      XPathContext xctxt = m_transformer.getXPathContext();

  118. //      DTM dtm = xctxt.getDTM(node);

  119. //

  120. //      int type = dtm.getNodeType(node);

  121. //      switch (type)

  122. //      {

  123. //      case DTM.TEXT_NODE :

  124. //        dtm.dispatchCharactersEvents(node, m_rth, false);

  125. //        break;

  126. //      case DTM.DOCUMENT_FRAGMENT_NODE :

  127. //      case DTM.DOCUMENT_NODE :

  128. //

  129. //        // Can't clone a document, but refrain from throwing an error

  130. //        // so that copy-of will work

  131. //        break;

  132. //      case DTM.ELEMENT_NODE :

  133. //        {

  134. //          Attributes atts;

  135. //

  136. //          if (shouldCloneAttributes)

  137. //          {

  138. //            m_rth.addAttributes(node);

  139. //            m_rth.processNSDecls(node, type, dtm);

  140. //          }

  141. //

  142. //          String ns = dtm.getNamespaceURI(node);

  143. //          String localName = dtm.getLocalName(node);

  144. //

  145. //          m_rth.startElement(ns, localName, dtm.getNodeNameX(node), null);

  146. //        }

  147. //        break;

  148. //      case DTM.CDATA_SECTION_NODE :

  149. //        m_rth.startCDATA();          

  150. //        dtm.dispatchCharactersEvents(node, m_rth, false);

  151. //        m_rth.endCDATA();

  152. //        break;

  153. //      case DTM.ATTRIBUTE_NODE :

  154. //        m_rth.addAttribute(node);

  155. //        break;

  156. //      case DTM.COMMENT_NODE :

  157. //        XMLString xstr = dtm.getStringValue (node);

  158. //        xstr.dispatchAsComment(m_rth);

  159. //        break;

  160. //      case DTM.ENTITY_REFERENCE_NODE :

  161. //        m_rth.entityReference(dtm.getNodeNameX(node));

  162. //        break;

  163. //      case DTM.PROCESSING_INSTRUCTION_NODE :

  164. //        {

  165. //          // %REVIEW% Is the node name the same as the "target"?

  166. //          m_rth.processingInstruction(dtm.getNodeNameX(node), 

  167. //                                      dtm.getNodeValue(node));

  168. //        }

  169. //        break;

  170. //      default :

  171. //        //"Can not create item in result tree: "+node.getNodeName());

  172. //        m_transformer.getMsgMgr().error(null, 

  173. //                         XSLTErrorResources.ER_CANT_CREATE_ITEM,

  174. //                         new Object[]{ dtm.getNodeName(node) });  

  175. //      }

  176. //    }

  177. //    catch(org.xml.sax.SAXException se)

  178. //    {

  179. //      throw new TransformerException(se);

  180. //    }

  181. //  }  // end cloneToResultTree function

  182.   

  183.   /**

  184.    * Clone an element with or without children.

  185.    * TODO: Fix or figure out node clone failure!

  186.    * the error condition is severe enough to halt processing.

  187.    *

  188.    * @param node The node to clone

  189.    * @param shouldCloneAttributes Flag indicating whether to 

  190.    * clone children attributes

  191.    * 

  192.    * @throws TransformerException

  193.    */

  194.   public static void cloneToResultTree(int node, int nodeType, DTM dtm, 

  195.                                              ResultTreeHandler rth,

  196.                                              boolean shouldCloneAttributes)

  197.     throws TransformerException

  198.   {

  199. 

  200.     try

  201.     {

  202.       switch (nodeType)

  203.       {

  204.       case DTM.TEXT_NODE :

  205.         dtm.dispatchCharactersEvents(node, rth, false);

  206.         break;

  207.       case DTM.DOCUMENT_FRAGMENT_NODE :

  208.       case DTM.DOCUMENT_NODE :

  209.         // Can't clone a document, but refrain from throwing an error

  210.         // so that copy-of will work

  211.         break;

  212.       case DTM.ELEMENT_NODE :

  213.         {

  214.           // Note: SAX apparently expects "no namespace" to be

  215.           // represented as "" rather than null.

  216.           String ns = dtm.getNamespaceURI(node);

  217.           if (ns==null) ns="";

  218.           String localName = dtm.getLocalName(node);

  219.           rth.startElement(ns, localName, dtm.getNodeNameX(node), null);

  220.           

  221. 	  // If outputting attrs as separate events, they must

  222. 	  // _follow_ the startElement event. (Think of the

  223. 	  // xsl:attribute directive.)

  224.           if (shouldCloneAttributes)

  225.           {

  226.             rth.addAttributes(node);

  227.             rth.processNSDecls(node, nodeType, dtm);

  228.           }

  229.         }

  230.         break;

  231.       case DTM.CDATA_SECTION_NODE :

  232.         rth.startCDATA();          

  233.         dtm.dispatchCharactersEvents(node, rth, false);

  234.         rth.endCDATA();

  235.         break;

  236.       case DTM.ATTRIBUTE_NODE :

  237.         rth.addAttribute(node);

  238.         break;

  239. 			case DTM.NAMESPACE_NODE:

  240. 				// %REVIEW% Normally, these should have been handled with element.

  241. 				// It's possible that someone may write a stylesheet that tries to

  242. 				// clone them explicitly. If so, we need the equivalent of

  243. 				// rth.addAttribute().

  244.   			rth.processNSDecls(node,DTM.NAMESPACE_NODE,dtm);

  245. 				break;

  246.       case DTM.COMMENT_NODE :

  247.         XMLString xstr = dtm.getStringValue (node);

  248.         xstr.dispatchAsComment(rth);

  249.         break;

  250.       case DTM.ENTITY_REFERENCE_NODE :

  251.         rth.entityReference(dtm.getNodeNameX(node));

  252.         break;

  253.       case DTM.PROCESSING_INSTRUCTION_NODE :

  254.         {

  255.           // %REVIEW% Is the node name the same as the "target"?

  256.           rth.processingInstruction(dtm.getNodeNameX(node), 

  257.                                       dtm.getNodeValue(node));

  258.         }

  259.         break;

  260.       default :

  261.         //"Can not create item in result tree: "+node.getNodeName());

  262.         throw new  TransformerException(

  263.                          "Can't clone node: "+dtm.getNodeName(node));

  264.       }

  265.     }

  266.     catch(org.xml.sax.SAXException se)

  267.     {

  268.       throw new TransformerException(se);

  269.     }

  270.   }  // end cloneToResultTree function

  271. }