001package org.hl7.fhir.dstu3.utils.formats;
002
003/*
004  Copyright (c) 2011+, HL7, Inc.
005  All rights reserved.
006  
007  Redistribution and use in source and binary forms, with or without modification, 
008  are permitted provided that the following conditions are met:
009    
010   * Redistributions of source code must retain the above copyright notice, this 
011     list of conditions and the following disclaimer.
012   * Redistributions in binary form must reproduce the above copyright notice, 
013     this list of conditions and the following disclaimer in the documentation 
014     and/or other materials provided with the distribution.
015   * Neither the name of HL7 nor the names of its contributors may be used to 
016     endorse or promote products derived from this software without specific 
017     prior written permission.
018  
019  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
020  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
021  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
022  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
023  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
024  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
025  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
026  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
027  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
028  POSSIBILITY OF SUCH DAMAGE.
029  
030 */
031
032
033
034import java.util.Stack;
035
036import org.w3c.dom.Document;
037import org.w3c.dom.Element;
038import org.w3c.dom.Node;
039import org.w3c.dom.UserDataHandler;
040import org.w3c.dom.events.Event;
041import org.w3c.dom.events.EventListener;
042import org.w3c.dom.events.EventTarget;
043import org.w3c.dom.events.MutationEvent;
044import org.xml.sax.Attributes;
045import org.xml.sax.Locator;
046import org.xml.sax.SAXException;
047import org.xml.sax.XMLReader;
048import org.xml.sax.helpers.LocatorImpl;
049import org.xml.sax.helpers.XMLFilterImpl;
050
051// http://javacoalface.blogspot.com.au/2011/04/line-and-column-numbers-in-xml-dom.html
052
053@Deprecated
054public class XmlLocationAnnotator extends XMLFilterImpl  {
055
056  private Locator locator;
057  private Stack<Locator> locatorStack = new Stack<Locator>();
058  private Stack<Element> elementStack = new Stack<Element>();
059  private UserDataHandler dataHandler = new LocationDataHandler();
060
061  public XmlLocationAnnotator(XMLReader xmlReader, Document dom) {
062      super(xmlReader);
063
064      // Add listener to DOM, so we know which node was added.
065      EventListener modListener = new EventListener() {
066          @Override
067          public void handleEvent(Event e) {
068              EventTarget target = ((MutationEvent) e).getTarget();
069              elementStack.push((Element) target);
070          }
071      };
072      ((EventTarget) dom).addEventListener("DOMNodeInserted", modListener, true);
073  }
074
075  @Override
076  public void setDocumentLocator(Locator locator) {
077      super.setDocumentLocator(locator);
078      this.locator = locator;
079  }
080
081  @Override
082  public void startElement(String uri, String localName,
083          String qName, Attributes atts) throws SAXException {
084      super.startElement(uri, localName, qName, atts);
085
086      // Keep snapshot of start location,
087      // for later when end of element is found.
088      locatorStack.push(new LocatorImpl(locator));
089  }
090
091  @Override
092  public void endElement(String uri, String localName, String qName)
093          throws SAXException {
094
095      // Mutation event fired by the adding of element end,
096      // and so lastAddedElement will be set.
097      super.endElement(uri, localName, qName);
098     
099      if (locatorStack.size() > 0) {
100          Locator startLocator = locatorStack.pop();
101         
102          XmlLocationData location = new XmlLocationData(
103                  startLocator.getSystemId(),
104                  startLocator.getLineNumber(),
105                  startLocator.getColumnNumber(),
106                  locator.getLineNumber(),
107                  locator.getColumnNumber());
108         Element lastAddedElement = elementStack.pop();
109         
110          lastAddedElement.setUserData(
111                  XmlLocationData.LOCATION_DATA_KEY, location,
112                  dataHandler);
113      }
114  }
115
116  // Ensure location data copied to any new DOM node.
117  private class LocationDataHandler implements UserDataHandler {
118
119      @Override
120      public void handle(short operation, String key, Object data,
121              Node src, Node dst) {
122         
123          if (src != null && dst != null) {
124              XmlLocationData locatonData = (XmlLocationData)
125                      src.getUserData(XmlLocationData.LOCATION_DATA_KEY);
126             
127              if (locatonData != null) {
128                  dst.setUserData(XmlLocationData.LOCATION_DATA_KEY,
129                          locatonData, dataHandler);
130              }
131          }
132      }
133  }
134}