View Javadoc
1   /*
2    * Redistribution and use of this software and associated documentation ("Software"), with or
3    * without modification, are permitted provided that the following conditions are met:
4    *
5    * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
6    * must also contain a copy of this document.
7    *
8    * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
9    * conditions and the following disclaimer in the documentation and/or other materials provided with
10   * the distribution.
11   *
12   * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
13   * without prior written permission of Intalio, Inc. For written permission, please contact
14   * info@exolab.org.
15   *
16   * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
17   * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
18   * Intalio, Inc.
19   *
20   * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
21   *
22   * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
23   * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
24   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
25   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
29   * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30   *
31   * Copyright 1999, 2000 (C) Intalio, Inc. All Rights Reserved.
32   *
33   * $Id$
34   */
35  package org.exolab.castor.xml.util;
36  
37  import org.w3c.dom.Document;
38  import org.w3c.dom.Element;
39  import org.w3c.dom.Node;
40  import org.w3c.dom.ProcessingInstruction;
41  import org.w3c.dom.Text;
42  import org.xml.sax.AttributeList;
43  import org.xml.sax.HandlerBase;
44  import org.xml.sax.SAXException;
45  
46  import java.util.Stack;
47  
48  /**
49   * A class for converting a SAX events to DOM nodes.
50   *
51   * @author <a href="mailto:andrew.fawcett@coda.com">Andrew Fawcett</a>
52   */
53  public class SAX2DOMHandler extends HandlerBase {
54  
55    private final Node _node;
56  
57    private final Stack<Element> _parents = new Stack<Element>();
58  
59    /**
60     * Creates new instance of {@link SAX2DOMHandler} class.
61     *
62     * @param node the DOM node to use
63     */
64    public SAX2DOMHandler(Node node) {
65      _node = node;
66    }
67  
68    @Override
69    public void startElement(final String name, final AttributeList attributes) {
70      Node parent = !_parents.isEmpty() ? _parents.peek() : _node;
71      final Document document = getDocument(parent);
72  
73      Element element = document.createElement(name);
74      int length = attributes.getLength();
75      for (int i = 0; i < length; i++) {
76        element.setAttribute(attributes.getName(i), attributes.getValue(i));
77      }
78      parent.appendChild(element);
79      _parents.push(element);
80    }
81  
82    @Override
83    public void characters(final char[] chars, final int offset, final int length) {
84      String data = new String(chars, offset, length);
85      Node parent = !_parents.isEmpty() ? _parents.peek() : _node;
86      Node last = parent.getLastChild();
87      if ((last != null) && (last.getNodeType() == Node.TEXT_NODE)) {
88        ((Text) last).appendData(data);
89      } else {
90        Text text = parent.getOwnerDocument().createTextNode(data);
91        parent.appendChild(text);
92      }
93    }
94  
95    @Override
96    public void endElement(final String name) {
97      _parents.pop();
98    }
99  
100   @Override
101   public void processingInstruction(String target, String data) throws SAXException {
102     // adds the given processing instruction to the document root
103     Document document = getDocument(_node);
104     ProcessingInstruction instruction = document.createProcessingInstruction(target, data);
105     document.insertBefore(instruction, document.getFirstChild());
106   }
107 
108   /**
109    * Returns the owning {@link Document} for the given {@link Node}.
110    * 
111    * @param node A given node.
112    * @return the owning {@link Document} for the give node.
113    */
114   private Document getDocument(Node node) {
115     Document document;
116     if (node instanceof Document) {
117       document = (Document) node;
118     } else {
119       document = node.getOwnerDocument();
120     }
121     return document;
122   }
123 }