1 /*
   2  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.tools.internal.xjc.reader.internalizer;
  27 
  28 import java.util.Set;
  29 
  30 import com.sun.tools.internal.xjc.reader.Const;
  31 import com.sun.xml.internal.bind.marshaller.SAX2DOMEx;
  32 
  33 import org.w3c.dom.Document;
  34 import org.w3c.dom.Element;
  35 import org.w3c.dom.Node;
  36 import org.xml.sax.Attributes;
  37 import org.xml.sax.Locator;
  38 
  39 /**
  40  * Builds DOM while keeping the location information.
  41  *
  42  * <p>
  43  * This class also looks for outer most &lt;jaxb:bindings>
  44  * customizations.
  45  *
  46  * @author
  47  *     Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
  48  */
  49 class DOMBuilder extends SAX2DOMEx {
  50     /**
  51      * Grows a DOM tree under the given document, and
  52      * stores location information to the given table.
  53      *
  54      * @param outerMostBindings
  55      *      This set will receive newly found outermost
  56      *      jaxb:bindings customizations.
  57      */
  58     public DOMBuilder( Document dom, LocatorTable ltable, Set outerMostBindings ) {
  59         super( dom );
  60         this.locatorTable = ltable;
  61         this.outerMostBindings = outerMostBindings;
  62     }
  63 
  64     /** Location information will be stored into this object. */
  65     private final LocatorTable locatorTable;
  66 
  67     private final Set outerMostBindings;
  68 
  69     private Locator locator;
  70 
  71     public void setDocumentLocator(Locator locator) {
  72         this.locator = locator;
  73         super.setDocumentLocator(locator);
  74     }
  75 
  76 
  77     public void startElement(String namespaceURI, String localName, String qName, Attributes atts) {
  78         super.startElement(namespaceURI, localName, qName, atts);
  79 
  80         Element e = getCurrentElement();
  81         locatorTable.storeStartLocation( e, locator );
  82 
  83         // check if this element is an outer-most <jaxb:bindings>
  84         if( Const.JAXB_NSURI.equals(e.getNamespaceURI())
  85         &&  "bindings".equals(e.getLocalName()) ) {
  86 
  87             // if this is the root node (meaning that this file is an
  88             // external binding file) or if the parent is XML Schema element
  89             // (meaning that this is an "inlined" external binding)
  90             Node p = e.getParentNode();
  91             if( p instanceof Document
  92             ||( p instanceof Element && !e.getNamespaceURI().equals(p.getNamespaceURI()))) {
  93                 outerMostBindings.add(e);   // remember this value
  94             }
  95         }
  96     }
  97 
  98     public void endElement(String namespaceURI, String localName, String qName) {
  99         locatorTable.storeEndLocation( getCurrentElement(), locator );
 100         super.endElement(namespaceURI, localName, qName);
 101     }
 102 }